diff --git a/.env.example b/.env.example index b9bfcada0e..46b5496649 100644 --- a/.env.example +++ b/.env.example @@ -54,10 +54,17 @@ RELAY_URL=ws://localhost:3000 # Stable relay signing key. Set this in dev if you want REST-created forum posts # to keep resolving to the original author across relay restarts. # BUZZ_RELAY_PRIVATE_KEY=<32-byte hex private key> -# Optional: path to the web UI dist directory. When set, the relay serves -# the web frontend at / for browser requests. Leave unset for local dev -# (use `just web` for Vite HMR instead). +# Optional: path to the web UI dist directory. When set, the relay serves the +# invite landing bundle, so /invite/{code} works for browser requests. Leave +# unset for local dev (use `just web` for Vite HMR instead). # BUZZ_WEB_DIR=./web/dist +# Serving the bundle at / and /repos/... additionally requires +# BUZZ_SERVE_GIT_WEB_GUI; without it those paths answer with the NIP-11 +# document instead of the SPA. +# Set to `true` or `1` to expose the bundled Git repository browser. Has no +# effect unless BUZZ_WEB_DIR is set. Defaults to false; invite routes do not +# depend on this flag. +# BUZZ_SERVE_GIT_WEB_GUI=true # Shared Redis-backed admission limits. Defaults shown below; each value must # be a positive integer.