upleb.uk

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

summaryrefslogtreecommitdiff
path: root/docs/how-to
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/how-to
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/how-to')
-rw-r--r--docs/how-to/deploy.md2
-rw-r--r--docs/how-to/prometheus-setup.md6
-rw-r--r--docs/how-to/test-compliance.md4
3 files changed, 6 insertions, 6 deletions
diff --git a/docs/how-to/deploy.md b/docs/how-to/deploy.md
index 6fe8776..157e5f8 100644
--- a/docs/how-to/deploy.md
+++ b/docs/how-to/deploy.md
@@ -229,7 +229,7 @@ git ls-remote https://ngit.example.com/<npub>/<repo>.git
229 229
230### Network 230### Network
231- `bindAddress` - IP to bind to (default: "127.0.0.1") 231- `bindAddress` - IP to bind to (default: "127.0.0.1")
232- `port` - Port to listen on (default: 8080) 232- `port` - Port to listen on (default: 7334)
233 233
234### Storage 234### Storage
235- `dataDir` - Base directory for data (default: /var/lib/ngit-grasp-{name}) 235- `dataDir` - Base directory for data (default: /var/lib/ngit-grasp-{name})
diff --git a/docs/how-to/prometheus-setup.md b/docs/how-to/prometheus-setup.md
index 741255b..53ec480 100644
--- a/docs/how-to/prometheus-setup.md
+++ b/docs/how-to/prometheus-setup.md
@@ -13,7 +13,7 @@ This guide shows how to configure Prometheus and Grafana to monitor ngit-grasp.
13First, verify that ngit-grasp is exposing metrics: 13First, verify that ngit-grasp is exposing metrics:
14 14
15```bash 15```bash
16curl http://localhost:8080/metrics 16curl http://localhost:7334/metrics
17``` 17```
18 18
19You should see Prometheus-formatted metrics like: 19You should see Prometheus-formatted metrics like:
@@ -41,7 +41,7 @@ services.prometheus = {
41 { 41 {
42 job_name = "ngit-grasp"; 42 job_name = "ngit-grasp";
43 static_configs = [{ 43 static_configs = [{
44 targets = [ "localhost:8080" ]; # ngit-grasp bind address 44 targets = [ "localhost:7334" ]; # ngit-grasp bind address
45 }]; 45 }];
46 scrape_interval = "15s"; 46 scrape_interval = "15s";
47 metrics_path = "/metrics"; 47 metrics_path = "/metrics";
@@ -105,7 +105,7 @@ global:
105scrape_configs: 105scrape_configs:
106 - job_name: 'ngit-grasp' 106 - job_name: 'ngit-grasp'
107 static_configs: 107 static_configs:
108 - targets: ['host.docker.internal:8080'] # or your ngit-grasp host 108 - targets: ['host.docker.internal:7334'] # or your ngit-grasp host
109 metrics_path: /metrics 109 metrics_path: /metrics
110``` 110```
111 111
diff --git a/docs/how-to/test-compliance.md b/docs/how-to/test-compliance.md
index 370fb9a..8aa7ab1 100644
--- a/docs/how-to/test-compliance.md
+++ b/docs/how-to/test-compliance.md
@@ -184,7 +184,7 @@ nix develop -c cargo run
184 184
185# In another terminal, run audit tool 185# In another terminal, run audit tool
186cd grasp-audit 186cd grasp-audit
187nix develop -c cargo run -- --url ws://127.0.0.1:8080 187nix develop -c cargo run -- --url ws://127.0.0.1:7334
188``` 188```
189 189
190### For CI/CD 190### For CI/CD
@@ -424,7 +424,7 @@ nix develop -c cargo test --test nip01_compliance --test nip34_announcements
424**For deep compliance check:** 424**For deep compliance check:**
425```bash 425```bash
426cd grasp-audit 426cd grasp-audit
427nix develop -c cargo run -- --url ws://127.0.0.1:8080 427nix develop -c cargo run -- --url ws://127.0.0.1:7334
428``` 428```
429 429
430**Key points:** 430**Key points:**