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-13 14:21:15 -0300
committerBitflash <admin@bitflash.network>2026-08-13 14:21:15 -0300
commit5dec9b16a5b98ed0e24ec7113b867f22be2d0026 (patch)
treee06544e9e7516203bc4309460438a0486b0328e4 /README.md
parentc009e7cc0c5093f4c4add741cb9d131d19956871 (diff)
parent1bf78c53404d83638177889590ce199c87af63bc (diff)
Merge pull request 'net: add managed Tor hidden service bootstrap' (#33) from embedded-tor-manager into main
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.md b/README.md
index 181b6e8..a7ce2b2 100644
--- a/README.md
+++ b/README.md
@@ -339,6 +339,7 @@ Other options worth knowing:
339-port=N # P2P listen port, default 8433 339-port=N # P2P listen port, default 8433
340-socks=HOST:PORT # SOCKS5 for outbound Nostr, .btf relay, and onion peer dials 340-socks=HOST:PORT # SOCKS5 for outbound Nostr, .btf relay, and onion peer dials
341-tor[=HOST:PORT] # Tor mode; default local Tor SOCKS5 proxy is 127.0.0.1:9050 341-tor[=HOST:PORT] # Tor mode; default local Tor SOCKS5 proxy is 127.0.0.1:9050
342-managedtor[=PATH] # start Tor, create a hidden service, advertise its onion
342-onionservice=HOST.onion:PORT # advertise this node's Tor hidden service 343-onionservice=HOST.onion:PORT # advertise this node's Tor hidden service
343-debug # verbose log; without it debug.log is nearly silent 344-debug # verbose log; without it debug.log is nearly silent
344-help # full list 345-help # full list
@@ -357,10 +358,14 @@ proxy. IPv6 proxy endpoints use brackets, for example `-socks=[::1]:9050`.
357`-tor` is a privacy shorthand for the usual local Tor SOCKS5 listener at 358`-tor` is a privacy shorthand for the usual local Tor SOCKS5 listener at
358`127.0.0.1:9050`. It routes outbound Nostr discovery, `.btf` rendezvous dials, 359`127.0.0.1:9050`. It routes outbound Nostr discovery, `.btf` rendezvous dials,
359and signed direct `.onion` peer dials through Tor, and keeps external-IP probes 360and signed direct `.onion` peer dials through Tor, and keeps external-IP probes
360disabled. Use `-tor=HOST:PORT` when Tor listens somewhere else. To make your own 361disabled. Use `-tor=HOST:PORT` when Tor listens somewhere else.
361node reachable without a rendezvous relay, expose port `8433` as a Tor hidden 362
362service and pass `-onionservice=HOST.onion:8433`; peers with `-tor` will try it 363`-managedtor[=PATH]` starts a Tor process for this node, writes a local `torrc`,
363before falling back to rendezvous. 364creates a v3 hidden service for port `8433`, routes outbound discovery through
365that Tor instance, and signs the generated `.onion:8433` endpoint into the
366node's `.btf` descriptor. Without `PATH`, Bitflash looks for `tor/tor.exe`,
367`tor.exe`, or `tor` beside the binary and then on `PATH`. The hidden-service key
368is stored under the Bitflash data directory in `managed-tor/onion-service/`.
364 369
365### When something looks wrong 370### When something looks wrong
366 371