upleb.uk

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

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbitflash <admin@bitflash.network>2026-08-19 15:16:36 -0300
committerbitflash <admin@bitflash.network>2026-08-19 15:16:36 -0300
commitc65369843c873bff049469791b538d863d063053 (patch)
tree86df96acb4fa6279df7b2b15c268508721dc6ea9
parent61eac533f40ecfccfb051a8053b5cd52b2c7dff6 (diff)
readme: document -walletbackend and the automatic managed Tor
- name the -walletbackend=sqlite|bdb override and the wallet-backend marker in the wallet section - add -nomanagedtor to the Tor flag list and note that the desktop app starts a managed Tor automatically, while a headless node asks for it
-rw-r--r--README.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9a0136c..fa4f152 100644
--- a/README.md
+++ b/README.md
@@ -170,7 +170,9 @@ lose money.
170Since 1.2.20 the file is a single self-contained `wallet.sqlite` by default. A 170Since 1.2.20 the file is a single self-contained `wallet.sqlite` by default. A
171fresh data directory starts on it; an existing Berkeley DB `wallet.dat` keeps 171fresh data directory starts on it; an existing Berkeley DB `wallet.dat` keeps
172working and the desktop app converts it in one click on first run, never 172working and the desktop app converts it in one click on first run, never
173touching the original, which stays as a fallback. See 173touching the original, which stays as a fallback. Choose a backend explicitly
174with `-walletbackend=sqlite` or `-walletbackend=bdb`, recorded in a
175`wallet-backend` marker in the data directory. See
174[wallet storage](docs/storage.md). 176[wallet storage](docs/storage.md).
175 177
176The derivation is written down in [docs/derivation.md](docs/derivation.md), with 178The derivation is written down in [docs/derivation.md](docs/derivation.md), with
@@ -356,6 +358,7 @@ Other options worth knowing:
356-socks=HOST:PORT # SOCKS5 for outbound Nostr, .btf relay, and onion peer dials 358-socks=HOST:PORT # SOCKS5 for outbound Nostr, .btf relay, and onion peer dials
357-tor[=HOST:PORT] # Tor mode; default local Tor SOCKS5 proxy is 127.0.0.1:9050 359-tor[=HOST:PORT] # Tor mode; default local Tor SOCKS5 proxy is 127.0.0.1:9050
358-managedtor[=PATH] # start Tor, create a hidden service, advertise its onion 360-managedtor[=PATH] # start Tor, create a hidden service, advertise its onion
361-nomanagedtor # disable the automatic bundled-Tor startup
359-onionservice=HOST.onion:PORT # advertise this node's Tor hidden service 362-onionservice=HOST.onion:PORT # advertise this node's Tor hidden service
360-debug # verbose log; without it debug.log is nearly silent 363-debug # verbose log; without it debug.log is nearly silent
361-help # full list 364-help # full list
@@ -376,6 +379,10 @@ proxy. IPv6 proxy endpoints use brackets, for example `-socks=[::1]:9050`.
376and signed direct `.onion` peer dials through Tor, and keeps external-IP probes 379and signed direct `.onion` peer dials through Tor, and keeps external-IP probes
377disabled. Use `-tor=HOST:PORT` when Tor listens somewhere else. 380disabled. Use `-tor=HOST:PORT` when Tor listens somewhere else.
378 381
382The desktop app starts a managed Tor automatically when no other Tor option is
383set, so onion transport works out of the box; `-nomanagedtor` turns that off.
384For a headless node, ask for it explicitly:
385
379`-managedtor[=PATH]` starts a Tor process for this node, writes a local `torrc`, 386`-managedtor[=PATH]` starts a Tor process for this node, writes a local `torrc`,
380creates a v3 hidden service for port `8433`, routes outbound discovery through 387creates a v3 hidden service for port `8433`, routes outbound discovery through
381that Tor instance, and signs the generated `.onion:8433` endpoint into the 388that Tor instance, and signs the generated `.onion:8433` endpoint into the