xenofem/transbeam
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Wiki Activity
Low-latency file drop web app
69 commits 1 branch 0 tags 1.2 MiB
Rust 61.1%
JavaScript 13.4%
CSS 8.1%
HTML 7.8%
Python 4.2%
Other 5.4%
Find a file
xenofem 3b974ed6a3 check upload limits beforehand
2022-05-03 19:21:42 -04:00
resources organize images better 2022-04-30 01:46:21 -04:00
src check upload limits beforehand 2022-05-03 19:21:42 -04:00
static check upload limits beforehand 2022-05-03 19:21:42 -04:00
.gitignore refactor config variables, add upload password 2022-05-03 16:28:43 -04:00
Cargo.lock refactor config variables, add upload password 2022-05-03 16:28:43 -04:00
Cargo.toml refactor config variables, add upload password 2022-05-03 16:28:43 -04:00
flake.lock nix flakes 2022-04-28 00:48:47 -04:00
flake.nix namespace all our variables 2022-04-30 01:53:21 -04:00
LICENSE MIT license 2022-04-28 00:49:21 -04:00
README.md update README 2022-05-03 16:31:39 -04:00

README.md

transbeam logo: a laser warning sign in trans flag colors

transbeam

A low-latency file drop web app

features

  • One-to-many transfer of large files
  • Simple web UI for sender and receivers
  • Word-based download codes that are easy to remember and communicate
  • Receivers can begin downloading immediately, without needing to wait for the upload to finish
  • Receivers can also download after the upload is complete and the sender has gone offline
  • Easy to send multiple files at once - they're bundled into a zip file for receivers, with zero compression so extraction is quick
  • Sanitises filenames, using sensible non-obnoxious defaults that should be safe across platforms
  • Rudimentary password authentication for uploading files
  • Fires a laser beam that turns you trans

configuration

transbeam is configured with the following environment variables:

  • TRANSBEAM_STORAGE_DIR: path where uploaded files should be stored (default: ./storage)
  • TRANSBEAM_STATIC_DIR: path where the web app's static files live (default: ./static)
  • TRANSBEAM_PORT: port to listen on localhost for http requests (default: 8080)
  • TRANSBEAM_MAX_LIFETIME: maximum number of days files can be kept for (default: 30)
  • TRANSBEAM_MAX_UPLOAD_SIZE: maximum size of a fileset being uploaded (default: 16G)
  • TRANSBEAM_MAX_STORAGE_SIZE: maximum total size, in bytes, of all files being stored by transbeam (default: 64G)
  • TRANSBEAM_MNEMONIC_CODES: generate memorable download codes using English words, rather than random alphanumeric strings (default: true)
  • TRANSBEAM_UPLOAD_PASSWORD: password for uploading files. This isn't meant to be a hardcore security measure, just a defense against casual internet randos filling up your storage. I strongly recommend setting up fail2ban to throttle password attempts; transbeam logs failed attempts along with IP addresses, in the form Incorrect authentication attempt from 203.0.113.12.
  • RUST_LOG: log levels, for the app as a whole and/or for specific submodules/libraries. See env_logger's documentation for details.

running

nix flakes

nix run git+https://git.xeno.science/xenofem/transbeam?ref=main

(The Nix package is wrapped with TRANSBEAM_STATIC_DIR set automatically to the correct Nix store path, so it'll serve the static files properly no matter what directory you run it from.)

non-nix

git clone https://git.xeno.science/xenofem/transbeam
cd transbeam
cargo run --release