Update meta and readme

This commit is contained in:
Unknown 2018-05-07 22:28:10 +08:00
parent b8218116a7
commit 3c17537de5
3 changed files with 20 additions and 23 deletions

View file

@ -186,7 +186,7 @@ Apache License
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright {yyyy} {name of copyright owner}
Copyright 2018 Adham Helal, Christian Wagner
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@ -198,4 +198,4 @@ Apache License
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.
limitations under the License.

View file

@ -1,44 +1,42 @@
[![Build Status](https://travis-ci.org/chriswayg/ansible-msmtp.svg?branch=master)](https://travis-ci.org/chriswayg/ansible-msmtp)
# Readme
# chriswayg.msmtp-mailer
This ansible role deploys msmtp for Debian 9 stretch (tested on vagrant)
This ansible role deploys msmtp for Debian / Ubuntu.
## 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 adham.helal.msmtp```
* Use github to clone/fork into your role directory
* ansible galaxy ```ansible-galaxy install chriswayg.msmtp-mailer```
## 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 accounts:
```
msmtp_accounts:
- account : "gmail"
host : "smtp.gmail.com"
- account : gmail
host : smtp.gmail.com
port : 587
auth : "on"
user : "example@gmail.example"
from : example@gmail.example
user : example@gmail.example
password : "some password"
- account : "mysmtp"
host : "smtp.example"
- account : mysmtp
host : smtp.example
port : 587
auth : "on"
user : "myuser"
password : "123456"
from : admin@example.org
user : myuser@example.org
password : plain-text-password2
```
- *msmtp_default_account:* Default smtp account to use
```msmtp_default_account: "gmail"```
- *msmtp_from:* From field
```msmtp_from : "No Reply"```
- Logging
- Option A (syslog)
@ -81,13 +79,12 @@ You can configure your variables in ansible with one of the following
* 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**
**By default mstmp will work as the configuration uses a real smtp server (for testing only!)**
```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)
## Documentation
[msmtp manual](http://msmtp.sourceforge.net/doc/msmtp.html)

View file

@ -11,7 +11,7 @@ galaxy_info:
versions:
- trusty
- xenial
- bionic
# - bionic
categories:
- system
- networking