ssmtp

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with ssmtp
   • What ssmtp affects
   • Setup requirements
   • Beginning with ssmtp
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

Overview

The ssmtp module provides the installation procedure for SSMTP including the setup of the alternate system if not overwritten by class parameter.

Module Description

The SSMTP module prelace the standard mail server configuration with a light wight sending only server. The behavior is the same as sendmail but without the possibility to recieve mails from external systems.

Setup

What ssmtp affects

• ssmtp package.
• ssmtp configuration file.
• ssmtp alternative service configuration.

Setup requirements

You need to activate the EPEL repository before you can setup the SSMTP instance. If you use a rpm based system from the RedHat family you can use my yum module (thbe-yum):

class { "::yum": repo_epel => true }

Beginning with ssmtp

include '::ssmtp' is enough to get you up and running if the parameters point to proper values. If you wish to pass in parameters like which servers to use then you can use:

class { '::ssmtp':
  mail_hub => 'mail.example.local',
}

Usage

All interaction with the ssmtp module can do be done through the main ssmtp class. This means you can simply toggle the options in the ssmtp class to get at the full functionality.

I just want SSMTP, what's the minimum I need?

include '::ssmtp'

I just want to route all mails to central mail gateway, nothing else.

class { '::ssmtp':
  mail_hub => 'mail.example.local',
  root_email => '[email protected]',
}

Reference

See https://github.com/thbe/puppet-ssmtp/blob/master/REFERENCE.md

Limitations

This module has been built on and tested against Puppet 5 and higher.

The module has been tested on:

• CentOS 7
• Debian 9
• Ubuntu 18.04

Testing on other platforms has been light and cannot be guaranteed.

Development

If you like to add or improve this module, feel free to fork the module and send me a merge request with the modification.

Contributors

The list of contributors can be found at: https://github.com/thbe/puppet-ssmtp/graphs/contributors