extern/2FAuth
1
0
Fork 0
mirror of https://github.com/Bubka/2FAuth.git synced 2025-02-23 13:51:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update docker docs - #68 #75 (#77)

Browse Source 
* 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
This commit is contained in:
aronmal 2022-05-13 10:49:44 +02:00 committed by GitHub
parent 346d50bdc2
commit ff140fb5fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docker/README.md
View File

@ -37,6 +37,7 @@ ## Setup
```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 @@ ### Build the image with build arguments
| `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