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.
41 lines
1.9 KiB
41 lines
1.9 KiB
<h1>Running with Docker</h1>
|
|
<p>In the Healthchecks source code, <a href="https://github.com/healthchecks/healthchecks/tree/master/docker">/docker/ directory</a>,
|
|
you can find a sample configuration for running the project with
|
|
<a href="https://www.docker.com">Docker</a> and <a href="https://docs.docker.com/compose/">Docker Compose</a>.</p>
|
|
<p><strong>Note: The Docker configuration is a recent addition, and, for the time being,
|
|
should be considered experimental</strong>.</p>
|
|
<p>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.</p>
|
|
<h2>Getting Started</h2>
|
|
<ul>
|
|
<li>Grab the Healthchecks source code
|
|
<a href="https://github.com/healthchecks/healthchecks">from the Github repository</a>.</li>
|
|
<li>Add your <a href="../self_hosted_configuration/">configuration</a> in the <code>/docker/.env</code> file.
|
|
As a minimum, set the following fields:<ul>
|
|
<li><code>DEFAULT_FROM_EMAIL</code> – the "From:" address for outbound emails</li>
|
|
<li><code>EMAIL_HOST</code> – the SMTP server</li>
|
|
<li><code>EMAIL_HOST_PASSWORD</code> – the SMTP password</li>
|
|
<li><code>EMAIL_HOST_USER</code> – the SMTP username</li>
|
|
<li><code>SECRET_KEY</code> – secures HTTP sessions, set to a random value</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p>Create and start containers:</p>
|
|
<div class="highlight"><pre><span></span><code>$ <span class="nb">cd</span> docker
|
|
$ docker-compose up
|
|
</code></pre></div>
|
|
|
|
</li>
|
|
<li>
|
|
<p>Create a superuser:</p>
|
|
<div class="highlight"><pre><span></span><code>$ docker-compose run web /opt/healthchecks/manage.py createsuperuser
|
|
</code></pre></div>
|
|
|
|
</li>
|
|
<li>
|
|
<p>Open <a href="http://localhost:8000">http://localhost:8000</a> in your browser and log in with
|
|
the credentials from the previous step.</p>
|
|
</li>
|
|
</ul>
|