Skip to content

Commit 59494e5

Browse files
emanzxclaude
andcommitted
docs(sync): document the configurable sync listener port
Reflect the new `ports.sync` config field / `NODEDB_PORT_SYNC` env override (default 9090, always on) introduced for the sync listener: list it alongside the other port settings in getting-started.md, and note in protocols.md that the sync protocol port is now configurable rather than fixed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0193ftf9LuUWejMqe2KVWkya
1 parent 427d6c2 commit 59494e5

2 files changed

Lines changed: 5 additions & 2 deletions

File tree

docs/getting-started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,7 @@ log_format = "text" # "text" or "json"
223223
native = 6433 # Always-on protocols have defaults
224224
pgwire = 6432
225225
http = 6480
226+
sync = 9090 # Always on
226227
resp = 6381 # Optional: set to enable, omit to disable
227228
ilp = 8086 # Optional: set to enable, omit to disable
228229
@@ -244,6 +245,7 @@ ilp = false # Example: disable TLS for ILP ingest
244245
| `ports.native` | `NODEDB_PORT_NATIVE` | `6433` |
245246
| `ports.pgwire` | `NODEDB_PORT_PGWIRE` | `6432` |
246247
| `ports.http` | `NODEDB_PORT_HTTP` | `6480` |
248+
| `ports.sync` | `NODEDB_PORT_SYNC` | `9090` |
247249
| `ports.resp` | `NODEDB_PORT_RESP` | disabled |
248250
| `ports.ilp` | `NODEDB_PORT_ILP` | disabled |
249251
| `data_dir` | `NODEDB_DATA_DIR` | `~/.nodedb/data` (binary), `/var/lib/nodedb` (Docker) |

docs/protocols.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ SELECT * FROM cpu WHERE ts > now() - INTERVAL '1 hour';
223223

224224
CRDT sync protocol for NodeDB-Lite clients (mobile, WASM, desktop). Bidirectional delta exchange over WebSocket.
225225

226-
**Port:** 9090 (default)
226+
**Port:** 9090 (default). Configurable via `[server.ports] sync` or `NODEDB_PORT_SYNC`.
227227

228228
**Flow:**
229229

@@ -256,6 +256,7 @@ host = "127.0.0.1"
256256
pgwire = 6432 # Always on
257257
native = 6433 # Always on
258258
http = 6480 # Always on
259+
sync = 9090 # Always on
259260
resp = 6381 # Set to enable (omit to disable)
260261
ilp = 8086 # Set to enable (omit to disable)
261262

@@ -269,7 +270,7 @@ resp = true
269270
ilp = false # Example: disable TLS for ILP ingest
270271
```
271272

272-
Environment variables override config: `NODEDB_PORT_PGWIRE`, `NODEDB_PORT_NATIVE`, `NODEDB_PORT_HTTP`, `NODEDB_PORT_RESP`, `NODEDB_PORT_ILP`.
273+
Environment variables override config: `NODEDB_PORT_PGWIRE`, `NODEDB_PORT_NATIVE`, `NODEDB_PORT_HTTP`, `NODEDB_PORT_SYNC`, `NODEDB_PORT_RESP`, `NODEDB_PORT_ILP`.
273274

274275
## Native Protocol Opcodes (SDK Reference)
275276

0 commit comments

Comments
 (0)