Search…
Images
Powered By GitBook
linuxserver/healthchecks
Healthchecks is a watchdog for your cron jobs. It's a web server that listens for pings from your cron jobs, plus a web interface.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/healthchecks should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest

Application Setup

Access the WebUI at :8000. For more information, check out Healthchecks.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
1
---
2
version: "2.1"
3
services:
4
healthchecks:
5
image: lscr.io/linuxserver/healthchecks
6
container_name: healthchecks
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- SITE_ROOT=<SITE_ROOT>
11
- SITE_NAME=<SITE_NAME>
12
- DEFAULT_FROM_EMAIL=<DEFAULT_FROM_EMAIL>
13
- EMAIL_HOST=<EMAIL_HOST>
14
- EMAIL_PORT=<EMAIL_PORT>
15
- EMAIL_HOST_USER=<EMAIL_HOST_USER>
16
- EMAIL_HOST_PASSWORD=<EMAIL_HOST_PASSWORD>
17
- EMAIL_USE_TLS=<True or False>
18
- ALLOWED_HOSTS=<ALLOWED_HOSTS>
19
- SUPERUSER_EMAIL=<SUPERUSER_EMAIL>
20
- SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>
21
- REGENERATE_SETTINGS=True/False #optional
22
- SITE_LOGO_URL=<SITE_LOGO_URL> #optional
23
- SECRET_KEY=<SECRET_KEY> #optional
24
volumes:
25
- <path to data on host>:/config
26
ports:
27
- 8000:8000
28
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=healthchecks \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e SITE_ROOT=<SITE_ROOT> \
6
-e SITE_NAME=<SITE_NAME> \
7
-e DEFAULT_FROM_EMAIL=<DEFAULT_FROM_EMAIL> \
8
-e EMAIL_HOST=<EMAIL_HOST> \
9
-e EMAIL_PORT=<EMAIL_PORT> \
10
-e EMAIL_HOST_USER=<EMAIL_HOST_USER> \
11
-e EMAIL_HOST_PASSWORD=<EMAIL_HOST_PASSWORD> \
12
-e EMAIL_USE_TLS=<True or False> \
13
-e ALLOWED_HOSTS=<ALLOWED_HOSTS> \
14
-e SUPERUSER_EMAIL=<SUPERUSER_EMAIL> \
15
-e SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD> \
16
-e REGENERATE_SETTINGS=True/False `#optional` \
17
-e SITE_LOGO_URL=<SITE_LOGO_URL> `#optional` \
18
-e SECRET_KEY=<SECRET_KEY> `#optional` \
19
-p 8000:8000 \
20
-v <path to data on host>:/config \
21
--restart unless-stopped \
22
lscr.io/linuxserver/healthchecks
Copied!

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter
Function
8000
will map the container's port 8000 to port 8000 on the host

Environment Variables (-e)

Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
SITE_ROOT=<SITE_ROOT>
The site's top-level URL and the port it listens to if differrent than 80 or 443 (e.g., https://healthchecks.example.com:8000)
SITE_NAME=<SITE_NAME>
The site's name (e.g., "Example Corp HealthChecks")
DEFAULT_FROM_EMAIL=<DEFAULT_FROM_EMAIL>
From email for alerts
EMAIL_HOST=<EMAIL_HOST>
SMTP host
EMAIL_PORT=<EMAIL_PORT>
SMTP port
EMAIL_HOST_USER=<EMAIL_HOST_USER>
SMTP user
EMAIL_HOST_PASSWORD=<EMAIL_HOST_PASSWORD>
SMTP password
EMAIL_USE_TLS=<True or False>
Use TLS for SMTP (True or False)
ALLOWED_HOSTS=<ALLOWED_HOSTS>
array of valid hostnames for the server ["test.com","test2.com"] (default: ["*"])
SUPERUSER_EMAIL=<SUPERUSER_EMAIL>
Superuser email
SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>
Superuser password
REGENERATE_SETTINGS=True/False
Defaults to False. Set to true to always override the local_settings.py file with values from environment variables. Do not set to True if you have made manual modifications to this file.
SITE_LOGO_URL=<SITE_LOGO_URL>
Custom site logo URL
SECRET_KEY=<SECRET_KEY>
A secret key used for cryptographic signing. docker-healthchecks will generate a secure value if one does not exist

Volume Mappings (-v)

Volume
Function
/config
database and healthchecks config directory volume mapping
Miscellaneous Options

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id user as below:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

    Shell access whilst the container is running:
      docker exec -it healthchecks /bin/bash
    To monitor the logs of the container in realtime:
      docker logs -f healthchecks
    Container version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' healthchecks
    Image version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/healthchecks

Versions

    10.09.21: - Fix creation of superuser
    07.08.21: - Update custom logo handling to support changes in v1.22.0
    11.07.21: - Rebase to Alpine 3.14.
    18.05.21: - Add linuxserver wheel index.
    11.01.21: - Add libffi-dev to allow building of python cryptography lib.
    19.07.20: - Rebasing to alpine 3.12, fixed 'ALLOWED_HOSTS' bug, now defaults to wildcard
    19.12.19: - Rebasing to alpine 3.11.
    31.10.19: - Add postgres client and fix config for CSRF.
    23.10.19: - Allow to create superuser
    28.06.19: - Rebasing to alpine 3.10.
    12.04.19: - Rebase to Alpine 3.9.
    23.03.19: - Switching to new Base images, shift to arm32v7 tag.
    14.02.19: - Adding mysql libs needed for using a database.
    11.10.18: - adding pipeline logic and multi arching release
    15.11.17: - git pull is now in Dockerfile so each tagged container contains the same code version
    17.10.17: - Fixed local_settings.py output
    27.09.17: - Initial Release.
Last modified 1d ago