Dovecot

Table of Contents

1. Description
2. Setup - The basics of getting started with BashRC
   • What dovecot module affects
   • Setup requirements
   • Beginning with dovecot
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Description

This module works under RedHat, CentOS 6+, Ubuntu 12+ and FreeBSD. This module configures a Dovecot server (2.x and later)

It is a fork from mxHero

Setup

What Dovecot module affects

• Modify the files linked to dovecot (usually in /etc/dovecot) using the conf.d structure adopted by Dovecot 2.x.
• Install all the packages linked to Dovecot IMAP server.
• This module make also working managesieve.

Beginning with Dovecot

A basic example is as follows:

  include ::dovecot

Usage

• dovecot : Main class
• dovecot::file : Definition to manage configuration file snippets
• dovecot::plugin : Definition to install plugin sub-packages

This module is fully Hiera compliant : you can define your module data only in Hiera.

Example Configuration

class { 'dovecot':
    version                    => 2,
    plugins                    => [ 'mysql', 'pigeonhole' ],
    protocols                  => 'imap pop3 sieve',
    verbose_proctitle          => 'yes',
    auth_include               => 'sql',
    mail_location              => 'maildir:~/Maildir',
    auth_listener_userdb_mode  => '0660',
    auth_listener_userdb_group => 'vmail',
    auth_listener_postfix      => true,
    ssl_cert                   => '/etc/pki/tls/certs/wildcard.example.com.crt',
    ssl_key                    => '/etc/pki/tls/private/wildcard.example.com.key',
    postmaster_address         => 'postmaster@example.com',
    hostname                   => 'mail.example.com',
    lda_mail_plugins           => '$mail_plugins sieve',
    auth_sql_userdb_static     => 'uid=vmail gid=vmail home=/home/vmail/%d/%n',
    log_timestamp              => '"%Y-%m-%d %H:%M:%S "',
}

dovecot::file { 'dovecot-sql.conf.ext':
    source => 'puppet:///modules/example/dovecot-sql.conf.ext',
}

Limitations

This module has only been tested on my Debian and CentOS servers. I can not guarantee for any other Operating System Please note the parameter "version" is used to adapt confriguration files to the major version of Dovecot

Development

I chose to open my own Dovecot Module ; but you are free to contribute on it, etc.

Release Notes/Contributors/Etc.

It is a fork from mxHero Thanks to every contributors (Coreone in particular)

2012-09-18 - 0.0.1

• Clean up the dovecot module, update everything for dovecot 2.x.

2017-05-23 - 0.0.4

• Add auth_username_format config variable (10-auth.conf)
• Add validate_string for auth_username_format
• Remove duplicate lines (10-logging.conf, mail_log_group_events)
• Add more log path settings (10-logging.conf)
• Add custom_namespaces (10-mail.conf)
• Fix newline issues with first_valid_uid and last_valid_uid (10-mail.conf)
• Allow no listen settings in imap protocol section (Obsolete in newer versions) (20-imap.conf)
• Fix default value for lmtp_save_to_detail_mailbox (20-lmtp.conf)
• Add sieve_global_dir setting (90-sieve.conf)
• Change default for ports to "-1". In newer versions of Dovecot, "0" means to not listen on that port for that service (init.pp)
• Alignment and spacing fixes where necessary
• Make dovecot-ldap.conf.ext useable as a template through dovecot::file