Documentation
Tyto docs
Everything you need to run, configure and understand Tyto. Deploying for the first time? The Quick Start is the fastest path — these pages go deeper.
Setup
Getting startedInstall and run Tyto in production with Docker Compose — separate stacks or the single-stack bundle.ConfigurationServer settings, environment variables, and the admin console.Behind a reverse proxyRun Tyto behind an existing reverse proxy — plain HTTP mode, ports, WebSockets, SSE and voice.Network configurationEvery port Tyto uses, opening them, NAT and port forwarding, common failures and the security picture.UpdatingUpgrade a Tyto deployment — version pinning, what happens on update, rollbacks and backups.OperationsHealth checks, background workers, logs and the search index — running Tyto day to day.Backups & restoreWhat's stateful in a Tyto deployment, how to back it up consistently, and how to restore or migrate to a new host.Voice setup (LiveKit)How the bundled LiveKit media server is wired into core — ports, defaults, disabling voice and pointing at an external LiveKit.TroubleshootingCommon failure modes for a self-hosted server — likely cause and the fix, most frequent first.
Administration
First-run setup wizardThe five-step wizard that greets a new server's admin on first login, covering branding, the first community, registration, and mail delivery.Admin panelThe /admin console — server settings, users, communities, reports, webhooks, audit log and health.Server settingsThe settings registry — where server-wide configuration lives and how changes apply.CommunitiesCreating communities, visibility and membership — plus channels, roles, groups, welcome messages and emojis.ModerationThe moderation ladder — warnings, timeouts, bans, server bans, reports, appeals and the auto-moderator.Anti-spamScreen new registrations against the StopForumSpam database — opt-in, privacy-minimised, fail-open.
Usage
Signing up & signing inRegistration, login, password resets and what happens to your session.Discovering communitiesThe public catalogue, browsing as a guest, joining and pinning communities.Writing messagesThe composer — sending, editing, typing indicators; formatting, mentions, emojis and attachments in detail.Messages & threadsWhat you can do with a message — reactions, threads, pins, permalinks, embeds, search, history.Direct messagesPrivate conversations — starting them, group DMs, mute, unread and what works inside.Voice & videoVoice channels — joining, push-to-talk, devices, background blur, camera and screen sharing.Account & preferencesYour profile, presence, notifications, language, favorites and data — all in one place.Staying caught upUnread badges, the new-messages divider, jump to latest and mark-all-read.
Developers
Development setupOne-command DDEV environments for core and client — no local PHP or Node needed.TestingThe test suites — PHPUnit functional tests, Vitest unit tests, Playwright end-to-end.REST APIThe JSON-LD REST API — interactive docs, authentication, versioning.Architecture & tech stackHow the core API, client SPA and realtime services fit together, and what they're built with.Building a botA tutorial that takes you from a fresh bot account to a working webhook-driven reply bot using the REST API.