You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

32 lines
1.3 KiB

4 years ago
4 years ago
4 years ago
  1. # Running with Docker
  2. This is a sample configuration for running Healthchecks with
  3. [Docker](https://www.docker.com) and [Docker Compose](https://docs.docker.com/compose/).
  4. **Note: The Docker configuration is a recent addition, and, for the time being,
  5. should be considered as highly experimental**.
  6. Note: For the sake of simplicity, the sample configuration starts a single database
  7. node and a single web server node, both on the same host. It also does not handle SSL
  8. termination. If you plan to expose it to the public internet, make sure you put a
  9. SSL-terminating load balancer or reverse proxy in front of it.
  10. ## Getting Started
  11. * Add your configuration in the `/docker/.env` file.
  12. As a minimum, set the following fields:
  13. * `DEFAULT_FROM_EMAIL` – the "From:" address for outbound emails
  14. * `EMAIL_HOST` – the SMTP server
  15. * `EMAIL_HOST_PASSWORD` – the SMTP password
  16. * `EMAIL_HOST_USER` – the SMTP username
  17. * `SECRET_KEY` – secures HTTP sessions, set to a random value
  18. * Create and start containers:
  19. $ docker-compose up
  20. * Create a superuser:
  21. $ docker-compose run web /opt/healthchecks/manage.py createsuperuser
  22. * Open [http://localhost:8000](http://localhost:8000) in your browser and log in with
  23. the credentials from the previous step.