Merge pull request 'net: add optional SOCKS5 outbound proxy' (#27) from socks5-proxy into main

1 files changed, 6 insertions, 0 deletions

diff --git a/README.md b/README.md
index 9c6db0e..c2fd6b8 100644
--- a/README.md
+++ b/README.md
@@ -318,6 +318,7 @@ Other options worth knowing:
 ```bash
 -datadir=PATH    # wallet and chain data elsewhere
 -port=N          # P2P listen port, default 8433
+-socks=HOST:PORT # SOCKS5 for outbound Nostr and .btf rendezvous dials
 -debug           # verbose log; without it debug.log is nearly silent
 -help            # full list
 ```
@@ -326,6 +327,11 @@ Other options worth knowing:
 needed — the data directory takes an exclusive lock, so a second node pointed at
 the same one will refuse to start.
 
+`-socks=127.0.0.1:9050` routes outbound Nostr discovery and `.btf` rendezvous
+dials through a local SOCKS5 proxy such as Tor. When it is set, the node skips
+plain HTTP external-IP probes instead of leaking a direct request outside the
+proxy. IPv6 proxy endpoints use brackets, for example `-socks=[::1]:9050`.
+
 ### When something looks wrong
 
 **Menu > Diagnostics**, and the same report in `debug.log` every ten minutes: