summary refs log tree commit diff stats
path: root/pkgs/by-name/ba/back/README.md
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-12-24 10:58:51 +0100
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-12-24 10:59:45 +0100
commit3937d75c84ab538aceee0e42580b1c19325ccd74 (patch)
treee38a42dadac57ba7e6c51497aac1ae092372c03b /pkgs/by-name/ba/back/README.md
parentfeat(pkgs/back): Add a link to the source code (diff)
downloadnixos-server-3937d75c84ab538aceee0e42580b1c19325ccd74.tar.gz
nixos-server-3937d75c84ab538aceee0e42580b1c19325ccd74.zip
docs(pkgs/back): Document useful environment variables
Diffstat (limited to '')
-rw-r--r--pkgs/by-name/ba/back/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/pkgs/by-name/ba/back/README.md b/pkgs/by-name/ba/back/README.md
index aa9d37e..4bbd9c0 100644
--- a/pkgs/by-name/ba/back/README.md
+++ b/pkgs/by-name/ba/back/README.md
@@ -23,9 +23,22 @@ The server is than started at `http://127.0.0.1:8000` and provides access to the
 (bugs) tracked via `git-bug`.
 
 ### Note
+
 `back` needs write access to the repository, because of internal `gix` and `git` object
 reasons.
 
+## Relevant Environment Variables
+
+### `ROCKET_PORT`
+
+> Default: 8000
+
+This is the port the server binds to.
+
+### `SOURCE_CODE_REPOSITORY_URL`
+
+The URL to the back's source.
+
 ## Licensing
 
 This project complies with the REUSE v3.3 specification. This means that every file