Forge Home

mailhog

pdk
Setup mailhog

11,001 downloads

1,362 latest version

5.0 quality score

Version information

  • 4.0.0 (latest)
  • 1.0.0
released Dec 3rd 2020
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 7.0.0
  • Debian
    ,
    Ubuntu
    ,
    CentOS

Start using this module

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

Add this module to your Puppetfile:

mod 'attachmentgenie-mailhog', '4.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add attachmentgenie-mailhog
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install attachmentgenie-mailhog --version 4.0.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
Tags: mailhog

Documentation

attachmentgenie/mailhog — version 4.0.0 Dec 3rd 2020

attachmentgenie-mailhog

Table of Contents

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

Module Description

MailHog is an email testing tool for developers:

- Configure your application to use MailHog for SMTP delivery
- View messages in the web UI, or retrieve them with the JSON API

Setup

What mailhog affects

  • Configuration files and directories (created and written to)
  • Package/service/configuration files for Mailhog
  • Listened-to ports

Usage

All options and configuration can be done through interacting with the parameters on the main mailhog class. These are now documented via Puppet Strings

You can view example usage in REFERENCE.

Reference

See REFERENCE.

Limitations

This module currently only exposes a subset of all configuration options.

Development

Running tests

This project contains tests for both rspec-puppet and litmus to verify functionality. For detailed information on using these tools, please see their respective documentation.

Testing quickstart:

pdk bundle install
pdk bundle exec rake 'litmus:provision_list[puppet6]'
pdk bundle exec rake 'litmus:install_agent[puppet6]'
pdk bundle exec rake litmus:install_module
pdk bundle exec rake litmus:acceptance:parallel
pdk bundle exec rake litmus:tear_down