Skip to content

Commit 98bbbaa

Browse files
committed
Update REAMDE
1 parent 8dd483b commit 98bbbaa

File tree

2 files changed

+46
-21
lines changed

2 files changed

+46
-21
lines changed

README.md

Lines changed: 46 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,72 @@
11
# Ansible Role: Mailpit
22

3-
Installs [Mailpit](https://github.com/axllent/mailpit), a Go-based SMTP server and web UI/API for displaying captured emails, on RedHat or Debian-based linux systems.
3+
<p align="center">
4+
<a href="LICENSE.md">
5+
<img alt="MIT License" src="https://img.shields.io/github/license/roots/ansible-role-mailpit?color=%23525ddc&style=flat-square" />
6+
</a>
47

5-
If you're using PHP and would like to route all PHP email into Mailpit, you will need to update the `sendmail_path` configuration option in php.ini, like so:
8+
<a href="https://github.com/roots/ansible-role-mailpit/releases">
9+
<img alt="Release" src="https://img.shields.io/github/release/roots/ansible-role-mailpit.svg?style=flat-square" />
10+
</a>
11+
12+
<a href="https://github.com/roots/ansible-role-mailpit/actions">
13+
<img alt="Build Status" src="https://img.shields.io/github/actions/workflow/status/roots/ansible-role-mailpit/ci.yml?branch=main&style=flat-square" />
14+
</a>
615

7-
sendmail_path = "{{ mailpit_install_dir }}/mailpit sendmail"
16+
<a href="https://twitter.com/rootswp">
17+
<img alt="Follow Roots" src="https://img.shields.io/twitter/follow/rootswp.svg?style=flat-square&color=1da1f2" />
18+
</a>
19+
</p>
820

9-
(Replace `{{ mailpit_install_dir }}` with the actual Mailpit installation directory, which is `/opt/mailpit` by default.
21+
Installs [Mailpit](https://github.com/axllent/mailpit), an email testing tool for developers, on RedHat or Debian-based linux systems.
22+
Mailpit acts as both an SMTP server, and provides a web interface to view all captured emails. Mailpit is inspired by MailHog, but much, much faster.
1023

1124
This role is based on https://github.com/geerlingguy/ansible-role-mailhog
1225

26+
If you're using PHP and would like to route all PHP email into Mailpit, you will need to update the `sendmail_path` configuration option in php.ini, like so:
27+
28+
```yaml
29+
sendmail_path = "{{ mailpit_install_dir }}/mailpit sendmail"
30+
```
31+
1332
## Requirements
1433

15-
* systemd
34+
A Debian-based (eg: Ubuntu) or RedHat system running systemd.
1635

1736
## Role Variables
1837

1938
Available variables are listed below, along with default values (see `defaults/main.yml`):
2039

21-
mailpit_install_dir: /opt/mailpit
40+
```yaml
41+
mailpit_install_dir: /opt/mailpit
42+
```
2243
2344
The directory into which the MailHog binary will be installed.
2445
25-
mailpit_version: 1.0.0
46+
```yaml
47+
mailpit_version: 1.3.8
48+
```
2649
2750
The version of Mailpit that will be installed. You can find the latest version by visiting the [Mailpit project releases page](https://github.com/axllent/mailpit/releases).
2851
29-
mailpit_release_url: "https://github.com/axllent/mailpit/releases/download/v{{ mailpit_version }}/mailhog-linux-amd64"
52+
```yaml
53+
mailpit_release_url: "https://github.com/axllent/mailpit/releases/download/v{{ mailpit_version }}/mailhog-linux-amd64"
54+
```
3055
31-
The Mailpit binary that will be installed. You can find the latest version by visiting the [MailHog project releases page](https://github.com/mailpit/MailHog/releases).
32-
33-
mailpit_daemonize_bin_path: /usr/sbin/daemonize
34-
35-
The path to `daemonize`, which is used to launch MailHog via init script.
36-
37-
mhsendmail_version: 0.2.0
56+
## Example Playbook
3857
39-
## Dependencies
58+
```yaml
59+
- hosts: servers
60+
roles:
61+
- { role: roots.mailpit }
62+
```
4063
41-
- geerlingguy.daemonize
64+
## Community
4265
43-
## Example Playbook
66+
Keep track of development and community news.
4467
45-
- hosts: servers
46-
roles:
47-
- { role: roots.mailpit }
68+
- Join us on Discord by [sponsoring us on GitHub](https://github.com/sponsors/roots)
69+
- Participate on the [Roots Discourse](https://discourse.roots.io/)
70+
- Follow [@rootswp on Twitter](https://twitter.com/rootswp)
71+
- Read and subscribe to the [Roots Blog](https://roots.io/blog/)
72+
- Subscribe to the [Roots Newsletter](https://roots.io/subscribe/)

0 commit comments

Comments
 (0)