saltstack-formulas/postfix-formula
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
postfix-formula/docs
History
semantic-release-bot 065f31ac99 chore(release): 2.0.0 [skip ci] 
# [2.0.0](https://github.com/saltstack-formulas/postfix-formula/compare/v1.2.2...v2.0.0) (2021-03-15)

### Bug Fixes

* **resources:** make resources' IDs unique ([03ad48b](03ad48b8a4))

### Continuous Integration

* **commitlint:** ensure `upstream/master` uses main repo URL [skip ci] ([381b150](381b150b0f))
* **gemfile+lock:** use `ssf` customised `kitchen-docker` repo [skip ci] ([c5851e6](c5851e67a2))
* **gitlab-ci:** add `rubocop` linter (with `allow_failure`) [skip ci] ([22fa184](22fa184b14))
* **gitlab-ci:** use GitLab CI as Travis CI replacement ([890f3ae](890f3aebc6))
* **kitchen+ci:** use latest pre-salted images (after CVE) [skip ci] ([19617a0](19617a0ad7))
* **kitchen+gitlab-ci:** use latest pre-salted images [skip ci] ([d65a7a3](d65a7a36c2))
* **pre-commit:** add to formula [skip ci] ([f41392d](f41392d450))
* **pre-commit:** enable/disable `rstcheck` as relevant [skip ci] ([fb5be95](fb5be9504e))
* **pre-commit:** finalise `rstcheck` configuration [skip ci] ([75941ed](75941ed614))
* **pre-commit:** update hook for `rubocop` [skip ci] ([c60d58e](c60d58eb11))

### BREAKING CHANGES

* **resources:** as all resources' IDs changed, other formulas
depending on this formula's resources will need to be modified
accordingly.
2021-03-15 19:55:47 +00:00
..
AUTHORS.rst
chore(release): 2.0.0 [skip ci]
2021-03-15 19:55:47 +00:00
CHANGELOG.rst
chore(release): 2.0.0 [skip ci]
2021-03-15 19:55:47 +00:00
README.rst
fix(deps): fixes ordering where postmap requires sane main.cf
2020-06-07 23:35:20 -03:00

README.rst 

.. _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. Generates mappings.

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