Forge Home

postsrsd

Deploy postsrsd, Postfix Sender Rewriting Scheme daemon

7,231 downloads

7,231 latest version

4.4 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.2.0 (latest)
released Apr 28th 2017
This version is compatible with:
  • ,

Start using this module

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

Add this module to your Puppetfile:

mod 'mricon-postsrsd', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add mricon-postsrsd
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install mricon-postsrsd --version 0.2.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

mricon/postsrsd — version 0.2.0 Apr 28th 2017

Postsrsd

[Build Status] (https://travis-ci.org/mricon/puppet-postsrsd)

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup
  4. Reference
  5. Limitations - OS compatibility, etc.

Overview

Puppet module to manage postsrsd installation and configuration.

Module Description

This module installs and configures the postsrsd daemon version 1.4+, see https://github.com/roehling/postsrsd for more details.

This module was forked from https://github.com/thomasvs/puppet-postsrsd.

Setup

You MUST set $srs_secret_content, as it is bad practice to use auto-generated values (if you ever migrate, you will lose ability verify your previously issued envelope-senders).

It's expected that this module will be used with hiera, so the quickest way to configure it for your environment is to add it to your Puppetfile:

mod 'mricon-postsrsd'

The minimal configuration bits that should go into hiera are:

postsrsd::config::srs_secret_content: 'somestring24+charslong'

Without the above, the module will refuse to run.

Reference

postsrsd

manage_package

Whether to manage the package. At least on Red Hat systems, the only place where the postsrsd package is available is in one of the COPR locations.

Default: true

manage_service

Whether to manage the postsrsd service.

Default: true

package_name

Package name (OS-specific).

Default: postsrsd

service_name

Service name (OS-specific).

Default: postsrsd

sysconfig_file

Location of the startup parameters file.

Default: /etc/sysconfig/postsrsd

postsrsd::config

For the descriptions, see the default configuration file.

srs_domain

You do not have to define it, as the default behaviour is for postsrsd to take the output of postconf -h mydomain.

Default: undef

srs_exclude_domains

An Array of domains to exclude from being processed by postsrsd.

Default: undef

srs_separator

Default: '='

srs_secret_file

Location of the file with the secret used to hash the values.

Default: /etc/postsrsd.secret

srs_secret_content

The value of the secret used to hash the values. The only value that must be set for the module to work.

Default: undef

srs_hashlength

Default: 4

srs_hashmin

Default: 4

srs_forward_port

Default: 10001

srs_reverse_port

Default: 10002

run_as

Default: nobody

chroot

Default: undef

Limitations

This module will NOT make any changes to your postfix installation, so you will need to adjust your configuration using the postfix module.

Written and tested for CentOS 7 only. To get the package, please see https://copr.fedorainfracloud.org/coprs/natolumin/postsrsd/