doc: usage of --announce-addr-discovered-port option

ElementsProject · Jan 25, 2023 · d0d7aa7 · d0d7aa7
1 parent 11b6067
commit d0d7aa7
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/doc/lightning-listconfigs.7.md b/doc/lightning-listconfigs.7.md
@@ -90,6 +90,7 @@ On success, an object is returned, containing:
 - **disable-dns** (boolean, optional): `true` if `disable-dns` was set in config or cmdline
 - **disable-ip-discovery** (boolean, optional): `true` if `disable-ip-discovery` was set in config or cmdline **deprecated, removal in v23.11**
 - **announce-addr-discovered** (string, optional): `true`/`false`/`auto` depending on how `announce-addr-discovered` was set in config or cmdline *(added v23.02)*
+- **announce-addr-discovered-port** (integer, optional): Sets the announced TCP port for dynamically discovered IPs. *(added v23.02)*
 - **encrypted-hsm** (boolean, optional): `true` if `encrypted-hsm` was set in config or cmdline
 - **rpc-file-mode** (string, optional): `rpc-file-mode` field from config or cmdline, or default
 - **log-level** (string, optional): `log-level` field from config or cmdline, or default
@@ -221,4 +222,4 @@ RESOURCES
 
 Main web site: <https://github.com/ElementsProject/lightning>
 
-[comment]: # ( SHA256STAMP:9953b3545acb82bed816b86a65ba51ff4b043d3848c4a3ae460aa68db1a4b542)
+[comment]: # ( SHA256STAMP:2f325aa6ef0506dc627409e3253c8627c49a7d1749ea9dbf24a5baa0fc8c307c)
diff --git a/doc/lightningd-config.5.md b/doc/lightningd-config.5.md
@@ -368,6 +368,11 @@ use the RPC call lightning-setchannel(7).
   Note: You also need to open TCP port 9735 on your router towords your node.
   Note: Will always be disabled if you use 'always-use-proxy'.
 
+* **announce-addr-discovered-port**
+  Sets the public TCP port to use for announcing dynamically discovered IPs.
+  If unset, this defaults to the selected networks lightning port,
+  which is 9735 on mainnet.
+
 ### Lightning channel and HTLC options
 
 * **large-channels**

diff --git a/doc/schemas/listconfigs.schema.json b/doc/schemas/listconfigs.schema.json
@@ -253,6 +253,11 @@
       "description": "`true`/`false`/`auto` depending on how `announce-addr-discovered` was set in config or cmdline",
       "added": "v23.02"
     },
+    "announce-addr-discovered-port": {
+      "type": "integer",
+      "description": "Sets the announced TCP port for dynamically discovered IPs.",
+      "added": "v23.02"
+    },
     "encrypted-hsm": {
       "type": "boolean",
       "description": "`true` if `encrypted-hsm` was set in config or cmdline"