Git-Mirrors/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2026-01-08 20:11:04 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Updated docs

Browse source
This commit is contained in:
Mark Qvist 2026-01-04 01:12:48 +01:00
parent 7d305527e9
commit 4af35bd7ea
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/interfaces.rst
View file

@ -966,7 +966,7 @@ When ``discoverable`` is enabled, a variety of additional options become availab
**Dynamic Resolution:** This option also accepts a path to an external executable script or binary. If a path is provided, Reticulum will execute the script and use its ``stdout`` as the reachability address. This is useful for devices behind dynamic DNS, NATs, or complex cloud environments where the external IP is not known locally. The script must simply print the address to stdout and exit.
.. note:: **Script Execution Requirements:**
.. note::
When using an executable script for ``reachable_on``, Reticulum expects the script to output only the IP address or hostname to ``stdout``, followed by a newline character. Any additional output or errors may cause the resolution to fail. Ensure the script has executable permissions and is robust against temporary network failures.
A minimal example of a script that resolves the externally available, public IP of an internet-connected system could look like this: