Choose a deployment
Use the published Docker images for Web and API. Start with one server, choose storage during setup, and add integrations when the service desk is working.
Pick your path
Section titled “Pick your path”| Scenario | Deployment choice |
|---|---|
| Evaluate on one host | Quickstart with SQLite and local accounts |
| Run a public service desk | Base release Compose plus HTTPS ingress |
| Keep PostgreSQL on the same host | Add docker-compose.postgres.yml and select PostgreSQL in setup |
| Use a managed database | External PostgreSQL |
| Use existing proxy infrastructure | Reverse proxy configuration |
| Add organization sign-in | Hybrid or OIDC |
SQLite and PostgreSQL both support the core service desk. Native ticket AI Assistant chat requires PostgreSQL; webhook AI assistance remains available with SQLite.
The services
Section titled “The services”| Component | Responsibility | Private port |
|---|---|---|
| Web | Browser console, login and selected API proxy routes | 8111 |
| API | Tickets, accounts, permissions, storage and background work | 8222 |
| Optional HTTP MCP | Tool access for approved integrations | 8223 |
| Optional PostgreSQL | Application data | 5432 |
Public browser and API traffic enters through Web. Web resolves its API destination from ApiBaseUrl, normally http://api:8222/ in Compose. The base release stack binds the host’s Web and API ports to loopback.
Keep the state together
Section titled “Keep the state together”The standard deployment has four persistent volumes: SQLite data, bootstrap state, Data Protection keys and attachment storage. PostgreSQL adds its own database storage while the other application volumes remain necessary.
The API applies the selected database’s migrations at startup. There is no separate migration container in this release. Keep API and Web on the same product version, and preserve the Compose project name and volumes during updates.
Release selection
Section titled “Release selection”The documentation targets v0.1.2-beta.17. Set RATELDESK_VERSION=0.1.2-beta.17 for its release template. The latest image tag tracks stable releases and does not select this beta.
Follow Docker Compose for everyday commands and Backup and restore before changing a running installation.
Release sources
Section titled “Release sources”Product home · Release downloads · Report a documentation issue