Skip to content

Commit

Permalink
Update docker docs - #68 #75 (#77)
Browse files Browse the repository at this point in the history
* 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

#75
  • Loading branch information
aronmal authored May 13, 2022
1 parent 346d50b commit ff140fb
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit ff140fb

Please sign in to comment.