Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joelnb/ansible-msmtp
Ansible role to configure msmtp
https://github.com/joelnb/ansible-msmtp
Last synced: 3 months ago
JSON representation
Ansible role to configure msmtp
- Host: GitHub
- URL: https://github.com/joelnb/ansible-msmtp
- Owner: joelnb
- License: apache-2.0
- Created: 2020-03-24T19:28:12.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-07-25T18:40:44.000Z (6 months ago)
- Last Synced: 2024-10-17T18:02:29.942Z (3 months ago)
- Language: Shell
- Size: 19.5 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/joelnb/ansible-msmtp)
# Readme
This ansible role deploys msmtp for Ubuntu 18.04
## Prerequisite
* Having ansible installed on your workstation.
* Having an SMTP server
## How to install
* Use github to clone/fork in your role directory
* ansible galaxy ```ansible-galaxy install joelnb.msmtp```
## Variables
All the default variables are located **defaults/main.yml**. Mostly you would need to configure the following variables.
- *msmtp_accounts:* You can define one or more smtp account
```yaml
msmtp_accounts:
- account: "gmail"
host: "smtp.gmail.com"
port: 587
auth: "on"
user: "[email protected]"
password: "some password"
- account: "mysmtp"
host: "smtp.example"
port: 587
auth: "on"
user: "myuser"
password: "123456"
```
- *msmtp_default_account:* Default smtp account to use
```msmtp_default_account: "gmail"```
- *msmtp_from:* From field
```msmtp_from: "No Reply"```
- Logging
- Option A (syslog)
```yaml
msmtp_log: "syslog"
```
- Option B (file logging)
```yaml
msmtp_log: "file"
msmtp_logfile: /var/log/msmtp.log
```
- Option C (No logging)
```yaml
msmtp_log: "no"
```
- Mail aliases
- *msmtp_alias_default:* default email this required
```msmtp_alias_default: [email protected]```
- *msmtp_alias_root:* root email this is optional
```msmtp_alias_root: [email protected]```
- *msmtp_alias_cron:* cron email this optional
```msmtp_alias_cron: [email protected]```
## Configure
You can configure your variables in ansible with one of the following
* Create a variable in host/group variables directory. (recommended)
* Editing var/main.yml
* Run ansible-playbook with -e
* Edit the default/main.yml (not recommended)
## Run
**By default the mstmp will fail because the configuration uses a bogus smtp server you need to use a valid smtp server**
ansible-playbook -l hostname msmtp.yml
## Test
You should get a test mail if it works on the root mail
## Possible issues
From field requires more work: [http://msmtp.sourceforge.net/doc/msmtp.html#Envelope_002dfrom-address](http://msmtp.sourceforge.net/doc/msmtp.html#Envelope_002dfrom-address)
## Credits
Initial work on this role was done by [ahelal](https://github.com/ahelal) over at [AutomationWithAnsible/ansible-msmtp](https://github.com/AutomationWithAnsible/ansible-msmtp).