healthchecks

v5.0.1-ls366

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.

docker pull lscr.io/linuxserver/healthchecks:latest

Quick start

Generated from the image's own configuration. Replace the /path/to folders with real paths on your host.

---
services:
  healthchecks:
    image: lscr.io/linuxserver/healthchecks:latest
    container_name: healthchecks
    environment:
      - SECRET_KEY=
      - SITE_ROOT=
      - SITE_NAME=
      - SUPERUSER_EMAIL=
      - SUPERUSER_PASSWORD=
      - ALLOWED_HOSTS= # optional
      - APPRISE_ENABLED=False # optional
      - CSRF_TRUSTED_ORIGINS= # optional
      - DEBUG=True # optional
      - DEFAULT_FROM_EMAIL= # optional
      - EMAIL_HOST= # optional
      - EMAIL_PORT= # optional
      - EMAIL_HOST_USER= # optional
      - EMAIL_HOST_PASSWORD= # optional
      - EMAIL_USE_TLS= # optional
      - INTEGRATIONS_ALLOW_PRIVATE_IPS= # optional
      - PING_EMAIL_DOMAIN= # optional
      - RP_ID= # optional
      - SITE_LOGO_URL= # optional
    volumes:
      - /path/to/healthchecks/config:/config
    ports:
      - 8000:8000
      - 2525:2525 # optional
    restart: unless-stopped

Parameters

Ports
PortFunctionRequired
8000:8000Healthchecks Web UIrequired
2525:2525Port for inbound SMTP pingsoptional
Environment variables
VariableFunctionRequired
SECRET_KEY=A secret key used for cryptographic signing. Will generate a random value if one is not supplied and save it to `/config/local_settings.py`.required
SITE_ROOT=The site's top-level URL and the port it listens to if different than 80 or 443 (e.g., https://healthchecks.example.com:8000).required
SITE_NAME=The site's name (e.g., "Example Corp HealthChecks").required
SUPERUSER_EMAIL=Superuser email.required
SUPERUSER_PASSWORD=Superuser password.required
ALLOWED_HOSTS=A comma-separated list of valid hostnames for the server. Default is the domain portion of `SITE_ROOT`.optional
APPRISE_ENABLED=FalseSet to `True` to enable the Apprise integration (https://github.com/caronc/apprise).optional
CSRF_TRUSTED_ORIGINS=A [list](https://docs.python.org/3/tutorial/introduction.html#lists) of trusted origins for unsafe requests (e.g. POST). Defaults to the value of `SITE_ROOT`.optional
DEBUG=TrueSet to `False` to disable. Debug mode relaxes CSRF protections and increases logging verbosity but should be disabled for production instances as it will impact performance and security.optional
DEFAULT_FROM_EMAIL=From email for alerts.optional
EMAIL_HOST=SMTP host.optional
EMAIL_PORT=SMTP port.optional
EMAIL_HOST_USER=SMTP user.optional
EMAIL_HOST_PASSWORD=SMTP password.optional
EMAIL_USE_TLS=Use TLS for SMTP (`True` or `False`).optional
INTEGRATIONS_ALLOW_PRIVATE_IPS=Defaults to False. Set to True to allow integrations to connect to private IP addresses.optional
PING_EMAIL_DOMAIN=The domain to use for generating ping email addresses. Defaults to `localhost`.optional
RP_ID=If using webauthn for 2FA set this to match your Healthchecks domain. Webauthn will only work over https.optional
SITE_LOGO_URL=Full URL to custom site logo.optional
Volumes
PathFunctionRequired
/configPersistent config files.required

Architectures

Pulling :latest picks the right one for your host automatically.

  • x86_64amd64-latest
  • arm64arm64v8-latest

Tags

  • :latestStable releases

Changelog

  1. Rebase to Alpine 3.24.

  2. Rebase to Alpine 3.23.

  3. Rebase to Alpine 3.22.

Related

Browse all

speedtest-tracker

v1.15.1-ls177

speedtest-tracker is a self-hosted internet performance tracking application that runs speedtest checks against Ookla's Speedtest service.

2.8M pulls per month189 GitHub starsarm64

smokeping

2.9.0-r0-ls187

smokeping keeps track of your network latency. For a full example of what this application is capable of visit UCDavis.

721K pulls per month433 GitHub starsarm64

librespeed

v6.3.1-ls297

librespeed is a very lightweight Speedtest implemented in Javascript, using XMLHttpRequest and Web Workers. No Flash, No Java, No Websocket, No Bullshit.

371K pulls per month107 GitHub starsarm64

apprise-api

v2.0.1-ls266

apprise-api Takes advantage of Apprise through your network with a user-friendly API. * Send notifications to more than 100 services. * An incredibly lightweight gateway to Apprise. * A production ready micro-service at your disposal. * A Simple Website to verify and test your configuration with. Apprise API was designed to easily fit into existing (and new) eco-systems that are looking for a simple notification solution.

354K pulls per month48 GitHub starsarm64