Reference¶
This section is not meant to be read front to back. It's a reference — look up what you need, find the answer, get back to work.
Quick Navigation¶
-
CLI Commands
Docker exec commands for Postfix, Dovecot, Rspamd, and MySQL — the commands you'll actually use day to day.
-
Configuration Reference
Every config file across all services, with all available options documented.
-
Database Schema
Tables, columns, types, relationships, and indexes for the MySQL database.
-
API Endpoints
Quick table of all REST API endpoints with methods, parameters, and response formats.
Full Reference Index¶
| Reference | What's In It | When You Need It |
|---|---|---|
| CLI Commands | Docker exec commands for Postfix, Dovecot, Rspamd, MySQL | Managing services from the command line |
| Configuration Reference | Every config file and its options | Customizing service behavior |
| Database Schema | Tables, columns, types, and relationships | Writing queries or building integrations |
| Log Formats | Where logs live and how to parse them | Debugging delivery or auth issues |
| Webhook Events | Every event type with full payload examples | Building webhook consumers |
| Error Codes | API, SMTP, and Rspamd error codes with explanations | Troubleshooting failures |
| Performance Metrics | Key metrics and their healthy ranges | Capacity planning and alerting |
| Prometheus Metrics | Every exposed metric with labels and types | Writing PromQL queries and dashboards |
| API Endpoints | All REST endpoints in one table | Quick API lookup |
| Environment Variables | Complete env var reference with defaults | Initial setup and reconfiguration |
| Glossary | Email jargon explained in plain English | Understanding the docs |
Most common lookups
- "What's this error code?" — Error Codes
- "How do I check the mail queue?" — CLI Commands
- "What env vars do I need?" — Environment Variables
- "What does this webhook payload look like?" — Webhook Events
- "What table stores mailboxes?" — Database Schema
Related Sections¶
- Configuration — Detailed setup guides for each component
- Guides > Troubleshooting — Step-by-step debugging walkthroughs
- Worker > API Gateway — Full API documentation