docker-documentation/images/docker-healthchecks.md

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 ghcr.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

Usage

Here are some example snippets to help you get started creating a container from this image.

docker-compose (recommended)

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
  healthchecks:
    image: ghcr.io/linuxserver/healthchecks
    container_name: healthchecks
    environment:
      - PUID=1000
      - PGID=1000
      - SITE_ROOT=<SITE_ROOT>
      - SITE_NAME=<SITE_NAME>
      - DEFAULT_FROM_EMAIL=<DEFAULT_FROM_EMAIL>
      - EMAIL_HOST=<EMAIL_HOST>
      - EMAIL_PORT=<EMAIL_PORT>
      - EMAIL_HOST_USER=<EMAIL_HOST_USER>
      - EMAIL_HOST_PASSWORD=<EMAIL_HOST_PASSWORD>
      - EMAIL_USE_TLS=<True or False>
      - ALLOWED_HOSTS=<ALLOWED_HOSTS>
      - SUPERUSER_EMAIL=<SUPERUSER_EMAIL>
      - SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>
      - REGENERATE_SETTINGS=True/False
    volumes:
      - <path to data on host>:/config
    ports:
      - 8000:8000
    restart: unless-stopped

docker cli

docker run -d \
  --name=healthchecks \
  -e PUID=1000 \
  -e PGID=1000 \
  -e SITE_ROOT=<SITE_ROOT> \
  -e SITE_NAME=<SITE_NAME> \
  -e DEFAULT_FROM_EMAIL=<DEFAULT_FROM_EMAIL> \
  -e EMAIL_HOST=<EMAIL_HOST> \
  -e EMAIL_PORT=<EMAIL_PORT> \
  -e EMAIL_HOST_USER=<EMAIL_HOST_USER> \
  -e EMAIL_HOST_PASSWORD=<EMAIL_HOST_PASSWORD> \
  -e EMAIL_USE_TLS=<True or False> \
  -e ALLOWED_HOSTS=<ALLOWED_HOSTS> \
  -e SUPERUSER_EMAIL=<SUPERUSER_EMAIL> \
  -e SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD> \
  -e REGENERATE_SETTINGS=True/False \
  -p 8000:8000 \
  -v <path to data on host>:/config \
  --restart unless-stopped \
  ghcr.io/linuxserver/healthchecks

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"] or "*"
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.

Volume Mappings (-v)

Volume	Function
/config	database and healthchecks config directory volume mapping

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

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:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Application Setup

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

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" }}' ghcr.io/linuxserver/healthchecks

Versions

• 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.