namespace all our variables

This commit is contained in:
xenofem 2022-04-30 01:53:21 -04:00
parent 14508183ab
commit 458f791fe3
4 changed files with 17 additions and 12 deletions

View file

@ -21,9 +21,14 @@
## configuration
transbeam is configured with the following environment variables:
- `STORAGE_DIR`: path where uploaded files should be stored (default: `./storage`)
- `STATIC_DIR`: path where the web app's static files live (default: `./static`)
- `PORT`: port to listen on localhost for http requests (default: 8080)
- `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, in bytes, of a fileset
being uploaded (default: 16GiB)
- `TRANSBEAM_MAX_STORAGE_SIZE`: maximum total size, in bytes, of all
files being stored by transbeam (default: 64GiB)
- `RUST_LOG`: log levels, for the app as a whole and/or for specific
submodules/libraries. See
[`env_logger`](https://docs.rs/env_logger/latest/env_logger/)'s
@ -37,7 +42,7 @@ transbeam is configured with the following environment variables:
nix run git+https://git.xeno.science/xenofem/transbeam?ref=main
```
(The Nix package is wrapped with `STATIC_DIR` set automatically to the
(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.)