Skip to content

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

    The management CLIs (start.sh, manage.py, scripts/) plus the docker exec commands for Postfix, Dovecot, Rspamd, and MySQL.

    CLI Commands

  • Configuration Reference

    Where every config file actually lives — baked image configs, host mounts, and generated files — with the key effective settings.

    Configuration Reference

  • Database Schema

    Tables, columns, types, relationships, and indexes for the MySQL database.

    Database Schema

  • API Endpoints

    Quick table of all REST API endpoints with methods, parameters, and response formats.

    API Endpoints

Full Reference Index

Reference What's In It When You Need It
CLI Commands Management CLIs, scripts/, and docker exec commands Managing services from the command line
Configuration Reference Config file locations and key effective settings Customizing service behavior
Database Schema All 83 tables at the current Alembic head Writing queries or building integrations
Log Formats Where logs live, their formats, and the log ingestor Debugging delivery or auth issues
Webhook Events The event catalogue, payloads, signing, retries Building webhook consumers
Error Codes API error envelope + codes, SMTP/DSN, Rspamd actions Troubleshooting failures
Performance Metrics Key metrics and their healthy ranges Capacity planning and alerting
Prometheus Metrics Every exposed metric, with the service-prefix rule Writing PromQL queries and dashboards
API Endpoints All REST endpoints in one table Quick API lookup
Environment Variables The variables code actually reads, with defaults Initial setup and reconfiguration
Glossary Email jargon explained in plain English Understanding the docs

Most common lookups