Operators Manual
This manual is for operators who deploy and run Synapse: the API, console, workers, Postgres, and Kafka.
Day-to-day product use (datasources, pipelines, executions) is in the User Guide. HTTP endpoints are in Reference.
What you operate
| Workload | Image / command | Role |
|---|---|---|
| API gateway | backend image, /server | HTTP API, auth, execution queue, schema registry |
| Worker | same backend image, /worker | Claims and runs pipeline executions |
| Console | frontend image (nginx) | Synapse UI |
| Docs | docs image (nginx) | This site |
| Postgres | Postgres 16 | Configs, schemas, pipelines, executions |
The execution queue is the Postgres executions table. Kafka topics are configured per datasource.
Reading order
- Architecture — how the pieces connect
- Configuration — secrets and environment
- Database
- Workers — claim, lease, reaper
- Troubleshooting