Update readme
This commit is contained in:
parent
e0f7006213
commit
f9b76925f9
14
README.md
14
README.md
|
@ -2,11 +2,10 @@
|
||||||
|
|
||||||
# chriswayg.msmtp-mailer
|
# chriswayg.msmtp-mailer
|
||||||
|
|
||||||
This ansible role deploys msmtp as mailer for Debian / Ubuntu.
|
This ansible role deploys msmtp as a mailer for Debian / Ubuntu.
|
||||||
|
|
||||||
## Prerequisite
|
## Prerequisite
|
||||||
* Having ansible installed on your workstation.
|
* Access to a functioning SMTP server.
|
||||||
* Having an SMTP server
|
|
||||||
|
|
||||||
## How to install
|
## How to install
|
||||||
* Use github to clone/fork into your role directory
|
* Use github to clone/fork into your role directory
|
||||||
|
@ -39,20 +38,17 @@ This ansible role deploys msmtp as mailer for Debian / Ubuntu.
|
||||||
|
|
||||||
- Logging
|
- Logging
|
||||||
- Option A (syslog)
|
- Option A (syslog)
|
||||||
|
|
||||||
```
|
```
|
||||||
msmtp_log : "syslog"
|
msmtp_log : "syslog"
|
||||||
```
|
```
|
||||||
|
|
||||||
- Option B (file logging)
|
- Option B (file logging)
|
||||||
|
|
||||||
```
|
```
|
||||||
msmtp_log : "file"
|
msmtp_log : "file"
|
||||||
msmtp_logfile : /var/log/msmtp.log
|
msmtp_logfile : /var/log/msmtp.log
|
||||||
```
|
```
|
||||||
|
|
||||||
- Option C (No logging)
|
- Option C (No logging)
|
||||||
|
|
||||||
```
|
```
|
||||||
msmtp_log : "no"
|
msmtp_log : "no"
|
||||||
```
|
```
|
||||||
|
@ -60,15 +56,15 @@ This ansible role deploys msmtp as mailer for Debian / Ubuntu.
|
||||||
- Mail aliases
|
- Mail aliases
|
||||||
- *msmtp_alias_default:* default email this required
|
- *msmtp_alias_default:* default email this required
|
||||||
|
|
||||||
```msmtp_alias_default : ops@example.com```
|
`msmtp_alias_default : ops@example.com`
|
||||||
|
|
||||||
- *msmtp_alias_root:* root email this is optional
|
- *msmtp_alias_root:* root email this is optional
|
||||||
|
|
||||||
```msmtp_alias_root : root@example.com```
|
`msmtp_alias_root : root@example.com`
|
||||||
|
|
||||||
- *msmtp_alias_cron:* cron email this optional
|
- *msmtp_alias_cron:* cron email this optional
|
||||||
|
|
||||||
```msmtp_alias_cron : cron@example.com```
|
`msmtp_alias_cron : cron@example.com`
|
||||||
|
|
||||||
## Configure
|
## Configure
|
||||||
You can configure your variables in ansible with one of the following
|
You can configure your variables in ansible with one of the following
|
||||||
|
|
Loading…
Reference in a new issue