Go to file
Imran Iqbal 3284d38a36
ci(3003.1): update inc. AlmaLinux, Rocky & `rst-lint` [skip ci]
* Automated using https://github.com/myii/ssf-formula/pull/335
2021-07-02 00:06:24 +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): 2.0.0 [skip ci] 2021-03-15 19:55:47 +00:00
postfix test: standardise use of `share` suite & `_mapdata` state [skip ci] 2021-03-23 21:31:53 +00:00
test ci(3003.1): update inc. AlmaLinux, Rocky & `rst-lint` [skip ci] 2021-07-02 00:06:24 +01:00
.gitignore chore: standardise structure (`.gitignore` & `_mapdata.rb`) [skip ci] 2021-02-11 11:52:30 +00:00
.gitlab-ci.yml ci(3003.1): update inc. AlmaLinux, Rocky & `rst-lint` [skip ci] 2021-07-02 00:06:24 +01:00
.pre-commit-config.yaml ci(3003.1): update inc. AlmaLinux, Rocky & `rst-lint` [skip ci] 2021-07-02 00:06:24 +01:00
.rstcheck.cfg chore(pre-commit): use `info` report level for `rstcheck` [skip ci] 2021-05-20 14:09:42 +01:00
.rubocop.yml test: standardise use of `share` suite & `_mapdata` state [skip ci] 2021-03-23 21:31:53 +00: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(3003.1): update inc. AlmaLinux, Rocky & `rst-lint` [skip ci] 2021-07-02 00:06:24 +01:00
.yamllint chore: update `CODEOWNERS` & `.yamllint` re: `kitchen-vagrant` [skip ci] 2021-04-05 18:20:57 +01:00
AUTHORS.md chore(release): 2.0.0 [skip ci] 2021-03-15 19:55:47 +00:00
CHANGELOG.md chore(release): 2.0.0 [skip ci] 2021-03-15 19:55:47 +00:00
CODEOWNERS chore: update `CODEOWNERS` & `.yamllint` re: `kitchen-vagrant` [skip ci] 2021-04-05 18:20:57 +01:00
FORMULA chore(release): 2.0.0 [skip ci] 2021-03-15 19:55:47 +00:00
Gemfile test: standardise use of `share` suite & `_mapdata` state [skip ci] 2021-03-23 21:31:53 +00:00
Gemfile.lock ci(3003.1): update inc. AlmaLinux, Rocky & `rst-lint` [skip ci] 2021-07-02 00:06:24 +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(3003.1): update inc. AlmaLinux, Rocky & `rst-lint` [skip ci] 2021-07-02 00:06:24 +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(gitlab-ci): use GitLab CI as Travis CI replacement 2020-12-16 06:38:25 +00:00
release-rules.js feat(semantic-release): implement an automated changelog 2019-06-02 20:38:14 +02:00
release.config.js ci(gitlab-ci): use GitLab CI as Travis CI replacement 2020-12-16 06:38:25 +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.