harmacist/healthchecks
1
0
Fork 0
forked from GithubBackups/healthchecks
Code Issues Pull Requests Projects Releases Wiki Activity

Update instructions in docker/README.md

Browse Source
This commit is contained in:
Pēteris Caune 2021-01-28 14:18:06 +02:00
parent c2bb4b31b5
commit 4e480cac57
No known key found for this signature in database
GPG Key ID: E28D7679E9A9EDE2
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docker/README.md
View File

@ -4,7 +4,7 @@ This is a sample configuration for running Healthchecks with
[Docker](https://www.docker.com) and [Docker Compose](https://docs.docker.com/compose/). [Docker](https://www.docker.com) and [Docker Compose](https://docs.docker.com/compose/).
**Note: The Docker configuration is a recent addition, and, for the time being, **Note: The Docker configuration is a recent addition, and, for the time being,
should be considered highly experimental**. should be considered as highly experimental**.
Note: For the sake of simplicity, the sample configuration starts a single database Note: For the sake of simplicity, the sample configuration starts a single database
node and a single web server node, both on the same host. It also does not handle SSL node and a single web server node, both on the same host. It also does not handle SSL
@ -13,8 +13,13 @@ SSL-terminating load balancer or reverse proxy in front of it.
## Getting Started ## Getting Started
* Edit the `docker-compose.yml` file; add your SMTP credentials * Add your configuration in the `/docker/.env` file.
and any other needed environment variables. As a minimum, set the following fields:
* `DEFAULT_FROM_EMAIL` – the "From:" address for outbound emails
* `EMAIL_HOST` – the SMTP server
* `EMAIL_HOST_PASSWORD` – the SMTP password
* `EMAIL_HOST_USER` – the SMTP username
* `SECRET_KEY` – secures HTTP sessions, set to a random value
* Create and start containers: * Create and start containers:
$ docker-compose up $ docker-compose up