From 35e6d417930f9acb68991fbaf34ff05094826dec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C4=93teris=20Caune?= Date: Thu, 21 Jan 2021 17:43:28 +0200 Subject: [PATCH] Add README --- docker/README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docker/README.md diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 00000000..ea639ee6 --- /dev/null +++ b/docker/README.md @@ -0,0 +1,27 @@ +# Running with Docker + +This is a sample configuration for running Healthchecks with +[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, +should be considered highly experimental**. + +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 +termination. If you plan to expose it to the public internet, make sure you put a +SSL-terminating load balancer or reverse proxy in front of it. + +## Getting Started + +* Edit the `docker-compose.yml` file; add your SMTP credentials + and any other needed environment variables. +* Create and start containers: + + $ docker-compose up + +* Create a superuser: + + $ docker-compose run web /opt/healthchecks/manage.py createsuperuser + +* Open [http://localhost:8000](http://localhost:8000) in your browser and log in with + the credentials from the previous step.