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:31:29 -0300
committerbitflash <admin@bitflash.network>2026-08-12 10:31:29 -0300
commitc8d798807e69ddbe55bfab8a34286ab75b786cb5 (patch)
tree81b5d44e5193f220b64097f496e314e04caf2db8 /README.md
parentc5f6b52c0d1d65f7bf8cd745a7a212bc6b2fe318 (diff)
parentd0ebe648f333def99fababd65f6b929448616d56 (diff)
test merge
# Conflicts: # src/makefile.mingw
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/README.md b/README.md
index f7d9468..ef4f39b 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
@@ -104,6 +105,14 @@ and produces canonical JSON whose hash can be compared by independent auditors
104or timestamped externally with OpenTimestamps. See 105or timestamped externally with OpenTimestamps. See
105[fair-launch verification](docs/fair-launch.md). 106[fair-launch verification](docs/fair-launch.md).
106 107
108For a static local block explorer, generate HTML and JSON from either a data
109directory or explicit block files:
110
111```bash
112python3 scripts/build-explorer.py --datadir ~/.bitflash ./explorer-out
113python3 scripts/build-explorer.py ~/.bitflash/blk0001.dat ~/.bitflash/blk0002.dat ./explorer-out
114```
115
107**Keep your node current.** Consensus rules have changed since the first 116**Keep your node current.** Consensus rules have changed since the first
108releases — 1.2.1 fixed a bug that let anyone spend anyone's coins, and 1.2.2 117releases — 1.2.1 fixed a bug that let anyone spend anyone's coins, and 1.2.2
109added a per-block signature-operation cap. A node on an older build will accept 118added a per-block signature-operation cap. A node on an older build will accept
@@ -310,6 +319,8 @@ Other options worth knowing:
310```bash 319```bash
311-datadir=PATH # wallet and chain data elsewhere 320-datadir=PATH # wallet and chain data elsewhere
312-port=N # P2P listen port, default 8433 321-port=N # P2P listen port, default 8433
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
313-debug # verbose log; without it debug.log is nearly silent 324-debug # verbose log; without it debug.log is nearly silent
314-help # full list 325-help # full list
315``` 326```
@@ -318,6 +329,16 @@ Other options worth knowing:
318needed — the data directory takes an exclusive lock, so a second node pointed at 329needed — the data directory takes an exclusive lock, so a second node pointed at
319the same one will refuse to start. 330the same one will refuse to start.
320 331
332`-socks=127.0.0.1:9050` routes outbound Nostr discovery and `.btf` rendezvous
333dials through a local SOCKS5 proxy such as Tor. When it is set, the node skips
334plain HTTP external-IP probes instead of leaking a direct request outside the
335proxy. IPv6 proxy endpoints use brackets, for example `-socks=[::1]:9050`.
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
321### When something looks wrong 342### When something looks wrong
322 343
323**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: