Skip to content

Guides

Step-by-step guides that walk you through real tasks. Each one assumes you already have a running Mailyte server and takes you from start to finish with concrete commands and examples.

Before you begin

These guides assume a working Mailyte deployment. If you don't have one yet, start with Installation first.

At a Glance

flowchart LR
    subgraph Migrate["Migration"]
        MG[Mailgun]
        SG[SendGrid]
    end

    subgraph Configure["Email Config"]
        DKIM[DKIM Setup]
        DELIV[Deliverability]
        DOM[Domains]
        ORG[Organizations]
    end

    subgraph Infra["Infrastructure"]
        SCALE[Scaling]
        MON[Monitoring]
        BACK[Backups]
        INT[Integrations]
    end

    subgraph Fix["Troubleshooting"]
        EMAIL[Delivery Issues]
        SSL[SSL Issues]
        DB[Database]
        NET[Network]
    end

    Migrate --> Configure --> Infra
    Fix -.->|"when things break"| Infra

Migration

Moving from another email provider? These guides cover the full process — exporting data, importing via the API, updating DNS, and verifying delivery.

  • Migrating from Mailgun

    Export domains and mailboxes, import via API, cut over DNS, and verify delivery.

    Mailgun Migration

  • Migrating from SendGrid

    Export sending domains and templates, switch to Mailyte, and validate SPF/DKIM.

    SendGrid Migration

Email Configuration

Guide What It Covers Difficulty
Setting Up DKIM Generate keys, add DNS records, configure Rspamd signing Beginner
Improving Deliverability SPF, DKIM, DMARC alignment, IP warm-up, reputation management Intermediate
Domain Configuration Adding domains, DNS verification, catch-all aliases, per-domain settings Beginner
Managing Organizations Bulk operations, quota management, billing integration hooks Intermediate

New to email infrastructure?

Start with Domain Configuration, then Setting Up DKIM, then Improving Deliverability. This order builds on each previous step.

Infrastructure

Guide What It Covers Difficulty
Scaling to Millions Queue optimization, multiple Postfix instances, database sharding Advanced
Monitoring Setup End-to-end monitoring stack from scratch Intermediate
Prometheus Configuration Detailed Prometheus config for every Mailyte service Intermediate
Grafana Dashboards Import pre-built dashboards, create custom panels, set up alerting Intermediate
Backup Automation Automated scripts, S3 sync, retention policies, restore testing Intermediate
Custom Integrations Webhooks for CRM/ticketing systems, API automation patterns Intermediate

Troubleshooting

Something broken? Find your symptom below and follow the guide.

  • Email Delivery Issues

    Email not arriving, stuck in queue, bouncing, or being rejected by remote servers.

    Diagnose delivery issues

  • SSL Certificate Issues

    Certificates not renewing, domain mismatch errors, Let's Encrypt rate limits.

    Fix SSL issues

  • Database Performance

    Slow queries, connection pool exhaustion, table locks, replication lag.

    Fix database issues

  • Network Connectivity

    Ports blocked by firewall, DNS resolution failures, Docker networking problems.

    Fix network issues

  • Monitoring Issues

    Prometheus not scraping, Grafana dashboard errors, missing metrics.

    Fix monitoring issues

  • Service Failures

    Container crashes, OOM kills, disk full, services not starting.

    Fix service failures

  • Configuration — Detailed configuration reference for all components
  • Deployment — Production setup, scaling, and disaster recovery
  • Monitoring — Dashboards, alerts, and health checks
  • Reference — CLI commands, error codes, and database schema