upleb.uk

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

summaryrefslogtreecommitdiff
path: root/relay/README.md
diff options
context:
space:
mode:
authorBitflash-sh <btf01@proton.me>2026-07-24 11:18:11 -0300
committerBitflash-sh <btf01@proton.me>2026-07-24 11:18:11 -0300
commit51d617e70f90a972185917ea0096c1ecef2bfa8b (patch)
tree9fbbcd867de9de9d0776afdd02f594ba312c46eb /relay/README.md
Bitflash: fair-launch release
Satoshi's bitcoin-0.1.0 reborn with RandomX CPU proof of work, anonymous .btf addressing over Nostr with CGNAT rendezvous, automatic peer discovery, a headless Linux node, and Windows GUI wallet. Fair launch, no premine, 21M cap.
Diffstat (limited to 'relay/README.md')
-rw-r--r--relay/README.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/relay/README.md b/relay/README.md
new file mode 100644
index 0000000..abf0f8d
--- /dev/null
+++ b/relay/README.md
@@ -0,0 +1,57 @@
1# bitflashd — Bitflash rendezvous relay (the "meeting node")
2
3This is the small always-on server that lets Bitflash nodes behind CGNAT reach
4each other. Both sides connect **out** to this relay; it pairs them by their
5`.btf` pubkey and forwards ciphertext. It holds **no keys** and reads nothing —
6the two nodes are encrypted end-to-end (X25519 + ChaCha20-Poly1305) over it.
7
8Run it on any machine with a public IP (a cheap VPS). It has **no dependencies**
9beyond a C++ compiler.
10
11## Build (on the VPS, Linux)
12
13```
14sudo apt-get update && sudo apt-get install -y g++ # if needed
15bash build.sh
16```
17
18## Run
19
20```
21./bitflashd 8434
22```
23
24Open the port in the firewall (both the VPS provider's panel and the OS):
25
26```
27sudo ufw allow 8434/tcp # if ufw is enabled
28```
29
30## Keep it running (systemd)
31
32Create `/etc/systemd/system/bitflashd.service`:
33
34```
35[Unit]
36Description=Bitflash rendezvous relay
37After=network.target
38
39[Service]
40ExecStart=/root/bitflash/relay/bitflashd 8434
41Restart=always
42User=root
43
44[Install]
45WantedBy=multi-user.target
46```
47
48Then:
49
50```
51sudo systemctl daemon-reload
52sudo systemctl enable --now bitflashd
53sudo systemctl status bitflashd
54```
55
56The relay's address for clients is then `YOUR_VPS_IP:8434` — that is what goes
57into a node's descriptor as its `meeting_node`.