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.

Setting up

If you want toRead
Install from an empty folder, with every step checkedQuick start
Install on Synology, Unraid, a VPS or a Raspberry PiPlatform notes
Set up HTTPS with Caddy, Synology, Nginx Proxy Manager or nginxReverse proxy
Open the right ports, and see what the server sends outNetwork ports
Install by hand, without the assistantDeployment
Look up a word such as STUN, TURN or NATGlossary

Running it

If you want toRead
Update, back up, or choose an image tagUpdating
Know what changed per version, and roll backUpgrade notes
Change any setting, add TURN, monitor, restoreOperations
Fix “No media connection” or “Connection lost”Voice troubleshooting
Get quick answers about domains, Cloudflare, tunnelsFAQ

Using it

TopicRead
Roles, permissions and private channelsRoles and permissions
Moderation, automod and the audit logModeration
Talks, Stages and lobbiesTalks
Forums, the wiki and eventsForums, Wiki, Events
Importing an existing server's structureServer import
The desktop appDesktop app

Building on it

TopicRead
Bots, the REST API and the gatewayBots
Incoming and outgoing webhooksWebhooks
What is stable API and how it may changeAPI stability
Components, data flow and capacityArchitecture
Building, testing and contributingDevelopment, Contributing
What is tested and what is not yetProduct status

The API reference is built into the server: set API_DOCS_ENABLED=true and signed-in members find it at /api/docs.

Something wrong on this page? Tell us.