Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/markt-de/puppet-postfix

Puppet module to configure Postfix with multi instance support
https://github.com/markt-de/puppet-postfix

postfix puppet

Last synced: 7 days ago
JSON representation

Puppet module to configure Postfix with multi instance support

Awesome Lists containing this project

README 

        
# puppet-postfix



[![Build Status](https://github.com/markt-de/puppet-postfix/actions/workflows/ci.yaml/badge.svg)](https://github.com/markt-de/puppet-postfix/actions/workflows/ci.yaml)

[![Puppet Forge](https://img.shields.io/puppetforge/v/markt/postfix.svg)](https://forge.puppetlabs.com/markt/postfix)

[![Puppet Forge](https://img.shields.io/puppetforge/dt/markt/postfix.svg)](https://forge.puppetlabs.com/markt/postfix)



#### Table of Contents



1. [Description](#description)

1. [Usage](#usage)

    * [Types](#types)

1. [Reference](#reference)

1. [Limitations](#limitations)

1. [Development](#development)

    - [Contributing](#contributing)



## Description



An extremely flexible Puppet module to manage Postfix installation. Manage main.cf settings and master.cf entries by postconf backed native types. Both types include support for multiple Postfix instances. The Postfix instances can be managed with a native type too.



## Usage



The easiest way to use this module is to specify all desired configuration in Hiera.

Here is a close-to-real-life example:



```yaml

postfix::main_config:

  alias_database: hash:/etc/aliases

  alias_maps: hash:/etc/aliases

  append_dot_mydomain: no

  biff: no

  inet_protocols: all

  inet_interfaces: all

  mydestination: '$myhostname, localdomain, localhost'

  myorigin: '$mydomain'

  mynetworks:

    - '10.40.0.0/24'

    - '127.0.0.0/8'

    - '[::ffff:127.0.0.0]/104'

    - '[::1]/128'

  readme_directory: no

  recipient_delimiter: +

  smtpd_banner: '$myhostname ESMTP $mail_name'

  smtpd_relay_restrictions:

    - permit_mynetworks

    - permit_sasl_authenticated

    - defer_unauth_destination

  smtpd_use_tls: yes

  smtpd_tls_cert_file: &postfix_cert /etc/postfix/ssl/postfix.crt

  smtpd_tls_key_file: &postfix_key /etc/postfix/ssl/postfix.key

  smtpd_sasl_auth_enable: no # only enable for mandatory tls ports

  smtpd_sasl_type: dovecot

  smtpd_sasl_path: private/auth

  # sasl only encrypted

  smtpd_tls_auth_only: yes

  smtpd_tls_security_level: may

  virtual_transport: 'lmtp:unix:private/dovecot-lmtp'

  milter_protocol: 6

  common_milters: >-

    { inet:localhost:11332,

    connect_timeout=10s,

    default_action=accept }

  smtpd_milters: '$common_milters'

  non_smtpd_milters: '$common_milters'

  milter_mail_macros: i {mail_addr} {client_addr} {client_name} {auth_authen}



postfix::master_services:

  # merged with the defaults defined in data/modules/postfix.yaml

  smtps/inet: { ensure: present }

  submission/inet: { ensure: present }

```



This will create `postconf` and `postconf_master` resources for each setting.

The resource types can also be used directly as described below.



### Generating default master.cf entries



In order to generate the default `postconf_master` hiera entries needed to run postfix,

you can use the provided master2hierayaml.rb script:



```sh

scripts/master2hierayaml.rb /usr/share/doc/postfix/defaults/master.cf > data/modules/postfix.yaml

```



It will try to parse active as well as commented entries and lines, and output warnings

to stderr if it fails to do so. However, check the output carefully, otherwise you might

end up with a non-working mail system.



### Purging unmanaged entries



By default, this module will warn about unmanaged config entries in any managed `main.cf`

and `master.cf`, but not remove them. To enable purging of those resources, set purge_main

and purge_master to true:



```yaml

postfix::purge_main: true

postfix::purge_master: true

```



### Types



The `postconf` type enables you to set or rest postconf parameters.



```puppet

  postconf { 'myhostname':

    value => 'foo.bar',

  }

```



The `postmulti` type allows you to create, de/activate and destroy postfix

postmulti instances with pupppet.



By default `ensure` is set to `active` but can be set to `inactive` or `absent`

respectively to deactivate or remove an postmulti instance.



When using postmulti the resource name must begin with `postfix-`:



```puppet

  postmulti { 'postfix-foo': }

```



Using the `::` syntax in resource titles allows you to manage different postfix instances.

In the following example the `foo::myhostname` postconf resource would internally

set the Postfix configuration directory to `/etc/postfix-foo` and configure the parameter

in this instance.



```puppet

  postconf { 'foo::myhostname':

    parameter => 'myhostname',

    value     => 'foo.bar',

  }

```



The `postconf_master` type enables you to manage the master.cf entries.



```puppet

  postconf_master { 'mytransport/unix':

    command => 'smtp',

  }

```



The `service` and `type` params allow you to define the postconf_master service/type independently from

the resource name. Using the `::` syntax in resource titles again allows you to manage different postfix instances.



```puppet

  postconf_master { 'mytransport/unix':

    command => 'smtp',

  }



  postconf_master { 'foo::mytransport/unix':

    service    => 'mytransport',

    type       => 'unix',

    command    => 'smtp',

  }

```



## Reference



Classes and parameters are documented in [REFERENCE.md](REFERENCE.md).



## Limitations



The postfix version of RHEL7 does not support postconf_master. An alternative version is available from the [IUS Community Project](https://ius.io/).



## Development



### Contributing



Please use the GitHub issues functionality to report any bugs or requests for new features. Feel free to fork and submit pull requests for potential contributions.