Go to file
Imran Iqbal 75941ed614
ci(pre-commit): finalise `rstcheck` configuration [skip ci]
* Automated using https://github.com/myii/ssf-formula/pull/267
2020-10-10 06:50:51 +01:00
.github/workflows ci(workflows/commitlint): add to repo [skip ci] 2020-05-04 09:31:15 +01:00
bin ci(pre-commit): add to formula [skip ci] 2020-10-03 10:52:04 +01:00
docs chore(release): 1.2.2 [skip ci] 2020-10-02 19:47:45 +00:00
postfix style: prepend modes with 0 2020-10-02 14:09:13 -04:00
test style: linting for `yamllint` 2020-09-27 14:50:48 +01:00
.gitignore ci(gemfile.lock): add to repo with updated `Gemfile` [skip ci] 2020-04-21 22:09:27 +01:00
.pre-commit-config.yaml ci(pre-commit): finalise `rstcheck` configuration [skip ci] 2020-10-10 06:50:51 +01:00
.rstcheck.cfg ci(pre-commit): add to formula [skip ci] 2020-10-03 10:52:04 +01:00
.rubocop.yml chore(rubocop): use org-wide standard settings for `Metrics/BlockLength` [skip ci] 2020-04-18 13:45:40 +01:00
.salt-lint ci(travis): update `salt-lint` config for `v0.0.10` [skip ci] 2019-10-23 17:37:04 +01:00
.travis.yml ci(pre-commit): add to formula [skip ci] 2020-10-03 10:52:04 +01:00
.yamllint ci: merge travis matrix, add `salt-lint` & `rubocop` to `lint` job 2019-10-08 16:39:24 +01:00
AUTHORS.md chore(release): 1.2.2 [skip ci] 2020-10-02 19:47:45 +00:00
CHANGELOG.md chore(release): 1.2.2 [skip ci] 2020-10-02 19:47:45 +00:00
CODEOWNERS ci(pre-commit): enable/disable `rstcheck` as relevant [skip ci] 2020-10-05 00:23:24 +01:00
FORMULA chore(release): 1.2.2 [skip ci] 2020-10-02 19:47:45 +00:00
Gemfile chore(gemfile+lock): update to latest gem versions (2020-W41) [skip ci] 2020-10-07 00:07:14 +01:00
Gemfile.lock chore(gemfile+lock): update to latest gem versions (2020-W41) [skip ci] 2020-10-07 00:07:14 +01:00
LICENSE remove extra new line characters 2015-05-07 13:45:46 -04:00
commitlint.config.js chore(commitlint): add `{body,footer,header}-max(-line)-length` [skip ci] 2020-10-07 09:08:55 +01:00
kitchen.yml ci(kitchen): use `saltimages` Docker Hub where available [skip ci] 2020-06-15 16:58:31 +01:00
pillar.example refactor(maps): move tls_policy and transport to mapping section 2020-06-06 19:17:46 -03:00
pre-commit_semantic-release.sh ci(travis): run `shellcheck` during lint job [skip ci] 2019-11-27 21:02:31 +00:00
release-rules.js feat(semantic-release): implement an automated changelog 2019-06-02 20:38:14 +02:00
release.config.js fix(release.config.js): use full commit hash in commit link [skip ci] 2019-10-31 10:34:19 +00:00

docs/README.rst

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