summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorinfo@mode42.com <info@mode42.com>2026-08-08 03:54:55 +0000
committerinfo@mode42.com <info@mode42.com>2026-08-08 03:54:55 +0000
commit20cb29c2f8c5c87bc590896854a20b1473ceb358 (patch)
tree2857f41513a56ad41af97b57362639298aa7f033 /README.md
#2
Diffstat (limited to 'README.md')
-rw-r--r--README.md70
1 files changed, 70 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3401f04
--- /dev/null
+++ b/README.md
@@ -0,0 +1,70 @@
+# HyBBX · 2.8.0
+
+**hyBBX** = **hybrid Mailbox build System X**. Plannable **(hy)BBX** network system: closed / self-contained BBX core; Internet primarily for site interconnection and operator work; extensible via **plugins**. Public term: **BBX** (not BBS).
+
+C99 BBX daemon: text wire, `/` commands, mail, chat, conference. Main + Secondary topology over HBX; RF via external modems and MAX25 stack.
+
+## Feature matrix
+
+| Feature | Main | Secondary | Standalone |
+|---------|------|-----------|------------|
+| User login (telnet/SSH/WS) | yes | no | yes |
+| Mail / chat / conference | yes | via Main | yes |
+| HBX circuit hub | yes | client | optional |
+| `packet_radio` / ARDOP / CRDOP / **BayCom/based** | via plugin | yes | yes |
+| MAX25 attach (`[max25]`) | optional | typical | optional |
+| `mains_proxy` | opt-in build | opt-in | opt-in |
+
+## Transport matrix
+
+| Transport | Port (default) | Notes |
+|-----------|----------------|-------|
+| Telnet | 2323 | Plain text |
+| SSH | 3232 | Requires libssh build |
+| WebSocket | configurable | Menus / clients |
+| HBX | 7323 | Link auth + `link_password` |
+| MAX25 KISS | via max25d :7325 | v2.8.0 attach-only |
+| BayCom/based KISS | `/tmp/max25-bcpr/kiss-bc0` | via max25-bcpr · [docs/BAYCOM.md](docs/BAYCOM.md) |
+
+## MAX25 attach matrix
+
+| Rule | Value |
+|------|-------|
+| `kiss_entry` (local TNC) | `none` (MAX25 prep assumed) |
+| `[max25] check` | `yes` (default) — start fails if max25d down |
+
+## Build · test · run
+
+```bash
+cmake -B build -DCMAKE_BUILD_TYPE=Release && cmake --build build
+cmake -B build-test -DHYBBX_BUILD_TESTS=ON && cmake --build build-test && ctest --test-dir build-test
+./scripts/hybbx.sh
+```
+
+## Related
+
+| Goal | Doc |
+|------|-----|
+| Operate | [MANUAL.md](docs/MANUAL.md) |
+| RF + MAX25 order | [TNCS.md](docs/TNCS.md) · [MASTER-GUIDE.md](docs/MASTER-GUIDE.md) |
+| Full index | [docs/README.md](docs/README.md) |
+
+---
+<div align="center">
+<sub>
+<strong>UN1TME/UN1T.me · BBX</strong>
+<br><br>
+<table>
+<tr><th>Protocol</th><th>Host</th><th>Port</th><th>Command / URL</th></tr>
+<tr><td align="center">Telnet</td><td align="center"><code>hybbx.un1t.me</code></td><td align="center">2323</td><td align="center"><code>telnet hybbx.un1t.me 2323</code></td></tr>
+<tr><td align="center">SSH</td><td align="center"><code>hybbx.un1t.me</code></td><td align="center">3232</td><td align="center"><code>ssh hybbx.un1t.me -p 3232</code></td></tr>
+<tr><td align="center">HTTPS</td><td align="center"><code>hybbx.un1t.me</code></td><td align="center">443</td><td align="center"><a href="https://hybbx.un1t.me/">https://hybbx.un1t.me/</a></td></tr>
+<tr><td align="center">HTTP</td><td align="center"><code>hybbx.un1t.me</code></td><td align="center">80</td><td align="center"><a href="http://hybbx.un1t.me/">http://hybbx.un1t.me/</a></td></tr>
+</table>
+<br>
+<strong>hybbx.un1t.me</strong> Telnet <strong>:2323</strong> · SSH <strong>:3232</strong> · HTTP(S) <strong>:80/:443</strong> · Primary RF <strong>27.245 MHz / CB25</strong>
+</sub>
+<br><br>
+<a href="https://github.com/user-attachments/assets/0429f9e3-61b0-4b21-a01a-dfb98eabce77"> <img width="80" height="60" alt="UN1TME/UN1T.me BBX — sysop menu" src="https://github.com/user-attachments/assets/0429f9e3-61b0-4b21-a01a-dfb98eabce77" />
+</a>
+</div>
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com