saltstack-formulas/postfix-formula
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
postfix-formula/docs
History
semantic-release-bot 51b269e2c3 chore(release): 0.18.2 [skip ci] 
## [0.18.2](https://github.com/saltstack-formulas/postfix-formula/compare/v0.18.1...v0.18.2) (2020-05-12)

### Bug Fixes

* make necessary modifications to get working on `salt-ssh` ([34a112f](34a112faab)), closes [/freenode.logbot.info/saltstack-formulas/20200507#c3819526-c3819581](https://github.com//freenode.logbot.info/saltstack-formulas/20200507/issues/c3819526-c3819581) [/freenode.logbot.info/saltstack-formulas/20200508#c3826763-c3826995](https://github.com//freenode.logbot.info/saltstack-formulas/20200508/issues/c3826763-c3826995)
* **release.config.js:** use full commit hash in commit link [skip ci] ([ffbe5aa](ffbe5aad13))

### Continuous Integration

* **gemfile:** restrict `train` gem version until upstream fix [skip ci] ([80cdd9d](80cdd9d202))
* **gemfile.lock:** add to repo with updated `Gemfile` [skip ci] ([497221d](497221d1de))
* **kitchen:** avoid using bootstrap for `master` instances [skip ci] ([708b0a5](708b0a51d9))
* **kitchen:** use `debian-10-master-py3` instead of `develop` [skip ci] ([90098c0](90098c0cdf))
* **kitchen:** use `develop` image until `master` is ready (`amazonlinux`) [skip ci] ([df76c72](df76c72dce))
* **kitchen+travis:** remove `master-py2-arch-base-latest` [skip ci] ([46d0f3d](46d0f3d1d8))
* **kitchen+travis:** upgrade matrix after `2019.2.2` release [skip ci] ([70fc491](70fc49122e))
* **travis:** apply changes from build config validation [skip ci] ([f25db2d](f25db2d5f3))
* **travis:** opt-in to `dpl v2` to complete build config validation [skip ci] ([8f4db70](8f4db70ece))
* **travis:** quote pathspecs used with `git ls-files` [skip ci] ([6d18d1d](6d18d1dc93))
* **travis:** run `shellcheck` during lint job [skip ci] ([29efb81](29efb819fc))
* **travis:** update `salt-lint` config for `v0.0.10` [skip ci] ([b23168e](b23168e69e))
* **travis:** use `major.minor` for `semantic-release` version [skip ci] ([964e3ef](964e3ef0fa))
* **travis:** use build config validation (beta) [skip ci] ([1ab8692](1ab8692f31))
* **workflows/commitlint:** add to repo [skip ci] ([43a7353](43a7353cae))

### Documentation

* **contributing:** remove to use org-level file instead [skip ci] ([a33757a](a33757a6ad))
* **readme:** update link to `CONTRIBUTING` [skip ci] ([50b9808](50b9808a3b))

### Performance Improvements

* **travis:** improve `salt-lint` invocation [skip ci] ([2ece69c](2ece69c3c1))
2020-05-12 13:48:06 +00:00
..
AUTHORS.rst
chore(release): 0.18.2 [skip ci]
2020-05-12 13:48:06 +00:00
CHANGELOG.rst
chore(release): 0.18.2 [skip ci]
2020-05-12 13:48:06 +00:00
README.rst
docs(readme): update link to CONTRIBUTING [skip ci]
2019-10-14 11:37:46 +01: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

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