From 71242d37cebd56c77b907104550ee9ea44731ade Mon Sep 17 00:00:00 2001 From: xenofem Date: Sun, 29 May 2022 10:45:21 -0400 Subject: [PATCH] add info about cachebuster to readme --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7be6a73..b036c7c 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,8 @@ transbeam is configured with the following environment variables: 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`. +- `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 submodules/libraries. See [`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 ``` -(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.) +(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. `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