Skip to content

docs(env): note that / and /repos need BUZZ_SERVE_GIT_WEB_GUI #3857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TheSeydiCharyyev wants to merge 2 commits into
base: main
Choose a base branch
from
+10 −3
Open

docs(env): note that / and /repos need BUZZ_SERVE_GIT_WEB_GUI #3857

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9b3ef9
docs(env): note that / and /repos need BUZZ_SERVE_GIT_WEB_GUI
TheSeydiCharyyev Jul 31, 2026
5957f29
docs(env): name the flag instead of pointing at "the flag below"
TheSeydiCharyyev Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down