upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/docs/reference/configuration.md
diff options
context:
space:
mode:
authorDanConwayDev <DanConwayDev@protonmail.com>2026-01-12 22:51:43 +0000
committerDanConwayDev <DanConwayDev@protonmail.com>2026-01-12 22:51:43 +0000
commit51751d59f30a0c0f396afd1873ece9f4f77b44de (patch)
treecfec6555427f1be38997e00f313549c41dfaa609 /docs/reference/configuration.md
parentab3337d0a3bf25c282f4d48e5d6150cf291f41e5 (diff)
Change default port from 8080 to 7334 (NGIT on phone keypad)
- Update default bind address in src/config.rs to 127.0.0.1:7334 - Update all four critical config sources per AGENTS.md: - src/config.rs (code default and tests) - .env.example (development template) - docs/reference/configuration.md (user documentation) - nix/module.nix (NixOS deployment) - Update all documentation examples and references: - README.md (with note about phone keypad mnemonic) - docs/how-to/*.md (deploy, prometheus-setup, test-compliance) - docs/explanation/*.md (architecture, comparison) - docs/learnings/grasp-audit.md Port 7334 spells NGIT on a phone keypad, making it memorable and project-specific. All tests pass (336 lib tests + 51 integration tests).
Diffstat (limited to 'docs/reference/configuration.md')
-rw-r--r--docs/reference/configuration.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
index 66f39f1..8b49297 100644
--- a/docs/reference/configuration.md
+++ b/docs/reference/configuration.md
@@ -25,20 +25,20 @@ Configuration is loaded at startup and validated before the server starts.
25 25
26**Description:** Address and port for the HTTP server to bind to 26**Description:** Address and port for the HTTP server to bind to
27**Type:** String (IP:PORT format) 27**Type:** String (IP:PORT format)
28**Default:** `127.0.0.1:8080` 28**Default:** `127.0.0.1:7334`
29**Required:** No 29**Required:** No
30 30
31**Examples:** 31**Examples:**
32 32
33```bash 33```bash
34# Localhost only (development) 34# Localhost only (development)
35NGIT_BIND_ADDRESS=127.0.0.1:8080 35NGIT_BIND_ADDRESS=127.0.0.1:7334
36 36
37# All interfaces (production) 37# All interfaces (production)
38NGIT_BIND_ADDRESS=0.0.0.0:8080 38NGIT_BIND_ADDRESS=0.0.0.0:7334
39 39
40# IPv6 40# IPv6
41NGIT_BIND_ADDRESS=[::1]:8080 41NGIT_BIND_ADDRESS=[::1]:7334
42 42
43# Custom port 43# Custom port
44NGIT_BIND_ADDRESS=127.0.0.1:3000 44NGIT_BIND_ADDRESS=127.0.0.1:3000
@@ -64,7 +64,7 @@ NGIT_BIND_ADDRESS=127.0.0.1:3000
64```bash 64```bash
65NGIT_DOMAIN=gitnostr.com 65NGIT_DOMAIN=gitnostr.com
66NGIT_DOMAIN=git.example.org 66NGIT_DOMAIN=git.example.org
67NGIT_DOMAIN=localhost:8080 # Development only 67NGIT_DOMAIN=localhost:7334 # Development only
68``` 68```
69 69
70**Used for:** 70**Used for:**
@@ -77,7 +77,7 @@ NGIT_DOMAIN=localhost:8080 # Development only
77**Notes:** 77**Notes:**
78 78
79- Must be accessible from the internet for production 79- Must be accessible from the internet for production
80- Include port if non-standard (e.g., `localhost:8080`) 80- Include port if non-standard (e.g., `localhost:7334`)
81- Used in repository clone URLs: `https://{NGIT_DOMAIN}/{npub}/{repo}.git` 81- Used in repository clone URLs: `https://{NGIT_DOMAIN}/{npub}/{repo}.git`
82 82
83--- 83---
@@ -1007,13 +1007,13 @@ For development, create a `.env` file in the project root:
1007 1007
1008```bash 1008```bash
1009# .env file example 1009# .env file example
1010NGIT_DOMAIN=localhost:8080 1010NGIT_DOMAIN=localhost:7334
1011NGIT_OWNER_NPUB=npub1alice... 1011NGIT_OWNER_NPUB=npub1alice...
1012NGIT_RELAY_NAME="Development Relay" 1012NGIT_RELAY_NAME="Development Relay"
1013NGIT_RELAY_DESCRIPTION="Local development instance" 1013NGIT_RELAY_DESCRIPTION="Local development instance"
1014NGIT_GIT_DATA_PATH=./data/git 1014NGIT_GIT_DATA_PATH=./data/git
1015NGIT_RELAY_DATA_PATH=./data/relay 1015NGIT_RELAY_DATA_PATH=./data/relay
1016NGIT_BIND_ADDRESS=127.0.0.1:8080 1016NGIT_BIND_ADDRESS=127.0.0.1:7334
1017RUST_LOG=debug 1017RUST_LOG=debug
1018``` 1018```
1019 1019
@@ -1057,7 +1057,7 @@ NGIT_RELAY_NAME="GitNostr Public Relay"
1057NGIT_RELAY_DESCRIPTION="Public GRASP relay for open source projects" 1057NGIT_RELAY_DESCRIPTION="Public GRASP relay for open source projects"
1058NGIT_GIT_DATA_PATH=/var/lib/ngit-grasp/git 1058NGIT_GIT_DATA_PATH=/var/lib/ngit-grasp/git
1059NGIT_RELAY_DATA_PATH=/var/lib/ngit-grasp/relay 1059NGIT_RELAY_DATA_PATH=/var/lib/ngit-grasp/relay
1060NGIT_BIND_ADDRESS=0.0.0.0:8080 1060NGIT_BIND_ADDRESS=0.0.0.0:7334
1061RUST_LOG=info,ngit_grasp=debug 1061RUST_LOG=info,ngit_grasp=debug
1062``` 1062```
1063 1063
@@ -1076,13 +1076,13 @@ RUST_LOG=info,ngit_grasp=debug
1076 1076
1077```bash 1077```bash
1078# Development .env 1078# Development .env
1079NGIT_DOMAIN=localhost:8080 1079NGIT_DOMAIN=localhost:7334
1080NGIT_OWNER_NPUB=npub1test... 1080NGIT_OWNER_NPUB=npub1test...
1081NGIT_RELAY_NAME="Dev Relay" 1081NGIT_RELAY_NAME="Dev Relay"
1082NGIT_RELAY_DESCRIPTION="Local development" 1082NGIT_RELAY_DESCRIPTION="Local development"
1083NGIT_GIT_DATA_PATH=./data/git 1083NGIT_GIT_DATA_PATH=./data/git
1084NGIT_RELAY_DATA_PATH=./data/relay 1084NGIT_RELAY_DATA_PATH=./data/relay
1085NGIT_BIND_ADDRESS=127.0.0.1:8080 1085NGIT_BIND_ADDRESS=127.0.0.1:7334
1086RUST_LOG=debug 1086RUST_LOG=debug
1087``` 1087```
1088 1088
@@ -1124,7 +1124,7 @@ When multiple configuration sources exist:
1124 1124
1125```bash 1125```bash
1126# .env file 1126# .env file
1127NGIT_BIND_ADDRESS=127.0.0.1:8080 1127NGIT_BIND_ADDRESS=127.0.0.1:7334
1128 1128
1129# Environment variable (overrides .env) 1129# Environment variable (overrides .env)
1130NGIT_BIND_ADDRESS=0.0.0.0:3000 cargo run 1130NGIT_BIND_ADDRESS=0.0.0.0:3000 cargo run