Garbaye/ansible-msmtp-mailer
3
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
chriswayg 2018-04-29 02:36:01 +08:00 committed by GitHub
parent 7153155289
commit 4b10653735
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,17 +1,18 @@
[![Build Status](https://travis-ci.org/ahelal/ansible-msmtp.svg?branch=master)](https://travis-ci.org/ahelal/ansible-msmtp) [![Build Status](https://travis-ci.org/ahelal/ansible-msmtp.svg?branch=master)](https://travis-ci.org/ahelal/ansible-msmtp)
#Readme
# Readme
This ansible role deploys msmtp for Debian 9 stretch (tested on vagrant) This ansible role deploys msmtp for Debian 9 stretch (tested on vagrant)
##Prerequisite ## Prerequisite
* Having ansible installed on your workstation. * Having ansible installed on your workstation.
* Having an SMTP server * Having an SMTP server
##How to install ## How to install
* Use github to clone/fork in your role directory * Use github to clone/fork in your role directory
* ansible galaxy ```ansible-galaxy install adham.helal.msmtp``` * ansible galaxy ```ansible-galaxy install adham.helal.msmtp```
##Variables ## Variables
All the default variables are located **defaults/main.yml**. Mostly you would need to configure the following 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 - *msmtp_accounts:* You can define one or more smtp account
@ -71,7 +72,7 @@ This ansible role deploys msmtp for Debian 9 stretch (tested on vagrant)
```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
* Create a variable in host/group variables directory. (recommended) * Create a variable in host/group variables directory. (recommended)
@ -79,14 +80,14 @@ You can configure your variables in ansible with one of the following
* Run ansible-playbook with -e * Run ansible-playbook with -e
* Edit the default/main.yml (not recommended) * Edit the default/main.yml (not recommended)
##Run ## Run
**By default the mstmp will fail because the configuration uses a bogus smtp server you need to use a valid smtp server** **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``` ```ansible-playbook -l hostname msmtp.yml```
##Test ## Test
You should get a test mail if it works on the root mail You should get a test mail if it works on the root mail
##Possible issues ## Possible issues
From field requires more work 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) [http://msmtp.sourceforge.net/doc/msmtp.html#Envelope_002dfrom-address](http://msmtp.sourceforge.net/doc/msmtp.html#Envelope_002dfrom-address)