Version information
released Jul 2nd 2021
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
- Puppet >= 5.5.10 < 7.0.0
- ,
Start using this module
Add this module to your Puppetfile:
mod 'systarch-mailhog', '2.2.0'Learn more about managing modules with a PuppetfileDocumentation
systarch/mailhog — version 2.2.0 Jul 2nd 2021
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with mailhog
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
This module lets you use Puppet to install and configure MailHog
Module Description
MailHog is an email testing tool for developers written by Ian Kent (https://github.com/mailhog/). It receives mail and displays it in a WebUI. No login required, no need for user accounts. Just all received mail is shown in the WebUI.
You can access the WebUI by opening http://$::ipaddress:8025 (default port, feel free to change) in your browser.
MailHog will receive mail (default is smtp on port 1025) and will display it in the WebUI. You can view and delete the mail. If required one could also forward the mail to the corresponding external Mailserver for the receipients e-mail domain.
The configuration is straight forward - take a look at the params.pp class for default values.
Due to the size limitation on puppet forge the module will download the mailhog binary to the target system.
Setup
What mailhog affects
- Deploys mailhog binary depending on the architecture the local machine uses (amd64, arm or x86) from MailHog github releases page or from the puppetmaster.
- Creates a "mailhog" user with home at
/var/lib/mailhog - Deploys a mailhog.conf file with the available config values
- Installs "daemon" and "curl" package
- Deploys a initd script to start/stop mailhog as a daemon
Setup Requirements
This mailhog module requires:
Beginning with mailhog
The simplest way to get MailHog up and running with the mailhog module is to just add the mailhog-class to your manifest:
include mailhog
That's it! Really. Didn't hurt, did it? ;-)
You want to change the ip & port MailHog receives incoming mails? No problem:
class { 'mailhog':
smtp_bind_addr_ip => "1.2.3.4",
smtp_bind_addr_port => "1125"
}
include mailhog
Usage
Put the classes, types, and resources for customizing, configuring, and doing the fancy stuff with your module here.
##Reference
Classes
Public Classes
mailhog: Main class, includes all other classes
Private Classes
mailhog::params: Holds default values for MailHog & module configmailhog::install: Handles deployment of user, dependencies and mailhog binarymailhog::config: Handles deployment of mailhog config filemailhog::service: Handles deployment of the init.d script
Download binary
Due to the size limit of packages uploaded to the Forge, the module was designed to offer two options on where to source the MailHog binary from:
$download_mailhog = true(default): The MailHog binary will be downloaded from the official MailHog Github repository. This is good for a few servers as this is very modular and the module can be used right away.$download_mailhog = false: The MailHog binary will be sourced from the "files" subdirectory of this module. This is perfect to roll out multiple hosts with this module. In case this feature is required, the admin needs to download the 3 MailHog Linux binaries (MailHog_linux_386, MailHog_linux_arm, MailHog_linux_amd64) to the "files" folder of this module. Just call the mailhog class with$download_mailhog = false.
Parameters
The following parameters are available in the mailhog class:
MailHog config values
| parameter | default value | description |
|---|---|---|
$service_ip |
0.0.0.0 | The IP address the HTTP and API server will be bound to. |
$service_port |
8025 | The port the HTTP and API server will be bound to. |
$api_bind_ip |
0.0.0.0 | The IP address the API server will be bound to. |
$api_bind_port |
8025 | The port the API server will be bound to. |
$api_bind_host |
undef | API URL for MailHog UI to connect to, e.g. http://some.host:1234 if API and WebUI are deployed on different hosts/IPs. |
$cors_origin |
undef | CORS Access-Control-Allow-Origin header for API endpoints. |
$hostname |
$::fqdn | Hostname to use for EHLO/HELO and message IDs. |
$invite_jim |
false | Decide whether to invite Jim, the chaos monkey. Jim is the MailHog Chaos Monkey, inspired by Netflix. He will:Reject connectionsRate limit connectionsReject authenticationReject sendersReject recipients |
$jim_accept |
0.99 | Chance of accepting an incoming connection (1.0 = 100%) |
$jim_disconnect |
0.005 | Chance of a disconnect |
$jim_linkspeed_affect |
0.1 | Chance of the link speed being affected for an incoming mail |
$jim_linkspeed_max |
10240 | Maximum link speed (in bytes per second) |
$jim_linkspeed_min |
1024 | Minimum link speed (in bytes per second) |
$jim_reject_auth |
0.05 | Chance of rejecting authentication (AUTH) |
$jim_reject_recipient |
0.05 | Chance of rejecting a recipient (RCPT TO) |
$jim_reject_sender |
0.05 | Chance of rejecting a sender (MAIL FROM) |
$mongo_coll |
messages | MongoDB collection if MongoDB is being used as backend storage |
$mongo_db |
mailhog | MongoDB database if MongoDB is being used as backend storage |
$mongo_uri_ip |
127.0.0.1 | MongoDB URI IP if MongoDB is being used as backend storage |
$mongo_uri_port |
27017 | MongoDB URI port if MongoDB is being used as backend storage |
$outgoing_smtp |
undef | JSON file containing outgoing SMTP servers |
$smtp_bind_addr_ip |
127.0.0.1 | SMTP bind interface, this is where MailHog will receive incoming mails |
$smtp_bind_addr_port |
1025 | SMTP bind port, this is where MailHog will receive incoming mails |
$storage |
memory | Message storage: memory or mongodb |
$ui_bind_addr_ip |
0.0.0.0 | HTTP bind interface for WebUI |
$ui_bind_addr_port |
8025 | HTTP bind port for WebUI |
Puppet module config values
| parameter | default value | description |
|---|---|---|
$mailhog_version |
1.0.0 | Version of Mailhog to be used. Feel free to look up the latest release version from GitHub |
$config |
/etc/mailhog.conf | Path and filename for mailhog config file at the target system |
$mailhog::service_manage |
true | Whether the service should be managed by this module or not. |
$service_enable |
true | Whether the service should be started on boot or not. |
$service_ensure |
running | Either "running" or "stopped" |
$service_name |
mailhog | Name of the service |
$binary_path |
/usr/bin | Where to place the mailhog binary at the target system |
$user |
mailhog | Username of the user running mailhog service at the target system. |
$user_home |
/var/lib/mailhog | Home directory of above mailhog user. |
$download_mailhog |
true | Enable/Disable wget download of MailHog binary. |
Limitations
Previously, the module was tested with Ubuntu 14.04 and 12.04 only and those should continue to work. Since v2.0.0, also Debian 8, 9 and 10 are supported.
Development
Feel free to pull the repository and commit changes. I will review them asap and add them if I think they are helpful or reasonable. No guarantees but a lot of heart ;-)
Contributors
This version was cloned from Florian Taeger at v1.1.0.
To see who's already involved, see the list of contributors.
Changelog
All notable changes to this project will be documented in this file.
Release 2.2.0
Features
-
Changed default version to mailhog v1.0.1.
-
Added convenience parameters
mailhog::service_ipandmailhog::service_portto control both public addresses of the API Service (mailhog::api_bind_addr_ip,mailhog::api_bind_addr_port) and HTTP Service (mailhog::ui_bind_addr_ip,mailhog::ui_bind_addr_port). Default remain as0.0.0.0and8025 -
New parameter
mailhog::manage_curl: trueto manage the deinstallation ofcurl.When the
mailhogmodule is asked to ensure its absence with
mailhog::ensure: absent
# added: don't remove curl, even if no other module requires it.
mailhog::manage_curl: false
then $manage_curl does no longer try to uninstall curl.
Bugfixes
- Notify the running mailhog service when the mailhog binary is updated.
- Fix runtime issue with
Service[mailhog], when{ensure => stopped, enable => true}.
Known Issues
- none
Release 2.1.0 (2020-03-06)
Features
- Allow to set
{ensure:absent}to remove the module from a machine - replaced deprecated methods with stdlib's
validate_legacyfunction
Release 2.0.0 (2020-02-26)
Features
- Import module from https://github.com/ftaeger[ftaeger] and major upgrades of tests including fixes
- Added support for Debian 8,9, 10
Dependencies
- puppetlabs/stdlib (>= 4.25.0 < 7.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.