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-sh <btf01@proton.me>2026-07-24 14:46:49 -0300
committerBitflash-sh <btf01@proton.me>2026-07-24 14:46:49 -0300
commite2bc68de1af27d3459878f43c40061d0c30d09d7 (patch)
tree40bffb13573ff9fe4a3c114883d10f533aa7e803 /README.md
parent2b10d4a64fd17ad6320055935d76ab6beca3b9b3 (diff)
Automatic relay discovery over Nostr + call-to-action
Relay operators announce their relay with -announcerelay=host:port; every node discovers announced relays (kind 38502) and adds them to its failover list, so volunteer relays join with no maintainer edit or approval. Anti-spam cap + validation; relays are trustless (echan makes a bad relay unable to read/MITM). README: automatic relay-volunteer guide, 'don't let the network die' section.
Diffstat (limited to 'README.md')
-rw-r--r--README.md50
1 files changed, 35 insertions, 15 deletions
diff --git a/README.md b/README.md
index 5f1c2bb..d5be586 100644
--- a/README.md
+++ b/README.md
@@ -49,6 +49,24 @@ promise back.
49 49
50--- 50---
51 51
52<div align="center">
53
54## ๐Ÿ”ฅ Don't let the network die โ€” run a node
55
56A cryptocurrency is only as alive as the people running it. Every node that mines,
57relays, and stays online makes Bitflash **faster, freer, and impossible to shut down.**
58No companies. No servers to trust. No gatekeepers โ€” just people, one CPU each.
59
60### Download it. Run it. Keep it alive.
61
62**[โฌ‡๏ธ Windows](../../releases/latest)** &nbsp;ยท&nbsp; **[๐Ÿง Linux](#-linux-node--miner)** &nbsp;ยท&nbsp; **[๐Ÿ›ฐ๏ธ Run a relay](#-become-a-relay-volunteer--automatically)**
63
64*The network needs you online. Close this tab and it's one node weaker.*
65
66</div>
67
68---
69
52## โœจ Features 70## โœจ Features
53 71
54| | | 72| | |
@@ -138,31 +156,33 @@ source, then the `bitflash-node` binary. Debian/Ubuntu.
138Built with **MSYS2 UCRT64** (g++ 16, wxWidgets 3.2, OpenSSL 3, Berkeley DB). See 156Built with **MSYS2 UCRT64** (g++ 16, wxWidgets 3.2, OpenSSL 3, Berkeley DB). See
139[`build.sh`](build.sh) and `src/makefile.mingw`. 157[`build.sh`](build.sh) and `src/makefile.mingw`.
140 158
141### ๐Ÿ›ฐ๏ธ Become a relay volunteer 159### ๐Ÿ›ฐ๏ธ Become a relay volunteer โ€” automatically
142 160
143Relays are the meeting points that let nodes behind CGNAT find each other. More 161Relays are the meeting points that let nodes behind CGNAT find each other. More
144relays, spread across more places, make the network **faster** and **harder to 162relays, in more places, make the network **faster** and **harder to knock
145knock offline**. If you have a VPS or box with a public IP, you can run one and 163offline**. If you have a VPS with a public IP, you can add one โ€” and **the whole
146directly strengthen Bitflash: 164network discovers it automatically. No approval, no gatekeeper, no waiting.**
147 165
148**1. Run the relay โ€” one command:** 166**1. Run the relay โ€” one command:**
149```bash 167```bash
150sudo bash relay/install-bitflash-relay.sh 8434 168sudo bash relay/install-bitflash-relay.sh 8434
151``` 169```
152It builds a tiny, dependency-free daemon, applies basic anti-flood firewall 170Builds a tiny, dependency-free daemon, applies anti-flood firewall rules, and
153rules, and installs it as a `systemd` service (auto-restarts, survives reboot). 171installs it as a `systemd` service (auto-restarts, survives reboot).
154 172
155**2. Open TCP port `8434`** in your firewall / cloud panel. 173**2. Open TCP port `8434`** in your firewall / cloud panel.
156 174
157**3. Get it into the network.** Send your relay's `IP:8434` by 175**3. Announce it** by running a node that advertises your relay:
158[opening an issue](../../issues) (or a pull request adding it to the seed list 176```bash
159in `src/nostr.cpp`). A maintainer reviews it and includes it in the **seed list** 177./bitflash-node -gen -announcerelay=YOUR_PUBLIC_IP:8434
160of the next release โ€” then every node starts using it automatically, with 178```
161failover if any relay goes down. 179That node publishes your relay over Nostr; every other node discovers it within
180a minute and adds it to its failover list. **Done โ€” you're part of the backbone.**
162 181
163> ๐Ÿ”’ A relay **never sees your traffic** โ€” it only forwards end-to-end-encrypted 182> ๐Ÿ”’ A relay is **trustless** โ€” it only forwards end-to-end-encrypted bytes and
164> bytes and pairs peers by their `.btf` key. It holds no keys and reads nothing. 183> pairs peers by their `.btf` key. It **cannot read, tamper with, or MITM** your
165> A 1 GB VPS is plenty, and every relay you add makes the whole network tougher. 184> traffic; a malicious relay can at most refuse to forward, and nodes simply fail
185> over. That's exactly why anyone can run one safely. A 1 GB VPS is plenty.
166 186
167<details> 187<details>
168<summary>Run the Linux node 24/7 (systemd)</summary> 188<summary>Run the Linux node 24/7 (systemd)</summary>
@@ -214,7 +234,7 @@ systemctl daemon-reload && systemctl enable --now bitflash-node
214- [x] Headless Linux node/miner 234- [x] Headless Linux node/miner
215- [x] Fair-launch, stable-parameter relaunch 235- [x] Fair-launch, stable-parameter relaunch
216- [x] Redundant relays across regions with automatic failover 236- [x] Redundant relays across regions with automatic failover
217- [ ] Automatic relay discovery over Nostr (self-announcing volunteer relays) 237- [x] Automatic relay discovery over Nostr (self-announcing volunteer relays)
218- [ ] Optional direct IPv6 transport (opt-in, for public backbone nodes) 238- [ ] Optional direct IPv6 transport (opt-in, for public backbone nodes)
219- [ ] One-click installers 239- [ ] One-click installers
220 240