# [Healthchecks](https://github.com/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.

---
version: "2.1"
services:
  healthchecks:
    image: ghcr.io/linuxserver/healthchecks
    container_name: healthchecks
    environment:
      # for UserID
      - PUID=${PUID:-1024}
      # for GroupID
      - PGID=${PGID:-100}
      # 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_ROOT=
      # The site's name (e.g., "Example Corp HealthChecks")
      - SITE_NAME=
      # From email for alerts
      - DEFAULT_FROM_EMAIL=
      # SMTP host
      - EMAIL_HOST=
      # SMTP port
      - EMAIL_PORT=
      # SMTP user
      - EMAIL_HOST_USER=
      # SMTP password
      - EMAIL_HOST_PASSWORD=
      # Use TLS for SMTP (`True` or `False`)
      - EMAIL_USE_TLS=
      # Superuser email
      - SUPERUSER_EMAIL=
      # Superuser password
      - SUPERUSER_PASSWORD=
      # 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.
      - REGENERATE_SETTINGS= # optional
      # Array of valid hostnames for the server `["test.com","test2.com"]` (default: `["*"]`)
      - ALLOWED_HOSTS= # optional
      # Defaults to False. A boolean that turns on/off the Apprise integration (https://github.com/caronc/apprise)
      - APPRISE_ENABLED= # optional
      # Defaults to True. Debug mode relaxes CSRF protections and increases logging verbosity but should be disabled for production instances as it will impact performance and security.
      - DEBUG= # optional
      # Defaults to False. Set to True to allow integrations to connect to private IP addresses.
      - INTEGRATIONS_ALLOW_PRIVATE_IPS= # optional
      # The domain to use for generating ping email addresses.
      - PING_EMAIL_DOMAIN= # optional
      # A secret key used for cryptographic signing. Will generate a secure value if one is not supplied
      - SECRET_KEY= # optional
      # Full URL to custom site logo
      - SITE_LOGO_URL= # optional
    volumes:
      # Database and healthchecks config directory
      - ${BASEDIR:-/volume1/docker}/healthchecks/config:/config
    ports:
      # Healthchecks Web UI
      - 8000:8000
      # Port for inbound SMTP pings
      - 2525:2525 # optional
    restart: unless-stopped