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-09 21:51:52 +0000
committerDanConwayDev <DanConwayDev@protonmail.com>2026-01-09 21:51:52 +0000
commit5570b9631e03c077faa95fbf1f068a4360d25bd7 (patch)
treee1ece058586e84e2b98b1de1188b4ff3cb5acdd6 /docs/how-to
parent6a8346441ea605248e09858d0e6b9096a1c87259 (diff)
Fix production-sync-testing.md guide and sanitize-logs.sh script
- Fix shebang in sanitize-logs.sh from #!/bin/bash to #!/usr/bin/env bash for NixOS compatibility - Update sanitizer defaults from 100/20 to 200/100 chars for better log readability - Fix CLI argument names in guide: --sync-bootstrap-relay -> --sync-bootstrap-relay-url - Fix CLI argument names in guide: --git-path -> --git-data-path These issues were discovered during first-time testing of the production sync testing guide.
Diffstat (limited to 'docs/how-to')
-rw-r--r--docs/how-to/production-sync-testing.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/how-to/production-sync-testing.md b/docs/how-to/production-sync-testing.md
index dfff20d..a55e9ea 100644
--- a/docs/how-to/production-sync-testing.md
+++ b/docs/how-to/production-sync-testing.md
@@ -38,7 +38,7 @@ This domain has few repo announcements listing it, so sync stays manageable.
38The bootstrap relay provides the initial set of announcements to discover repos: 38The bootstrap relay provides the initial set of announcements to discover repos:
39 39
40```bash 40```bash
41--sync-bootstrap-relay wss://git.shakespeare.diy 41--sync-bootstrap-relay-url wss://git.shakespeare.diy
42``` 42```
43 43
44### 3. Run with Time Limit 44### 3. Run with Time Limit
@@ -51,9 +51,9 @@ rm -rf /tmp/ngit-test-*
51 51
52# Run for 30 seconds with sanitized output 52# Run for 30 seconds with sanitized output
53timeout 30s cargo run -- \ 53timeout 30s cargo run -- \
54 --sync-bootstrap-relay wss://git.shakespeare.diy \ 54 --sync-bootstrap-relay-url wss://git.shakespeare.diy \
55 --domain ngit.danconwaydev.com \ 55 --domain ngit.danconwaydev.com \
56 --git-path /tmp/ngit-test-git \ 56 --git-data-path /tmp/ngit-test-git \
57 --relay-data-path /tmp/ngit-test-relay \ 57 --relay-data-path /tmp/ngit-test-relay \
58 2>&1 | ./scripts/sanitize-logs.sh | tee sync-test.log 58 2>&1 | ./scripts/sanitize-logs.sh | tee sync-test.log
59``` 59```
@@ -72,8 +72,8 @@ cargo run -- [args] 2>&1 | ./scripts/sanitize-logs.sh
72``` 72```
73 73
74**Options:** 74**Options:**
75- `--head-chars N` - First N characters to show (default: 100) 75- `--head-chars N` - First N characters to show (default: 200)
76- `--tail-chars N` - Last N characters to show (default: 20) 76- `--tail-chars N` - Last N characters to show (default: 100)
77 77
78Example output: 78Example output:
79``` 79```
@@ -245,9 +245,9 @@ tracing::trace!("Per-event detail that's too noisy");
245 245
246```bash 246```bash
247timeout 30s cargo run -- \ 247timeout 30s cargo run -- \
248 --sync-bootstrap-relay wss://git.shakespeare.diy \ 248 --sync-bootstrap-relay-url wss://git.shakespeare.diy \
249 --domain ngit.danconwaydev.com \ 249 --domain ngit.danconwaydev.com \
250 --git-path /tmp/ngit-test-git \ 250 --git-data-path /tmp/ngit-test-git \
251 --relay-data-path /tmp/ngit-test-relay \ 251 --relay-data-path /tmp/ngit-test-relay \
252 2>&1 | ./scripts/sanitize-logs.sh 252 2>&1 | ./scripts/sanitize-logs.sh
253``` 253```
@@ -256,9 +256,9 @@ timeout 30s cargo run -- \
256 256
257```bash 257```bash
258timeout 30s cargo run -- \ 258timeout 30s cargo run -- \
259 --sync-bootstrap-relay wss://git.shakespeare.diy \ 259 --sync-bootstrap-relay-url wss://git.shakespeare.diy \
260 --domain ngit.danconwaydev.com \ 260 --domain ngit.danconwaydev.com \
261 --git-path /tmp/ngit-test-git \ 261 --git-data-path /tmp/ngit-test-git \
262 --relay-data-path /tmp/ngit-test-relay \ 262 --relay-data-path /tmp/ngit-test-relay \
263 --metrics-address 127.0.0.1:9090 \ 263 --metrics-address 127.0.0.1:9090 \
264 2>&1 | ./scripts/sanitize-logs.sh 264 2>&1 | ./scripts/sanitize-logs.sh