upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBitflash <admin@bitflash.network>2026-08-12 10:22:23 -0300
committerBitflash <admin@bitflash.network>2026-08-12 10:22:23 -0300
commitd0ebe648f333def99fababd65f6b929448616d56 (patch)
treec7ccaa28b9f83abd077ba90c031632deda83c80a /README.md
parentc330b8e5e1c057049b5b361908c94f41344dff80 (diff)
parenta0a300c240c91fa0c1cd1dc60ff5420a89cc33f8 (diff)
Merge pull request 'net: add Tor mode for outbound discovery' (#28) from tor-mode into main
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index c2fd6b8..978aba5 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,8 @@ Worth being precise, because the difference matters if you are relying on it.
36 36
37**The node still listens on 8433.** Nothing dials by IP any more, but the listener is still there, so anyone who already knows your address and can reach that port may connect directly. If that matters to you, firewall it. 37**The node still listens on 8433.** Nothing dials by IP any more, but the listener is still there, so anyone who already knows your address and can reach that port may connect directly. If that matters to you, firewall it.
38 38
39This is unlinkability between peers, not anonymity against a network observer. It is not Tor. 39This is unlinkability between peers, not anonymity against a network observer.
40For Tor routing, start the node with `-tor`; see [Tor mode](docs/tor.md).
40 41
41--- 42---
42 43
@@ -319,6 +320,7 @@ Other options worth knowing:
319-datadir=PATH # wallet and chain data elsewhere 320-datadir=PATH # wallet and chain data elsewhere
320-port=N # P2P listen port, default 8433 321-port=N # P2P listen port, default 8433
321-socks=HOST:PORT # SOCKS5 for outbound Nostr and .btf rendezvous dials 322-socks=HOST:PORT # SOCKS5 for outbound Nostr and .btf rendezvous dials
323-tor[=HOST:PORT] # Tor mode; default local Tor SOCKS5 proxy is 127.0.0.1:9050
322-debug # verbose log; without it debug.log is nearly silent 324-debug # verbose log; without it debug.log is nearly silent
323-help # full list 325-help # full list
324``` 326```
@@ -332,6 +334,11 @@ dials through a local SOCKS5 proxy such as Tor. When it is set, the node skips
332plain HTTP external-IP probes instead of leaking a direct request outside the 334plain HTTP external-IP probes instead of leaking a direct request outside the
333proxy. IPv6 proxy endpoints use brackets, for example `-socks=[::1]:9050`. 335proxy. IPv6 proxy endpoints use brackets, for example `-socks=[::1]:9050`.
334 336
337`-tor` is a privacy shorthand for the usual local Tor SOCKS5 listener at
338`127.0.0.1:9050`. It routes outbound Nostr discovery and `.btf` rendezvous
339dials through Tor, refuses direct `.onion` resolution, and keeps external-IP
340probes disabled. Use `-tor=HOST:PORT` when Tor listens somewhere else.
341
335### When something looks wrong 342### When something looks wrong
336 343
337**Menu > Diagnostics**, and the same report in `debug.log` every ten minutes: 344**Menu > Diagnostics**, and the same report in `debug.log` every ten minutes: