Forge Home


Configure Dovecot


6,466 latest version

4.3 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.0.6 (latest)
  • 0.0.5
  • 0.0.4
  • 0.0.3
released Jun 4th 2017
This version is compatible with:
  • Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.0.0 < 5.0.0
  • , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'lvicainne-dovecot', '0.0.6'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add lvicainne-dovecot
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install lvicainne-dovecot --version 0.0.6

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Tags: dovecot, mail, imap, pop, pop3


lvicainne/dovecot — version 0.0.6 Jun 4th 2017


Build Status

Table of Contents

  1. Description
  2. Setup - The basics of getting started with BashRC
  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


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


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


  • 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/',
    ssl_key                    => '/etc/pki/tls/private/',
    postmaster_address         => '',
    hostname                   => '',
    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',


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


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)