Skip to content

saltstack-formulas/rspamd-formula

Repository files navigation

rspamd-formula

Travis CI Build Status Semantic Release

A SaltStack formula to install and configure rspamd.

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.

If you need (non-default) configuration, please pay attention to the pillar.example file and/or Special notes section.

Commit messages

Commit message formatting is significant!!

Please see How to contribute for more details.

None.

Installs the rspamd package, configures it and starts the associated rspamd service.

Installs the rspamd package.

Configures the rspamd package.

Creates and configures the DKIM signing keys for rspamd. See the pillar.example for examples of how to use it.

Manages the rspamd service.

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 rspamd main state, 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.