Forge Home

dovecot

dovecot installation and IMAP basic setup

28,842 downloads

15,837 latest version

5.0 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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.1.12 (latest)
  • 0.1.10
  • 0.1.9
  • 0.1.8
  • 0.1.3
  • 0.1.2
  • 0.1.0
released Jul 2nd 2018
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 3.8.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'eyp-dovecot', '0.1.12'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install eyp-dovecot --version 0.1.12

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.

Download

Documentation

eyp/dovecot — version 0.1.12 Jul 2nd 2018

dovecot

Table of Contents

  1. Overview
  2. Module Description
  3. Setup
  4. Usage
  5. Reference
  6. Limitations
  7. Development

Overview

basic dovecot installation

Module Description

This module is intended to be used by eyp-postfix to setup a virtual domains for postfix using SASL authentication. Anyway, it can also be used to configure dovecot as a standalone service but eyp-postfix is a dependency

Setup

What dovecot affects

  • package management
  • service management
  • configuration management:
    • general config file: /etc/dovecot/dovecot.conf
    • local usernames (default: /etc/dovecot/passwd)

Setup Requirements

This module requires pluginsync enabled.

dovecot::mail_location is a prerequisite to be able to deploy dovecot

Beginning with dovecot

basic setup (dovecot with SASL authentication using a file to store passwords):

class { 'dovecot': }
class { 'dovecot::userdb': }
class { 'dovecot::passdb': }
class { 'dovecot::auth': }
class { 'dovecot::auth::unixlistener': }
class { 'dovecot::imaplogin': }

dovecot::account { 'demo@demo.systemadmin.es':
  password => 'demopassw0rd',
}

Usage

Right now does not support may options, it's intended to be in a small MTA server (for example, does not support LDAP auth)

Reference

classes

dovecot

docvecot installation and basic configuration:

  • manage_package: = true,
  • package_ensure: = 'installed',
  • manage_service: = true,
  • manage_docker_service: = true,
  • service_ensure: = 'running',
  • service_enable: = true,
  • listen: = [ * ],
  • login_greeting: = 'ready to rock',
  • verbose_proctitle: = true,
  • shutdown_clients: = true,
  • protocols: = [ 'imap', 'lmtp' ],
  • disable_plaintext_auth: = false,
  • auth_mechanisms: = [ 'plain', 'login' ],
  • mail_access_groups: = 'postfix',
  • default_login_user: = 'postfix',
  • first_valid_uid: = $dovecot::params::postfix_username_uid_default,
  • first_valid_gid: = $dovecot::params::postfix_username_gid_default,
  • mail_location: = 'maildir:/var/vmail/%d/%n',
  • ssl: = false,
  • base_dir: = '/var/run/dovecot/',
  • imap_idle_notify_interval_minutes: = '2',

dovecot::auth

service auth:

  • user: (default: root)

dovecot::auth::unixlistener

  • user: = $dovecot::default_login_user,
  • group: = $dovecot::mail_access_groups,
  • mode: = '0660',
  • socket: = 'auth-client',

dovecot::imaplogin

  • process_min_avail: = $::processorcount,
  • user: = $dovecot::default_login_user,

dovecot::passdb

  • driver: = 'passwd-file',
  • scheme: = 'SHA1',
  • passwdfile: = $dovecot::params::passwdfile_default,

dovecot::userdb

  • driver: = 'static',
  • uid: = $dovecot::params::postfix_username_uid_default,
  • gid: = $dovecot::params::postfix_username_gid_default,
  • home: = '/var/vmail/%d/%n',
  • allow_all_users: = true,

defines

dovecot::account

  • password:,
  • account: = $name,
  • passwdfile: = $dovecot::params::passwdfile_default,
  • password_scheme: = 'sha1',

Limitations

Tested on:

  • CentOS 6
  • CentOS 7
  • Ubuntu 14.04
  • Ubuntu 16.04

Development

We are pushing to have acceptance testing in place, so any new feature should have some test to check both presence and absence of any feature

TODO

  • lots of dovecot functionalities still needs to be implemented in this module

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request