From ff140fb5fa16c19d879dc6fb1d8540dcdfa70831 Mon Sep 17 00:00:00 2001
From: aronmal <57275207+aronmal@users.noreply.github.com>
Date: Fri, 13 May 2022 10:49:44 +0200
Subject: [PATCH] Update docker docs - #68 #75 (#77)

* Fix recommendation for Bubka #68 in docs

Adding a recommendation to use the AUTHENTICATION_GUARD environment variable as a fix for issue #68.

* Mail Settings in docker README.md

https://github.com/Bubka/2FAuth/issues/75
---
 docker/README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/docker/README.md b/docker/README.md
index dc425f71..6b1c9330 100644
--- a/docker/README.md
+++ b/docker/README.md
@@ -37,6 +37,7 @@ We assume your current directory is `/yourpath`.
     ```sh
     docker run -it --rm -p 8000:8000/tcp \
     -v /yourpath/2fauth:/2fauth 2fauth/2fauth
+    -e AUTHENTICATION_GUARD=web-guard #fix for issue #68
     ```
 
 1. Access it at [http://localhost:8000](http://localhost:8000)
@@ -108,6 +109,27 @@ There are the following build arguments you can use to customize the image using
 | `CREATED` | `an unknown date` | The date of the image build time |
 | `COMMIT` | `unknown` | The commit hash of the Git commit used |
 
+### Mail settings ####
+
+| Build argument | Default | Description |
+| --- | --- | --- |
+| MAIL_HOST | smtp.mailtrap.io | The SMTP hostname |
+| MAIL_PORT | 2525 | The coresponding SMTP port |
+| MAIL_FROM | changeme@example.com | The sender adress |
+| MAIL_USERNAME | null | The SMTP username |
+| MAIL_PASSWORD | null | The SMTP password |
+
+Example:
+
+```
+...
+-e MAIL_HOST=smtp.example.com
+-e MAIL_PORT=587
+-e MAIL_FROM=2fauth@example.com
+-e MAIL_USERNAME=2fauth@example.com
+-e MAIL_PASSWORD=password1234
+```
+
 ## Implementation details
 
 - The final Docker image is based on `alpine:3.14` with minimal packages installed