From 065292548ccdce8bfa7b91231121f09cda911441 Mon Sep 17 00:00:00 2001 From: Maxime Veber Date: Mon, 11 Mar 2019 14:34:19 +0100 Subject: [PATCH] Update readme - Some wording fixes - Add some explanation - Add missing documentation for some vars - Add syntax coloration to yaml --- README.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 71abb83..527d7d7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# exim-relay +# exim-relay for gmail -Base from work of https://github.com/selim13/docker-exim-relay +This is a fork of [selim13/docker-exim-relay](https://github.com/selim13/docker-exim-relay), the goal is to have an exim docker configured with gmail by default. This is a base Exim docker image configured to act as a relay with some basic `main`, `acl` and `retry` defaults. @@ -26,17 +26,22 @@ Sets `relay_from_hosts` host list which is used in acl checks. Default value: `10.0.0.0/8 : 172.16.0.0/12 : 192.168.0.0/16` +### EXIM_GMAIL_LOGIN +Sets the gmail username (basically, your email address). + +### EXIM_GMAIL_PASSWORD +Sets the gmail password. + #### Docker compose usage -``` +```yaml version: '2' services: - -mail: - build: ./docker/docker-exim-relay - ports: - - "25:25" - environment: - - EXIM_GMAIL_LOGIN=******@gmail.com - - EXIM_GMAIL_PASSWORD=********** + mail: + build: ./docker/docker-exim-relay + ports: + - 25:25 + environment: + - EXIM_GMAIL_LOGIN=******@gmail.com + - EXIM_GMAIL_PASSWORD=********** ```