semantic-release-bot f128f6db79 chore(release): 1.0.0 [skip ci]
# [1.0.0](https://github.com/saltstack-formulas/postfix-formula/compare/v0.19.0...v1.0.0) (2020-06-06)

### Code Refactoring

* **maps:** move tls_policy and transport to mapping section ([06276fd](06276fd743))

### Continuous Integration

* **kitchen+travis:** use latest pre-salted images ([b364744](b364744e40))

### BREAKING CHANGES

* **maps:** `transport` and `tls_policy` keys in `postfix:config` have been moved to the standard `postfix:mapping`.
2020-06-06 22:33:23 +00:00
2020-06-06 22:33:23 +00:00
2020-06-06 22:33:23 +00:00
2020-06-06 22:33:23 +00:00
2020-06-06 22:33:23 +00:00
2015-05-07 13:45:46 -04:00

.. _readme:

postfix-formula
===============

|img_travis| |img_sr|

.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/postfix-formula.svg?branch=master
   :alt: Travis CI Build Status
   :scale: 100%
   :target: https://travis-ci.com/saltstack-formulas/postfix-formula
.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
   :alt: Semantic Release
   :scale: 100%
   :target: https://github.com/semantic-release/semantic-release

A SaltStack formula to install and configure Postfix mail server.

.. contents:: **Table of Contents**

General notes
-------------

See the full `SaltStack Formulas installation and usage instructions
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.

If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas>`_.

If you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,
which contains the currently released version. This formula is versioned according to `Semantic Versioning <http://semver.org/>`_.

See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.

Contributing to this repo
-------------------------

**Commit message formatting is significant!!**

Please see `How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>`_ for more details.

Available states
----------------

.. contents::
   :local:

``postfix``
^^^^^^^^^^^

Installs and starts postfix SMTP server

``postfix.config``
^^^^^^^^^^^^^^^^^^

Manages postfix main.cf and optionally the master.cf configuration file

``postfix.policyd-spf``
^^^^^^^^^^^^^^^^^^^^^^^

Installs and configures policyd-spf

``postfix.postgrey``
^^^^^^^^^^^^^^^^^^^^

Installs and starts Postgrey service

``postfix.mysql``
^^^^^^^^^^^^^^^^^

Installs postfix mysql package ( Debian only)

``postfix.pcre``
^^^^^^^^^^^^^^^^

Installs postfix pcre package ( Debian only)

``postfix.postsrsd``
^^^^^^^^^^^^^^^^^^^^

Installs postfix postsrsd package


Testing
-------

Linux testing is done with ``kitchen-salt``.

Requirements
^^^^^^^^^^^^

* Ruby
* Docker

.. code-block:: bash

   $ gem install bundler
   $ bundle install
   $ bin/kitchen test [platform]

Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
e.g. ``debian-9-2019-2-py3``.

``bin/kitchen converge``
^^^^^^^^^^^^^^^^^^^^^^^^

Creates the docker instance and runs the main state(s), ready for testing.

``bin/kitchen verify``
^^^^^^^^^^^^^^^^^^^^^^

Runs the ``inspec`` tests on the actual instance.

``bin/kitchen destroy``
^^^^^^^^^^^^^^^^^^^^^^^

Removes the docker instance.

``bin/kitchen test``
^^^^^^^^^^^^^^^^^^^^

Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.

``bin/kitchen login``
^^^^^^^^^^^^^^^^^^^^^

Gives you SSH access to the instance for manual testing.

Description
Languages
Ruby 37%
SaltStack 36.2%
JavaScript 16.3%
Jinja 5.6%
Shell 4.9%