mirror of
https://github.com/Bubka/2FAuth.git
synced 2025-02-23 22:01:49 +01:00
* 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:
parent
346d50bdc2
commit
ff140fb5fa
@ -37,6 +37,7 @@ ## Setup
|
|||||||
```sh
|
```sh
|
||||||
docker run -it --rm -p 8000:8000/tcp \
|
docker run -it --rm -p 8000:8000/tcp \
|
||||||
-v /yourpath/2fauth:/2fauth 2fauth/2fauth
|
-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)
|
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 |
|
| `CREATED` | `an unknown date` | The date of the image build time |
|
||||||
| `COMMIT` | `unknown` | The commit hash of the Git commit used |
|
| `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
|
## Implementation details
|
||||||
|
|
||||||
- The final Docker image is based on `alpine:3.14` with minimal packages installed
|
- The final Docker image is based on `alpine:3.14` with minimal packages installed
|
||||||
|
Loading…
Reference in New Issue
Block a user