diff options
| author | Bitflash-sh <btf01@proton.me> | 2026-07-24 12:35:37 -0300 |
|---|---|---|
| committer | Bitflash-sh <btf01@proton.me> | 2026-07-24 12:35:37 -0300 |
| commit | 2b10d4a64fd17ad6320055935d76ab6beca3b9b3 (patch) | |
| tree | 5585ac3643fecf7d94284ca7590a7f448d20f4d4 | |
| parent | 3efd9a089cc6b924d9bc917d3d8145f7c01265ad (diff) | |
README: relay-volunteer guide + roadmap update
| -rw-r--r-- | README.md | 25 |
1 files changed, 21 insertions, 4 deletions
| @@ -138,15 +138,31 @@ source, then the `bitflash-node` binary. Debian/Ubuntu. | |||
| 138 | Built with **MSYS2 UCRT64** (g++ 16, wxWidgets 3.2, OpenSSL 3, Berkeley DB). See | 138 | Built with **MSYS2 UCRT64** (g++ 16, wxWidgets 3.2, OpenSSL 3, Berkeley DB). See |
| 139 | [`build.sh`](build.sh) and `src/makefile.mingw`. | 139 | [`build.sh`](build.sh) and `src/makefile.mingw`. |
| 140 | 140 | ||
| 141 | ### Run a rendezvous relay (optional, help the network) | 141 | ### 🛰️ Become a relay volunteer |
| 142 | 142 | ||
| 143 | Have a box with a public IP? Run a relay in one command and strengthen the network: | 143 | Relays are the meeting points that let nodes behind CGNAT find each other. More |
| 144 | relays, spread across more places, make the network **faster** and **harder to | ||
| 145 | knock offline**. If you have a VPS or box with a public IP, you can run one and | ||
| 146 | directly strengthen Bitflash: | ||
| 144 | 147 | ||
| 148 | **1. Run the relay — one command:** | ||
| 145 | ```bash | 149 | ```bash |
| 146 | sudo bash relay/install-bitflash-relay.sh 8434 | 150 | sudo bash relay/install-bitflash-relay.sh 8434 |
| 147 | ``` | 151 | ``` |
| 152 | It builds a tiny, dependency-free daemon, applies basic anti-flood firewall | ||
| 153 | rules, and installs it as a `systemd` service (auto-restarts, survives reboot). | ||
| 148 | 154 | ||
| 149 | It builds a tiny, dependency-free daemon and installs it as a systemd service. | 155 | **2. Open TCP port `8434`** in your firewall / cloud panel. |
| 156 | |||
| 157 | **3. Get it into the network.** Send your relay's `IP:8434` by | ||
| 158 | [opening an issue](../../issues) (or a pull request adding it to the seed list | ||
| 159 | in `src/nostr.cpp`). A maintainer reviews it and includes it in the **seed list** | ||
| 160 | of the next release — then every node starts using it automatically, with | ||
| 161 | failover if any relay goes down. | ||
| 162 | |||
| 163 | > 🔒 A relay **never sees your traffic** — it only forwards end-to-end-encrypted | ||
| 164 | > bytes and pairs peers by their `.btf` key. It holds no keys and reads nothing. | ||
| 165 | > A 1 GB VPS is plenty, and every relay you add makes the whole network tougher. | ||
| 150 | 166 | ||
| 151 | <details> | 167 | <details> |
| 152 | <summary>Run the Linux node 24/7 (systemd)</summary> | 168 | <summary>Run the Linux node 24/7 (systemd)</summary> |
| @@ -197,8 +213,9 @@ systemctl daemon-reload && systemctl enable --now bitflash-node | |||
| 197 | - [x] Automatic peer discovery — zero config | 213 | - [x] Automatic peer discovery — zero config |
| 198 | - [x] Headless Linux node/miner | 214 | - [x] Headless Linux node/miner |
| 199 | - [x] Fair-launch, stable-parameter relaunch | 215 | - [x] Fair-launch, stable-parameter relaunch |
| 216 | - [x] Redundant relays across regions with automatic failover | ||
| 217 | - [ ] Automatic relay discovery over Nostr (self-announcing volunteer relays) | ||
| 200 | - [ ] Optional direct IPv6 transport (opt-in, for public backbone nodes) | 218 | - [ ] Optional direct IPv6 transport (opt-in, for public backbone nodes) |
| 201 | - [ ] Redundant relays & bootstrap hardening | ||
| 202 | - [ ] One-click installers | 219 | - [ ] One-click installers |
| 203 | 220 | ||
| 204 | --- | 221 | --- |