2021-04-21 00:55:42 +00:00
# [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.
2021-04-10 10:16:29 +00:00
---
version : "2.1"
services :
healthchecks :
image : ghcr.io/linuxserver/healthchecks
container_name : healthchecks
environment :
# for UserID
2022-04-02 00:45:58 +00:00
- PUID=${PUID:-1024}
# for GroupID
2021-04-10 10:16:29 +00:00
- PGID=${PGID:-100}
2023-02-12 01:01:09 +00:00
# specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
- TZ=Etc/UTC
2021-04-10 10:16:29 +00:00
# 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)
2022-10-12 01:24:00 +00:00
- SITE_ROOT=
2021-04-10 10:16:29 +00:00
# The site's name (e.g., "Example Corp HealthChecks")
2022-10-12 01:24:00 +00:00
- SITE_NAME=
2021-04-10 10:16:29 +00:00
# From email for alerts
2022-10-12 01:24:00 +00:00
- DEFAULT_FROM_EMAIL=
2021-04-10 10:16:29 +00:00
# SMTP host
2022-10-12 01:24:00 +00:00
- EMAIL_HOST=
2021-04-10 10:16:29 +00:00
# SMTP port
2022-10-12 01:24:00 +00:00
- EMAIL_PORT=
2021-04-10 10:16:29 +00:00
# SMTP user
2022-10-12 01:24:00 +00:00
- EMAIL_HOST_USER=
2021-04-10 10:16:29 +00:00
# SMTP password
2022-10-12 01:24:00 +00:00
- EMAIL_HOST_PASSWORD=
2021-04-10 10:16:29 +00:00
# Use TLS for SMTP (`True` or `False`)
2022-10-12 01:24:00 +00:00
- EMAIL_USE_TLS=
2021-04-10 10:16:29 +00:00
# Superuser email
2022-10-12 01:24:00 +00:00
- SUPERUSER_EMAIL=
2021-04-10 10:16:29 +00:00
# Superuser password
2022-10-12 01:24:00 +00:00
- SUPERUSER_PASSWORD=
2022-12-24 00:49:31 +00:00
# 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.
2022-10-12 01:24:00 +00:00
- REGENERATE_SETTINGS= # optional
# Array of valid hostnames for the server `["test.com","test2.com"]` (default: `["*"]`)
- ALLOWED_HOSTS= # optional
2022-01-09 00:38:34 +00:00
# Defaults to False. A boolean that turns on/off the Apprise integration (https://github.com/caronc/apprise)
2022-10-12 01:24:00 +00:00
- APPRISE_ENABLED= # optional
2022-11-04 01:06:58 +00:00
# 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
2022-12-24 00:49:31 +00:00
# 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
2021-04-10 10:16:29 +00:00
volumes :
2022-10-12 01:24:00 +00:00
# Database and healthchecks config directory
2021-04-10 10:16:29 +00:00
- ${BASEDIR:-/volume1/docker}/healthchecks/config:/config
ports :
2022-12-24 00:49:31 +00:00
# Healthchecks Web UI
2021-04-10 10:16:29 +00:00
- 8000 : 8000
2022-12-24 00:49:31 +00:00
# Port for inbound SMTP pings
- 2525 : 2525 # optional
2021-04-10 10:16:29 +00:00
restart : unless-stopped