logos-messaging/logos-messaging-nim
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-messaging-nim.git synced 2026-05-12 05:19:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixes from Ivan's review

Browse Source 
* Document actual env var names in config help messages
* Add port value resolution order to README.md
This commit is contained in:
Fabiana Cecin 2026-04-20 14:45:28 -03:00
parent 6a6c2093c8
commit d8932820fa
No known key found for this signature in database
GPG Key ID: BCAB8A55CB51B6C7
2 changed files with 21 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -160,8 +160,11 @@ and any supplied configuration for that port.
| `--metrics-server-port` | `LOGOS_DELIVERY_METRICS_PORT` |
| `--websocket-port` | `LOGOS_DELIVERY_WEBSOCKET_PORT` |
The override just replaces the configured port value, so any subsequent transform
such as `--ports-shift` still applies on top.
Effective port is determined in this order:
1. Config parameter (CLI flag or library API)
2. Environment variable
3. Any post-processing (e.g. `--ports-shift`)
## Formatting

22
tools/confutils/cli_args.nim
View File

@ -192,8 +192,11 @@ type WakuNodeConf* = object
name: "listen-address"
.}: IpAddress
tcpPort* {.desc: "TCP listening port.", defaultValue: 60000, name: "tcp-port".}:
Port
tcpPort* {.
desc: "TCP listening port. (env var override: " & EnvP2pTcpPort & ")",
defaultValue: 60000,
name: "tcp-port"
.}: Port
portsShift* {.
desc: "Add a shift to all port numbers.", defaultValue: 0, name: "ports-shift"
@ -489,7 +492,8 @@ with the drawback of consuming some more bandwidth.""",
.}: IpAddress
restPort* {.
desc: "Listening port of the REST HTTP server.",
desc:
"Listening port of the REST HTTP server. (env var override: " & EnvRestPort & ")",
defaultValue: 8645,
name: "rest-port"
.}: uint16
@ -530,7 +534,9 @@ with the drawback of consuming some more bandwidth.""",
.}: IpAddress
metricsServerPort* {.
desc: "Listening HTTP port of the metrics server.",
desc:
"Listening HTTP port of the metrics server. (env var override: " & EnvMetricsPort &
")",
defaultValue: 8008,
name: "metrics-server-port"
.}: uint16
@ -564,7 +570,9 @@ with the drawback of consuming some more bandwidth.""",
.}: Option[bool]
discv5UdpPort* {.
desc: "Listening UDP port for Node Discovery v5.",
desc:
"Listening UDP port for Node Discovery v5. (env var override: " &
EnvDiscv5UdpPort & ")",
defaultValue: 9000,
name: "discv5-udp-port"
.}: Port
@ -664,7 +672,9 @@ with the drawback of consuming some more bandwidth.""",
.}: bool
websocketPort* {.
desc: "WebSocket listening port.", defaultValue: 8000, name: "websocket-port"
desc: "WebSocket listening port. (env var override: " & EnvWebSocketPort & ")",
defaultValue: 8000,
name: "websocket-port"
.}: Port
websocketSecureSupport* {.