upleb.uk

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

summaryrefslogtreecommitdiff
path: root/docs/tor.md
diff options
context:
space:
mode:
authorNsable-sh <nsable-sh@noreply.git.bitflash.network>2026-08-12 11:58:03 -0300
committerNsable-sh <nsable-sh@noreply.git.bitflash.network>2026-08-12 11:58:03 -0300
commitb0ed2ce585d2a6fd7c6d8d4db7422734aedccb58 (patch)
tree509f8424e4fed7eb00a1fa3294a26da70eb5e7ef /docs/tor.md
parentbc3de301d9ed0e5fb5e2034be2e066d77cf23804 (diff)
site: document public deployment contract
Diffstat (limited to 'docs/tor.md')
-rw-r--r--docs/tor.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/tor.md b/docs/tor.md
index 087c822..69b29f1 100644
--- a/docs/tor.md
+++ b/docs/tor.md
@@ -25,6 +25,17 @@ bitflash -tor=127.0.0.1:9150
25bitflash -tor=[::1]:9050 25bitflash -tor=[::1]:9050
26``` 26```
27 27
28For a SOCKS5 proxy that is not Tor, use `-socks` directly:
29
30```bash
31bitflash -socks=127.0.0.1:9050
32bitflash -socks=[::1]:9050
33```
34
35If both `-tor` and `-socks` are present, Tor mode wins and the node prints a
36warning. That keeps a command line with `-tor` from silently becoming a custom
37proxy route.
38
28When Tor mode is enabled: 39When Tor mode is enabled:
29 40
30- outbound Nostr relay dials use Tor; 41- outbound Nostr relay dials use Tor;
@@ -34,6 +45,24 @@ When Tor mode is enabled:
34- direct `.onion` dials are refused unless a SOCKS5/Tor proxy is enabled; 45- direct `.onion` dials are refused unless a SOCKS5/Tor proxy is enabled;
35- plain HTTP external-IP probes are skipped. 46- plain HTTP external-IP probes are skipped.
36 47
48Tor mode affects outbound discovery and relay dials. It does not encrypt
49`wallet.dat`, hide mining rewards on-chain, or change the `.btf` identity. A
50relay still sees the TCP client that connected to it; with Tor mode that client
51is the Tor exit or onion circuit endpoint instead of the user's direct IP.
52
53## What to test
54
55Use the public status page only as a rough health check. To prove the local node
56is using Tor/SOCKS, test from the node machine:
57
58```bash
59bitflash -tor -debug
60```
61
62Then confirm in `debug.log` that Nostr and rendezvous dials report the proxy
63path. A DNS leak test should show no local resolver lookup for relay hostnames:
64the SOCKS5 request uses the domain-name form and asks the proxy to resolve it.
65
37## Onion rendezvous relay 66## Onion rendezvous relay
38 67
39An operator can expose a Bitflash rendezvous relay as a Tor hidden service. The 68An operator can expose a Bitflash rendezvous relay as a Tor hidden service. The