--- title: healthchecks --- # [linuxserver/healthchecks](https://github.com/linuxserver/docker-healthchecks) [![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fhealthchecks?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fhealthchecks) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-healthchecks.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-healthchecks) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-healthchecks.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-healthchecks/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-healthchecks/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-healthchecks/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/healthchecks) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/healthchecks.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/healthchecks) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/healthchecks.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/healthchecks) [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-healthchecks%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-healthchecks/job/master/) [![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fhealthchecks%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/healthchecks/latest/index.html) [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. ## Supported Architectures We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). Simply pulling `lscr.io/linuxserver/healthchecks:latest` 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 | Available | Tag | | :----: | :----: | ---- | | x86-64 | ✅ | amd64-\ | | arm64 | ✅ | arm64v8-\ | | armhf | ❌ | | ## Application Setup Access the WebUI at :8000. For more information, check out [Healthchecks](https://github.com/healthchecks/healthchecks). ## Note on `CSRF_TRUSTED_ORIGINS` On first run (or any startup where `REGENERATE_SETTINGS=true`) we will set `CSRF_TRUSTED_ORIGINS` to match the value of `SITE_ROOT`. If you need different/additional origins, you will need to edit `/config/local_settings.py` and add them yourself. Note that setting `REGENERATE_SETTINGS=true` will overwrite any changes on startup. ## Usage To help you get started creating a container from this image you can either use docker-compose or the docker cli. ### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) ```yaml --- version: "2.1" services: healthchecks: image: lscr.io/linuxserver/healthchecks:latest container_name: healthchecks environment: - PUID=1000 - PGID=1000 - TZ=Etc/UTC - SITE_ROOT= - SITE_NAME= - DEFAULT_FROM_EMAIL= - EMAIL_HOST= - EMAIL_PORT= - EMAIL_HOST_USER= - EMAIL_HOST_PASSWORD= - EMAIL_USE_TLS= - SUPERUSER_EMAIL= - SUPERUSER_PASSWORD= - REGENERATE_SETTINGS= #optional - ALLOWED_HOSTS= #optional - APPRISE_ENABLED= #optional - DEBUG= #optional - INTEGRATIONS_ALLOW_PRIVATE_IPS= #optional - PING_EMAIL_DOMAIN= #optional - SECRET_KEY= #optional - SITE_LOGO_URL= #optional volumes: - /path/to/data:/config ports: - 8000:8000 - 2525:2525 #optional restart: unless-stopped ``` ### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) ```bash docker run -d \ --name=healthchecks \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Etc/UTC \ -e SITE_ROOT= \ -e SITE_NAME= \ -e DEFAULT_FROM_EMAIL= \ -e EMAIL_HOST= \ -e EMAIL_PORT= \ -e EMAIL_HOST_USER= \ -e EMAIL_HOST_PASSWORD= \ -e EMAIL_USE_TLS= \ -e SUPERUSER_EMAIL= \ -e SUPERUSER_PASSWORD= \ -e REGENERATE_SETTINGS= `#optional` \ -e ALLOWED_HOSTS= `#optional` \ -e APPRISE_ENABLED= `#optional` \ -e DEBUG= `#optional` \ -e INTEGRATIONS_ALLOW_PRIVATE_IPS= `#optional` \ -e PING_EMAIL_DOMAIN= `#optional` \ -e SECRET_KEY= `#optional` \ -e SITE_LOGO_URL= `#optional` \ -p 8000:8000 \ -p 2525:2525 `#optional` \ -v /path/to/data:/config \ --restart unless-stopped \ lscr.io/linuxserver/healthchecks:latest ``` ## Parameters Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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` | Healthchecks Web UI | | `2525` | Port for inbound SMTP pings | ### Environment Variables (`-e`) | Env | Function | | :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | | `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=` | The site's name (e.g., "Example Corp HealthChecks") | | `DEFAULT_FROM_EMAIL=` | From email for alerts | | `EMAIL_HOST=` | SMTP host | | `EMAIL_PORT=` | SMTP port | | `EMAIL_HOST_USER=` | SMTP user | | `EMAIL_HOST_PASSWORD=` | SMTP password | | `EMAIL_USE_TLS=` | Use TLS for SMTP (`True` or `False`) | | `SUPERUSER_EMAIL=` | Superuser email | | `SUPERUSER_PASSWORD=` | Superuser password | | `REGENERATE_SETTINGS=` | 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. | | `ALLOWED_HOSTS=` | Array of valid hostnames for the server `["test.com","test2.com"]` (default: `["*"]`) | | `APPRISE_ENABLED=` | Defaults to False. A boolean that turns on/off the Apprise integration (https://github.com/caronc/apprise) | | `DEBUG=` | 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. | | `INTEGRATIONS_ALLOW_PRIVATE_IPS=` | Defaults to False. Set to True to allow integrations to connect to private IP addresses. | | `PING_EMAIL_DOMAIN=` | The domain to use for generating ping email addresses. | | `SECRET_KEY=` | A secret key used for cryptographic signing. Will generate a secure value if one is not supplied | | `SITE_LOGO_URL=` | Full URL to custom site logo | ### Volume Mappings (`-v`) | Volume | Function | | :----: | --- | | `/config` | Database and healthchecks config directory | #### Miscellaneous Options | Parameter | Function | | :-----: | --- | ## Environment variables from files (Docker secrets) You can set any environment variable from a file by using a special prepend `FILE__`. As an example: ```bash -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](https://en.wikipedia.org/wiki/Umask) 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: ```bash $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` ## Docker Mods [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=healthchecks&query=%24.mods%5B%27healthchecks%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=healthchecks "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") We publish various [Docker Mods](https://github.com/linuxserver/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" }}' lscr.io/linuxserver/healthchecks:latest` ## Versions * **31.05.23:** - Rebase to Alpine 3.18. Deprecate armhf. * **22.12.22:** - Rebase to Alpine 3.17. Add extra deps for pycurl. Add INTEGRATIONS_ALLOW_PRIVATE_IPS. * **18.10.22:** - Add curl-dev to fix broken pip builds. * **11.10.22:** - Rebase to Alpine 3.16, migrate to s6v3. * **27.09.22:** - Fix sending of Email Reports * **08.01.22:** - Fix CSRF setting for Django 4.0 (introduced in v1.25.0) * **11.11.21:** - Add Apprise to Docker as in v1.24.0 * **10.09.21:** - Fix creation of superuser * **07.08.21:** - Update custom logo handling to support changes in v1.22.0 * **11.07.21:** - Rebase to Alpine 3.14. * **18.05.21:** - Add linuxserver wheel index. * **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.