Skip to content

canonical/mailserver-operators

Dovecot charm

A Juju charm that deploys and manages Dovecot as an IMAP/POP3 mail server on Ubuntu VMs. Intended for Canonical IS team use.

Like any Juju charm, this charm supports one-line deployment, configuration, integration, scaling, and more. For the Dovecot charm, this includes:

  • Multi-protocol mail server: IMAP, IMAPS, POP3, POP3S, Sieve, and LMTP
  • TLS/SSL encryption with configurable cipher suites
  • Mail filtering with Sieve and Procmail
  • Multi-unit deployments with peer-relation-based mail synchronisation
  • Scheduled mail syncing between primary and secondary units using cron
  • Postfix mail queue management using the clear-queue action

For information about how to deploy, integrate, and manage this charm, see the Dovecot charm documentation.

Get started

See the basic deployment tutorial for a step-by-step walkthrough.

Deploy

juju deploy dovecot-charm \
  --config mailname=mail.example.com \
  --config postmaster-address=postmaster@example.com \
  --config primary-unit=dovecot-charm/0

Basic operations

Clear stuck mail from the Postfix queue:

# Clear only deferred messages (default)
juju run dovecot-charm/0 clear-queue

# Clear all queued messages
juju run dovecot-charm/0 clear-queue queue=all

Adjust the mail sync schedule (default: every 30 minutes):

juju config dovecot-charm sync-schedule="*/15 * * * *"

See charmcraft.yaml for all available configuration options.

Integrations

The charm uses a replicas peer relation to synchronise mail between units in a multi-unit deployment. The primary unit is designated with the primary-unit configuration option.

Learn more

Project and community

License

The Dovecot charm is free software, distributed under the Apache Software License, version 2.0. See LICENSE for more details.

About

monorepo for mail server charms.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors