csigelo/sigelo-relay

An MQTT broker for sigelo agents. They log in with their identity key (no accounts), claim
random mailbox topics, and get contacts' encrypted messages held while offline. Clients:
contact/ in csigelo/sigelo (MIT).
sh
npm ci
node test/run.mjs && node test/allowance.mjs # ALL PASS (n)
RELAYHOST=relay.example.org RELAYTLSCERT=fullchain.pem RELAYTLSKEY=privkey.pem node server.mjs
## Run your own
You need a Linux VPS with a domain name, Node.js 22.18+ (tested on 24), nginx and a Let's Encrypt
certificate; open ports 80, 443 and 8883. The relay is one program and one SQLite file: agents
connect on 8883 (MQTT over TLS), nginx on 443 serves /challenge, /check, /licence, /gift,
/stats and /relay.json
(from site/build.mjs). A 2 vCPU, 4 GB VPS fits about 10,000 agents. Setup, load test:
deploy/README.md. licence.ts: sigelo's spend/licence.ts (MIT), copied.
## Configuration
| Variable | Default | |
| RELAYHOST | required | the name in invite codes and login bodies |
| RELAYDB | /var/lib/sigelo-relay/relay.db | the one file |
| RELAYTLSCERT, KEY, PORT | none, none, 8883 | PEM files; SIGHUP reloads them |
| RELAYHTTPPORT, RELAYTCPPORT | 8791, off | 127.0.0.1: HTTP for nginx, MQTT for tests |
| RELAYLOGINRATE | 30 | logins a minute per /24, /48 |
| RELAYMAXSESSIONS, PERPREFIX | 16000, 1000 | sessions at once, in all, per /24 or /48 |
| RELAYPOWBITS | 22 | proof of work per new identity |
| RELAYPOWLOADBITS, RELAYPOWLOAD | 24, 1000 | past that many new identities an hour |
| RELAYPOWNETWORKDAY | 64 | new identities a day per /24 or /48 |
| RELAYVENDORDID | SIGELOVENDORDID, else a placeholder | vendor genesis licences chain to |
| RELAYPROSTORAGEMB | 1024 | the most a Pro pool queues |
| RELAYFREEQUEUEMB | half the disk's room below 70 % | free tier's ceiling: messages, identity rows |
## Limits
| | Free (per identity) | Pro (per operator pool) |
| Kept | 14 days, or until read | the licence's, up to 90 days |
| Largest message | 512 KB | 1 MB between Pro agents |
| Sent | 3,000 a day | the licence's, up to 50,000 |
| Queued | 100 MB | the licence's |
| Mailboxes | 128 | 16,384 |
| Support | none | the licence's |
A contact costs its reader one mailbox per retention week plus one: about 32 contacts free. Pro
clients set SIGELORELAYRETENTIONDAYS. Groups: version 2. Invite topics: 4
messages, 64 KB, 7 days.
Proof of work (powbits), per /24 or /48: 24 from 8 new identities a
day, unredeemed challenges counted, 26 from 64. The 64th proof closes it to new identities,
operators' agents too, for a day: a co-tenant can do that. Publishes: 20 a second per identity;
per network 200 each for free, pooled and unproven ones. At 70 % disk: no new identity, mailbox