https://github.com/saltstack-formulas/postfix-formula
https://github.com/saltstack-formulas/postfix-formula
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/saltstack-formulas/postfix-formula
- Owner: saltstack-formulas
- License: other
- Created: 2013-06-12T22:16:29.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T23:10:08.000Z (about 1 year ago)
- Last Synced: 2025-03-28T15:04:55.275Z (11 months ago)
- Language: Ruby
- Homepage: http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html
- Size: 428 KB
- Stars: 26
- Watchers: 38
- Forks: 128
- Open Issues: 9
-
Metadata Files:
- Readme: docs/README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Authors: AUTHORS.md
Awesome Lists containing this project
README
.. _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
`_.
If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
`_.
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 `_.
See `Formula Versioning Section `_ for more details.
Contributing to this repo
-------------------------
**Commit message formatting is significant!!**
Please see `How to contribute `_ 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.