upleb.uk

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

summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBitflash <admin@bitflash.network>2026-08-13 16:07:04 -0300
committerBitflash <admin@bitflash.network>2026-08-13 16:07:04 -0300
commitea08342aba66400f588c6a03685a6f39927cb062 (patch)
tree3d7fa8c459fb3b493b878f68b85cb53b7c16659e /docs
parent8e21e8ca0b8d50c29376bc2f0a89575baa477213 (diff)
parent5309170e567f4a8655b3b622e7b26b6d8b382942 (diff)
Merge pull request 'net: add onion-only btf dial mode' (#35) from managed-tor-two-node-smoke into main
Diffstat (limited to 'docs')
-rw-r--r--docs/tor.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/tor.md b/docs/tor.md
index a408704..0016f8b 100644
--- a/docs/tor.md
+++ b/docs/tor.md
@@ -201,3 +201,31 @@ but an already-discovered onion-capable peer can be reached directly over Tor.
201 201
202Tor owns the private key under `HiddenServiceDir`; back it up if you want the 202Tor owns the private key under `HiddenServiceDir`; back it up if you want the
203onion name to stay stable. 203onion name to stay stable.
204
205## Release smoke test
206
207After building a Windows binary with managed Tor support, run the two-node smoke
208test before cutting a release:
209
210```powershell
211powershell -ExecutionPolicy Bypass -File scripts\smoke-managed-tor-onion.ps1 `
212 -Bitflash .\src\bitflash.exe `
213 -Tor C:\path\to\tor.exe
214```
215
216The script creates two temporary datadirs, starts node A with `-managedtor`,
217waits for it to publish its `.btf` identity and generated `.onion` endpoint,
218then starts node B with its own `-managedtor`, `-oniononly`, and
219`-connectbtf=<node-a>`. It passes only when node B logs that it connected to
220node A `via direct onion`; rendezvous fallback cannot satisfy the test.
221
222By default the script waits 120 seconds after node A's descriptor self-resolves
223before it starts node B. Tor can create the local `hostname` before the hidden
224service descriptor is visible enough for client circuits, and early dials often
225fail with SOCKS5 reply `0x01`. Override this with `-OnionWarmupSec N` when
226testing a slow or already-warmed Tor environment.
227
228This test still uses Nostr for descriptor discovery, because that is how nodes
229learn each other's signed `.btf` descriptors. It does not require a Bitflash
230rendezvous relay to carry the P2P connection: once the descriptor includes the
231signed onion endpoint, the actual node connection goes directly through Tor.