CLI Commands¶

./start.sh <command> [flags] [services...]

python manage.py migrate                    # alembic upgrade head
python manage.py migrate:rollback --steps 1 # alembic downgrade -1
python manage.py migrate:status             # alembic history --verbose
python manage.py migrate:current            # alembic current --verbose
python manage.py migrate:create <name>      # alembic revision --autogenerate
python manage.py migrate:fresh [--force]    # downgrade base + upgrade head (prompts!)
python manage.py migrate:reset [--force]    # downgrade base

docker compose build migrate && docker compose run --rm migrate

docker exec postfix postqueue -p            # view the queue
docker exec postfix postqueue -f            # flush (retry all deferred)
docker exec postfix postcat -q QUEUE_ID     # view a queued message
docker exec postfix postsuper -d QUEUE_ID   # delete one message
docker exec postfix postsuper -d ALL deferred  # delete all deferred
docker exec postfix postsuper -h QUEUE_ID   # hold
docker exec postfix postsuper -H QUEUE_ID   # release
docker exec postfix postsuper -r QUEUE_ID   # requeue

docker exec postfix postconf -n             # non-default settings
docker exec postfix postconf smtpd_milters  # one setting
docker exec postfix postfix check           # validate
docker exec postfix postfix reload          # reload without restart

docker exec postfix tail -100 /var/log/postfix/mail.log
docker exec postfix grep "user@example.com" /var/log/postfix/mail.log
docker exec postfix grep "QUEUE_ID" /var/log/postfix/mail.log

docker exec dovecot doveadm who                          # active sessions
docker exec dovecot doveadm user user@example.com        # userdb lookup
docker exec dovecot doveadm quota get -u user@example.com
docker exec dovecot doveadm quota recalc -u user@example.com
docker exec dovecot doveadm auth cache flush             # flush ALL cached credentials
docker exec dovecot doveadm auth cache flush user@example.com

docker exec dovecot doveadm mailbox list -u user@example.com
docker exec dovecot doveadm mailbox status -u user@example.com messages INBOX
docker exec dovecot doveadm search -u user@example.com mailbox INBOX subject "test"
docker exec dovecot doveadm index -u user@example.com INBOX
docker exec dovecot doveadm purge -u user@example.com

docker exec dovecot doveconf -n
docker exec dovecot doveadm log errors
docker exec dovecot doveadm reload
docker logs dovecot --tail 100        # Dovecot logs to stderr

docker exec rspamd rspamc stat                    # statistics
docker exec rspamd rspamc counters               # per-symbol counters
docker exec -i rspamd rspamc learn_spam < msg.eml
docker exec -i rspamd rspamc learn_ham < msg.eml
docker exec -i rspamd rspamc < msg.eml           # score a message
docker exec rspamd rspamadm configtest           # validate config
docker exec rspamd rspamadm configdump           # effective config
docker exec rspamd ls -la /var/lib/rspamd/dkim/  # DKIM keys

# Interactive shell
docker exec -it mysql sh -c 'mysql -u root -p"$(cat /run/secrets/db_root_password)" mailserver'

# One-liner (root password from .env on the host)
source .env
docker exec mysql mysql -u root -p"$DB_ROOT_PASSWORD" mailserver -e "SELECT COUNT(*) FROM domains;"

# Entity counts
docker exec mysql mysql -u root -p"$DB_ROOT_PASSWORD" mailserver -e "
SELECT
  (SELECT COUNT(*) FROM organizations) AS orgs,
  (SELECT COUNT(*) FROM domains) AS domains,
  (SELECT COUNT(*) FROM email_accounts) AS mailboxes,
  (SELECT COUNT(*) FROM aliases) AS aliases,
  (SELECT COUNT(*) FROM smtp_credentials) AS smtp_keys;"

# Delivery outcomes, last 24h (populated by log_ingestor)
docker exec mysql mysql -u root -p"$DB_ROOT_PASSWORD" mailserver -e "
SELECT status, COUNT(*) FROM mail_logs
WHERE timestamp > NOW() - INTERVAL 1 DAY GROUP BY status;"

# Recent bounces
docker exec mysql mysql -u root -p"$DB_ROOT_PASSWORD" mailserver -e "
SELECT sender, recipient, bounce_reason, timestamp
FROM mail_logs WHERE status = 'bounced'
ORDER BY timestamp DESC LIMIT 10;"

# Storage usage by domain
docker exec mysql mysql -u root -p"$DB_ROOT_PASSWORD" mailserver -e "
SELECT domain, total_storage_used, total_email_accounts
FROM domains ORDER BY total_storage_used DESC LIMIT 10;"

# Current schema revision
docker exec mysql mysql -u root -p"$DB_ROOT_PASSWORD" mailserver -e "SELECT * FROM alembic_version;"

docker exec mysql mysqlcheck -u root -p"$DB_ROOT_PASSWORD" mailserver
docker exec mysql mysqldump -u root -p"$DB_ROOT_PASSWORD" --single-transaction mailserver > backup.sql

docker exec -it redis redis-cli
docker exec redis redis-cli info memory
docker exec redis redis-cli --scan --pattern "rspamd_settings:*" | head
docker exec redis redis-cli monitor          # live command stream (verbose!)

docker compose up -d                 # start everything (add --profile console for the console)
docker compose down
docker compose restart postfix
docker compose logs -f postfix
docker compose up -d --build api     # rebuild + restart one service
docker compose run --rm migrate      # apply DB migrations
docker stats --no-stream