Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

postfix_gmail

This module configures postfix to use GMail as a relayhost.
Project URLRSS FeedReport issues

6,247 downloads

6,247 latest version

1.9 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.1.0 (latest)
released May 6th 2017

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'cmiersma-postfix_gmail', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add cmiersma-postfix_gmail
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install cmiersma-postfix_gmail --version 0.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

cmiersma/postfix_gmail — version 0.1.0 May 6th 2017

postfix_gmail

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 postfix_gmail
  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 configures postfix to use Gmail as a relay

Module Description

This module ensures that postfix is installed and running. It also adds cyrus sasl packages to handle encryption to Google. The config file sets up the authentication and rate limiting.

Setup

What postfix affects

  • postfix and related packages.
  • /etc/postfix/main.cf

Setup Requirements

Nothing special.

Beginning with postfix

  • Make sure postfix actually is your MTA of choice.
  • Have a Gmail account for sending your server mail. Enable the less secure option.

Usage

You can call the main class with username and password as below:

class { 'postfix_gmail':
  username => 'username@gmail.com',
  password => 'password',
}

Reference

There are two internal classes. One for installing the packages and another for managing the config.

Limitations

This has only been tested on Centos/RHEL 7. It probably works anywhere with postfix in /etc/postfix.

Development

Contributing: contact me and don't break the basic functionality.

Release Notes/Contributors/Etc Optional

v0.1.0 - Christopher Miersma