Quick start

Run your own Tyto

Production setup with Docker Compose and the prebuilt images. Pick your shape: the API server alone (enough for the desktop app), the web client alone, or both bundled on one host.

  1. Prerequisites

    A server with Docker + Docker Compose (Linux recommended), a DNS record for the API domain (e.g. chat.example.com) pointing at it, ports 80/443 open. HTTPS is automatic via the built-in Caddy. Voice channels additionally need 7881/tcp + 50000–50100/udp open on this host; if you can't open them, set VOICE_ENABLED=false for a text-only server.

  2. Get the stack
    mkdir tyto-core && cd tyto-core
    curl -LO https://raw.githubusercontent.com/tyto-chat/core/master/compose.yaml
  3. Configure

    Create .env — two required values plus the web client's origin, for an API at chat.example.com and a web client at app.example.com:

    TYTO_VERSION=1.0.0-beta.11
    SERVER_DOMAIN=chat.example.com
    CORS_ALLOW_ORIGIN=https://app.example.com

    TYTO_VERSION pins the release you run — it picks the tag of the prebuilt ghcr.io/tyto-chat/tyto-core image that Docker pulls (the value above is the current release). Pinning keeps deploys reproducible and makes upgrades deliberate: bump the value and run docker compose up -d again. If you leave it unset, Compose falls back to latest, which silently jumps versions on every pull — pin it in production.

    CORS_ALLOW_ORIGIN lists the origins of your web clients. Leave the line out entirely if your users connect with the desktop app only — the app is allowed by default.

    That's the whole configuration: every secret (database, search, voice, app keys) is auto-generated on first start, public URLs derive from SERVER_DOMAIN, HTTPS is automatic, and mail is configured later in the admin panel. All other variables — managed databases, external LiveKit and more — are documented in .env.prod.example.

  4. Start it and create the admin
    docker compose up -d
    docker compose exec app php bin/console tyto:user:create --admin

    First start pulls the images, runs migrations and generates keys; the command prompts for the admin email and password. The server is ready for the desktop app: users add it by entering chat.example.com on the app's connect screen, and the server's own homepage at that address offers an Open in Tyto desktop button. Want a web app as well? The Client tab runs it on a separate host; the Bundle tab serves it from this same stack.

Before opening registration, set your Terms of Service and Privacy Policy in Admin → Settings → Legal. Tyto ships generic default documents you can load into the editor as a starting point — review and adapt them to your jurisdiction and how you run the server; they're templates, not legal advice. See Legal.
Ports 80/443 already taken by an existing reverse proxy? All three shapes run behind one — see Behind a reverse proxy.
Developing or contributing instead? Both repos ship a one-command DDEV dev environment — see the READMEs of core and client. Deeper configuration lives in the documentation.