DeltaChat / Documentation
DeltaChat docs
Documentation for self-hosting, configuring, operating, and maintaining DeltaChat. Start with installation, then move through configuration, upgrades, and troubleshooting as needed.
Documentation approach
DeltaChat documentation is intended to support real operators running a self-hosted deployment. The goal is clarity, practicality, and a clean path from first setup through ongoing maintenance.
Operator-friendly
The docs are aimed at real self-hosted deployment, not abstract product messaging.
Practical
Focus stays on getting DeltaChat running, configured, and maintained with a clear operational path.
Docker-first
The current deployment model is built around Docker Compose and a runtime environment file.
Start here
For most people, the best reading order is:
1. Installation
Get the stack running on a Linux host with Docker Compose.
2. Configuration
Review runtime values, URLs, secrets, and deployment settings.
3. Troubleshooting
Check logs, service state, connectivity, and common failure points.
4. Upgrading
Update carefully, verify the stack, and keep operational discipline.
Documentation map
Use these entry points to move through installation, setup, and operations without hunting through the repository manually.
Getting started
Start with the core deployment path, prerequisites, and first-run expectations for a clean self-hosted setup.
Installation
Follow the Docker Compose deployment path and bring DeltaChat up with a clear runtime environment file.
Configuration
Review runtime settings such as image versioning, public base URLs, JWT values, and deployment variables.
Upgrading
Update images, recreate the stack carefully, verify service health, and keep rollback thinking in mind.
Troubleshooting
Check container state, logs, connectivity, environment mismatches, and common operational failure points.
Optional tools
Use supporting tools like Portainer or pgAdmin when you want extra visibility into containers or Postgres.
Quick links
Move between the main product page, the install path, and the supporting information without losing context.
Prefer a guided install path?
Go straight to the install guide for the shortest path from server setup to a running DeltaChat stack.
