postfix-formula/docs
2019-10-14 11:37:46 +01:00
..
AUTHORS.rst chore(release): 0.18.1 [skip ci] 2019-10-11 21:25:43 +00:00
CHANGELOG.rst chore(release): 0.18.1 [skip ci] 2019-10-11 21:25:43 +00:00
CONTRIBUTING.rst feat(semantic-release): implement an automated changelog 2019-06-02 20:38:14 +02:00
README.rst docs(readme): update link to CONTRIBUTING [skip ci] 2019-10-14 11:37:46 +01:00

postfix-formula

Travis CI Build Status Semantic Release

A SaltStack formula to install and configure Postfix mail server.

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

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