tbase documentation
Reference documentation for tbase, split by topic. If you just want the pitch
and a quick taste of the system, read the project README.md
instead — it stays as the overview; these pages are the details.
For the rationale behind design decisions (why FUSE, why the mixer works the way it does, the concurrency model), see architecture.md.
Start here: getting-started.md — build, group setup, mount, first message.
| Page | Covers |
|---|---|
| architecture.md | Why FUSE, the three streaming models, access control, concurrency, the UDP media plane, known limitations |
| getting-started.md | Building the binaries, setting up the chat group, mounting, server flags and defaults |
| filesystem-reference.md | Every path in the tree: mode, semantics, and an example command |
| access-control.md | Group gating, canSee/canSend, room naming, the self alias, presence |
| messaging.md | send framing and limits, sanitization, the three stream formats, markdown syntax, ctl/ knobs |
| file-transfer.md | 1:1 vs. broadcast file transfer, timeouts, readiness, events |
| voice.md | The voice/dial ticket handshake, wire format, mixing, per-listener gain |
| broadcast.md | Radio, tv, and cam: single-writer broadcast, profiles, the self alias, ffmpeg recipes |
| cli-reference.md | Every flag and positional argument for tbase-server, tbase-voice, tbase-cast |
| scripts.md | The helper scripts in scripts/: what each one does and requires |
| encryption.md | Bolting on end-to-end encryption with age, no server changes |