You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Imran Iqbal c0485fb345
chore(gemfile+lock): update to latest gem versions (2020-W44) [skip ci]
1 month ago
.github/workflows ci(workflows/commitlint): add to repo [skip ci] 7 months ago
bin ci(pre-commit): add to formula [skip ci] 1 month ago
docs chore(release): 1.2.2 [skip ci] 1 month ago
postfix style: prepend modes with 0 1 month ago
test style: linting for `yamllint` 2 months ago
.gitignore ci(gemfile.lock): add to repo with updated `Gemfile` [skip ci] 7 months ago
.pre-commit-config.yaml ci(pre-commit): finalise `rstcheck` configuration [skip ci] 1 month ago
.rstcheck.cfg ci(pre-commit): add to formula [skip ci] 1 month ago
.rubocop.yml chore(rubocop): use org-wide standard settings for `Metrics/BlockLength` [skip ci] 7 months ago
.salt-lint ci(travis): update `salt-lint` config for `v0.0.10` [skip ci] 1 year ago
.travis.yml ci(pre-commit): add to formula [skip ci] 1 month ago
.yamllint ci: merge travis matrix, add `salt-lint` & `rubocop` to `lint` job 1 year ago
AUTHORS.md chore(release): 1.2.2 [skip ci] 1 month ago
CHANGELOG.md chore(release): 1.2.2 [skip ci] 1 month ago
CODEOWNERS ci(pre-commit): enable/disable `rstcheck` as relevant [skip ci] 1 month ago
FORMULA chore(release): 1.2.2 [skip ci] 1 month ago
Gemfile chore(gemfile+lock): update to latest gem versions (2020-W44) [skip ci] 1 month ago
Gemfile.lock chore(gemfile+lock): update to latest gem versions (2020-W44) [skip ci] 1 month ago
LICENSE remove extra new line characters 5 years ago
commitlint.config.js chore(commitlint): add `{body,footer,header}-max(-line)-length` [skip ci] 1 month ago
kitchen.yml ci(kitchen): use `saltimages` Docker Hub where available [skip ci] 5 months ago
pillar.example refactor(maps): move tls_policy and transport to mapping section 5 months ago
pre-commit_semantic-release.sh ci(travis): run `shellcheck` during lint job [skip ci] 1 year ago
release-rules.js feat(semantic-release): implement an automated changelog 1 year ago
release.config.js fix(release.config.js): use full commit hash in commit link [skip ci] 1 year ago

docs/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.