Git Product home page Git Product logo

postfix_gmail's Introduction

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. Based on initial work by Christopher Miersma, this version allows for the configuration of gmail relays with additional options, such as network selection, SSL key selection, and interfaces. It also allows for a manual hostname to be specifed in the class.

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. In addition, mailutils are also installed (mailx) to facilitate testing of the mail system itself. This module has been tested on Ubuntu 20.04 LTS.

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 => "[email protected]",
  password => "XXXXXXXXXXXXXX",
  myhostname => "puppet.server.com",
  sslcert => "/etc/ssl/certs/ssl-cert-snakeoil.pem",
  sslkey => "/etc/ssl/certs/ssl-cert-snakeoil.key",
  cacert => "/etc/ssl/certs/ca-certificates.crt",
  interfaces => "local",
  destinations => ['puppet.server.com', 'puppet', 'puppetreply', 'localhost.localdomain', 'localhost','relaystuff.mail.com'],
  networks => ['127.0.0.0/8','[::ffff:127.0.0.0]/104','[::1]/128'],
}

Reference

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

Limitations

This has only been tested on Ubuntu 20.04LTS but was originally tested with CentOS. 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.2.0 - Anna Hegedus

postfix_gmail's People

Contributors

akh13 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.