archive/healthchecks_healthchecks
0
0
Fork 0
mirror of https://github.com/healthchecks/healthchecks.git synced 2025-04-08 06:30:05 +00:00
Code Issues Projects Releases Wiki Activity

Add a note about pre-built images in docs/docker

Browse source
This commit is contained in:
Pēteris Caune 2023-06-27 15:20:53 +03:00
parent 651aec4ac7
commit a53e79cc49
No known key found for this signature in database
GPG key ID: E28D7679E9A9EDE2
3 changed files with 52 additions and 12 deletions

3
docker/docker-compose.yml
View file

@ -14,6 +14,9 @@ services:
build:
context: ..
dockerfile: docker/Dockerfile
# To use a pre-built image, remove the above "build" section
# and uncomment the following line:
# image: healthchecks/healthchecks:v2.9.2
env_file:
- .env
ports:

30
templates/docs/self_hosted_docker.html-fragment
View file

@ -9,13 +9,19 @@ termination.</p>
<ul>
<li>Grab the Healthchecks source code
<a href="https://github.com/healthchecks/healthchecks">from the GitHub repository</a>.</li>
<li>Copy <code>docker/.env.example</code> to <code>docker/.env</code> and add your configuration in it.
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>
<li>
<p>Copy <code>docker/.env.example</code> to <code>docker/.env</code> and add your configuration in it.
As a minimum, set the following fields:</p>
<ul>
<li><code>ALLOWED_HOSTS</code> – the domain name of your Healthchecks instance.
Example: <code>ALLOWED_HOSTS=hc.example.org</code>.</li>
<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>
<li><code>SITE_ROOT</code> – The base public URL of your Healthchecks instance. Example:
<code>SITE_ROOT=https://hc.example.org</code>.</li>
</ul>
</li>
<li>
@ -57,4 +63,14 @@ reverse proxy:</p>
</ul>
<p>For example, in NGINX you can use the <code>$scheme</code> variable like so:</p>
<div class="highlight"><pre><span></span><code>proxy_set_header X-Forwarded-Proto $scheme;
</code></pre></div>
<h2>Pre-built Images</h2>
<p>Pre-built Docker images, built from the Dockerfile in the <code>/docker/</code> directory,
are available <a href="https://hub.docker.com/r/healthchecks/healthchecks">on Docker Hub</a>.
The images are built automatically for every new release. The Docker images support
amd64, arm/v7 and arm64 architectures.</p>
<p>To use a pre-built image for Healthchecks version X.Y, in the <code>docker-compose.yml</code> file
replace the "build" section with:</p>
<div class="highlight"><pre><span></span><code><span class="n">image</span><span class="o">:</span><span class="w"> </span><span class="n">healthchecks</span><span class="o">/</span><span class="n">healthchecks</span><span class="o">:</span><span class="n">v2</span><span class="o">.</span><span class="mf">9.2</span>
</code></pre></div>

31
templates/docs/self_hosted_docker.md
View file

@ -14,11 +14,16 @@ termination.
[from the GitHub repository](https://github.com/healthchecks/healthchecks).
* Copy `docker/.env.example` to `docker/.env` and add your configuration in it.
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
* `ALLOWED_HOSTS` – the domain name of your Healthchecks instance.
Example: `ALLOWED_HOSTS=hc.example.org`.
* `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.
* `SITE_ROOT` – The base public URL of your Healthchecks instance. Example:
`SITE_ROOT=https://hc.example.org`.
* Create and start containers:
$ cd docker
@ -59,3 +64,19 @@ For example, in NGINX you can use the `$scheme` variable like so:
```text
proxy_set_header X-Forwarded-Proto $scheme;
```
## Pre-built Images
Pre-built Docker images, built from the Dockerfile in the `/docker/` directory,
are available [on Docker Hub](https://hub.docker.com/r/healthchecks/healthchecks).
The images are built automatically for every new release. The Docker images support
amd64, arm/v7 and arm64 architectures.
To use a pre-built image for Healthchecks version X.Y, in the `docker-compose.yml` file
replace the "build" section with:
```
image: healthchecks/healthchecks:v2.9.2
```