You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

65 lines
2.8 KiB
YAML

# [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}
# specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
- TZ=${TZ:-Europe/Amsterdam}
# 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).
- SITE_ROOT=
# The site's name (e.g., "Example Corp HealthChecks").
- SITE_NAME=
# Superuser email.
- SUPERUSER_EMAIL=
# Superuser password.
- SUPERUSER_PASSWORD=
# A comma-separated list of valid hostnames for the server. Default is: `*`.
- ALLOWED_HOSTS= # optional
# Set to `True` to enable the Apprise integration (https://github.com/caronc/apprise).
- APPRISE_ENABLED=False # optional
# 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`.
- CSRF_TRUSTED_ORIGINS= # optional
# Set 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.
- DEBUG=True # optional
# From email for alerts.
- DEFAULT_FROM_EMAIL= # optional
# SMTP host.
- EMAIL_HOST= # optional
# SMTP port.
- EMAIL_PORT= # optional
# SMTP user.
- EMAIL_HOST_USER= # optional
# SMTP password.
- EMAIL_HOST_PASSWORD= # optional
# Use TLS for SMTP (`True` or `False`).
- EMAIL_USE_TLS= # 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. Defaults to `localhost`.
- PING_EMAIL_DOMAIN= # optional
# If using webauthn for 2FA set this to match your Healthchecks domain. Webauthn will only work over https.
- RP_ID= # optional
# 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`.
- SECRET_KEY= # optional
# Full URL to custom site logo.
- SITE_LOGO_URL= # optional
volumes:
# Persistent config files.
- ${BASEDIR:-/volume1/docker}/healthchecks/config:/config
ports:
# Healthchecks Web UI
- 8000:8000
# Port for inbound SMTP pings
- 2525:2525 # optional
restart: unless-stopped