Puppet Class: dovecot

Defined in:
manifests/init.pp

Overview

Class: dovecot

Install, enable and configure the Dovecot IMAP server. Options:

$plugins:
  Array of plugin sub-packages to install. Default: empty

Parameters:

  • plugins (Any) (defaults to: [])
  • protocols (Any) (defaults to: undef)
  • listen (Any) (defaults to: undef)
  • login_greeting (Any) (defaults to: undef)
  • login_trusted_networks (Any) (defaults to: undef)
  • verbose_proctitle (Any) (defaults to: undef)
  • shutdown_clients (Any) (defaults to: undef)
  • disable_plaintext_auth (Any) (defaults to: undef)
  • auth_username_chars (Any) (defaults to: undef)
  • auth_mechanisms (Any) (defaults to: 'plain')
  • auth_include (Any) (defaults to: [ 'system' ])
  • log_path (Any) (defaults to: undef)
  • auth_verbose (Any) (defaults to: undef)
  • auth_debug (Any) (defaults to: undef)
  • mail_debug (Any) (defaults to: undef)
  • mail_location (Any) (defaults to: undef)
  • default_process_limit (Any) (defaults to: undef)
  • default_client_limit (Any) (defaults to: undef)
  • auth_listener_userdb_mode (Any) (defaults to: undef)
  • auth_listener_userdb_user (Any) (defaults to: undef)
  • auth_listener_userdb_group (Any) (defaults to: undef)
  • auth_listener_postfix (Any) (defaults to: false)
  • ssl (Any) (defaults to: undef)
  • ssl_cert (Any) (defaults to: '/etc/pki/dovecot/certs/dovecot.pem')
  • ssl_key (Any) (defaults to: '/etc/pki/dovecot/private/dovecot.pem')
  • ssl_cipher_list (Any) (defaults to: undef)
  • postmaster_address (Any) (defaults to: undef)
  • hostname (Any) (defaults to: undef)
  • lda_mail_plugins (Any) (defaults to: undef)
  • sieve (Any) (defaults to: '~/.dovecot.sieve')
  • sieve_dir (Any) (defaults to: '~/sieve')
  • auth_sql_userdb_static (Any) (defaults to: undef) 


8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'manifests/init.pp', line 8

class dovecot (
    $plugins                    = [],
    # dovecot.conf
    $protocols                  = undef,
    $listen                     = undef,
    $login_greeting             = undef,
    $login_trusted_networks     = undef,
    $verbose_proctitle          = undef,
    $shutdown_clients           = undef,
    # 10-auth.conf
    $disable_plaintext_auth     = undef,
    $auth_username_chars        = undef,
    $auth_mechanisms            = 'plain',
    $auth_include               = [ 'system' ],
    # 10-logging.conf
    $log_path                   = undef,
    $auth_verbose               = undef,
    $auth_debug                 = undef,
    $mail_debug                 = undef,
    # 10-mail.conf
    $mail_location              = undef,
    # 10-master.conf
    $default_process_limit      = undef,
    $default_client_limit       = undef,
    $auth_listener_userdb_mode  = undef,
    $auth_listener_userdb_user  = undef,
    $auth_listener_userdb_group = undef,
    $auth_listener_postfix      = false,
    # 10-ssl.conf
    $ssl                        = undef,
    $ssl_cert                   = '/etc/pki/dovecot/certs/dovecot.pem',
    $ssl_key                    = '/etc/pki/dovecot/private/dovecot.pem',
    $ssl_cipher_list            = undef,
    # 15-lda.conf
    $postmaster_address         = undef,
    $hostname                   = undef,
    $lda_mail_plugins           = undef,
    # 90-sieve.conf
    $sieve                      = '~/.dovecot.sieve',
    $sieve_dir                  = '~/sieve',
    # auth-sql.conf.ext
    $auth_sql_userdb_static     = undef

) {

    # All files in this scope are dovecot configuration files
    File {
        notify  => Service['dovecot'],
        require => Package['dovecot'],
    }

    # Install plugins (sub-packages)
    dovecot::plugin { $plugins: before => Package['dovecot'] }

    # Main package and service it provides
    package { 'dovecot': ensure => installed }
    service { 'dovecot':
        enable    => true,
        ensure    => running,
        hasstatus => true,
        require   => File['/etc/dovecot/dovecot.conf'],
    }

    # Main configuration file
    file { '/etc/dovecot/dovecot.conf':
        content => template('dovecot/dovecot.conf.erb'),
    }

    # Configuration file snippets which we modify
    file { '/etc/dovecot/conf.d/10-auth.conf':
        content => template('dovecot/conf.d/10-auth.conf.erb'),
    }
    file { '/etc/dovecot/conf.d/10-logging.conf':
        content => template('dovecot/conf.d/10-logging.conf.erb'),
    }
    file { '/etc/dovecot/conf.d/10-mail.conf':
        content => template('dovecot/conf.d/10-mail.conf.erb'),
    }
    file { '/etc/dovecot/conf.d/10-master.conf':
        content => template('dovecot/conf.d/10-master.conf.erb'),
    }
    file { '/etc/dovecot/conf.d/10-ssl.conf':
        content => template('dovecot/conf.d/10-ssl.conf.erb'),
    }
    file { '/etc/dovecot/conf.d/15-lda.conf':
        content => template('dovecot/conf.d/15-lda.conf.erb'),
    }
    file { '/etc/dovecot/conf.d/90-sieve.conf':
        content => template('dovecot/conf.d/90-sieve.conf.erb'),
    }
    file { '/etc/dovecot/conf.d/auth-sql.conf.ext':
        content => template('dovecot/conf.d/auth-sql.conf.ext.erb'),
    }

}