Add new conf options (#2843)

This commit is contained in:
Fabian Affolter 2017-06-19 14:19:42 +02:00 committed by GitHub
parent 078c37b77c
commit a94e0015a1

View File

@ -32,11 +32,11 @@ Configuration variables:
- **sender** (*Required*): E-mail address of the sender.
- **recipient** (*Required*): E-mail address of the recipient of the notification. This can be a recipient address or a list of addresses for multiple recipients.
- **server** (*Optional*): SMTP server which is used to end the notifications. Defaults to `localhost`.
- **port** (*Optional*): The port that the SMTP server is using. Defaults to 25.
- **port** (*Optional*): The port that the SMTP server is using. Defaults to 465.
- **timeout** (*Optional*): The timeout in seconds that the SMTP server is using. Defaults to 5.
- **username** (*Optional*): Username for the SMTP account.
- **password** (*Optional*): Password for the SMTP server that belongs to the given username. If the password contains a colon it need to be wrapped in apostrophes.
- **starttls** (*Optional*): Enables STARTTLS, eg. True or False. Defaults to False.
- **encryption** (*Optional*): Set mode for encryption, `tls`, `starttls` or `none`. Defaults to `tls`.
- **sender_name** (*Optional*): Sets a custom 'sender name' in the emails headers (*From*: Custom name <example@mail.com>).
- **debug** (*Optional*): Enables Debug, eg. True or False. Defaults to False.
@ -51,7 +51,7 @@ notify:
port: 587
timeout: 15
sender: john@gmail.com
starttls: true
encryption: starttls
username: john@gmail.com
password: thePassword
recipient: