xenofem
/
transbeam
1
0
Fork 0
Code Issues 6 Pull Requests Projects Releases Wiki Activity

add info about cachebuster to readme

main
xenofem 2022-05-29 10:45:21 -04:00
parent 97f58bbbe3
commit 71242d37ce
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -45,6 +45,8 @@ transbeam is configured with the following environment variables:
recommend setting up fail2ban to throttle password attempts; recommend setting up fail2ban to throttle password attempts;
transbeam logs failed attempts along with IP addresses, in the form transbeam logs failed attempts along with IP addresses, in the form
`Incorrect authentication attempt from 203.0.113.12`. `Incorrect authentication attempt from 203.0.113.12`.
- `TRANSBEAM_CACHEBUSTER`: query string that will be appended to CSS
and JS files, to force re-fetching of cached files when needed.
- `RUST_LOG`: log levels, for the app as a whole and/or for specific - `RUST_LOG`: log levels, for the app as a whole and/or for specific
submodules/libraries. See submodules/libraries. See
[`env_logger`](https://docs.rs/env_logger/latest/env_logger/)'s [`env_logger`](https://docs.rs/env_logger/latest/env_logger/)'s
@ -58,9 +60,12 @@ transbeam is configured with the following environment variables:
nix run git+https://git.xeno.science/xenofem/transbeam?ref=main nix run git+https://git.xeno.science/xenofem/transbeam?ref=main
``` ```
(The Nix package is wrapped with `TRANSBEAM_STATIC_DIR` set automatically to the (The Nix package is wrapped with `TRANSBEAM_STATIC_DIR` set
correct Nix store path, so it'll serve the static files properly automatically to the correct Nix store path, so it'll serve the static
no matter what directory you run it from.) files properly no matter what directory you run it
from. `TRANSBEAM_CACHEBUSTER` is set automatically to a hash of the
static files' store path, so it will change whenever the static files
change.)
### non-nix ### non-nix