Documentation
Two guides, the developer docs, and the complete documentation of Mnema Talk, all on this site and pinned to the release they describe. This page is the map.
- Hosting guideEverything for the one who runs the server, from the first install to backups and repairs.
- Developer docsBots, the SDKs, webhooks, and the REST and gateway reference.
Setting up
| If you want to | Read |
|---|---|
| Install from an empty folder, with every step checked | Quick start |
| Install on Synology, Unraid, a VPS or a Raspberry Pi | Platform notes |
| Set up HTTPS with Caddy, Synology, Nginx Proxy Manager or nginx | Reverse proxy |
| Open the right ports, and see what the server sends out | Network ports |
| Install by hand, without the assistant | Deployment |
| Look up a word such as STUN, TURN or NAT | Glossary |
Running it
| If you want to | Read |
|---|---|
| Update, back up, or choose an image tag | Updating |
| Know what changed per version, and roll back | Upgrade notes |
| Change any setting, add TURN, monitor, restore | Operations |
| Fix “No media connection” or “Connection lost” | Voice troubleshooting |
| Get quick answers about domains, Cloudflare, tunnels | FAQ |
Using it
| Topic | Read |
|---|---|
| Roles, permissions and private channels | Roles and permissions |
| Moderation, automod and the audit log | Moderation |
| Talks, Stages and lobbies | Talks |
| Forums, the wiki and events | Forums, Wiki, Events |
| Importing an existing server's structure | Server import |
| The desktop app | Desktop app |
Building on it
| Topic | Read |
|---|---|
| Bots, the REST API and the gateway | Bots |
| Incoming and outgoing webhooks | Webhooks |
| What is stable API and how it may change | API stability |
| Components, data flow and capacity | Architecture |
| Building, testing and contributing | Development, Contributing |
| What is tested and what is not yet | Product status |
The API reference is built into the server: set API_DOCS_ENABLED=true and signed-in members find it at /api/docs.