2020-04-28 15:23:37 +00:00
# linuxserver/healthchecks
2019-02-10 13:38:37 +00:00
2020-04-28 15:23:37 +00:00
[![GitHub Stars ](https://img.shields.io/github/stars/linuxserver/docker-healthchecks.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-healthchecks) [![GitHub Release ](https://img.shields.io/github/release/linuxserver/docker-healthchecks.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-healthchecks/releases) [![GitHub Package Repository ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-healthchecks/packages) [![GitLab Container Registry ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF )](https://gitlab.com/Linuxserver.io/docker-healthchecks/container_registry) [![Quay.io ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io )](https://quay.io/repository/linuxserver.io/healthchecks) [![MicroBadger Layers ](https://img.shields.io/microbadger/layers/linuxserver/healthchecks.svg?style=flat-square&color=E68523 )](https://microbadger.com/images/linuxserver/healthchecks) [![Docker Pulls ](https://img.shields.io/docker/pulls/linuxserver/healthchecks.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF )](https://hub.docker.com/r/linuxserver/healthchecks) [![Docker Stars ](https://img.shields.io/docker/stars/linuxserver/healthchecks.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF )](https://hub.docker.com/r/linuxserver/healthchecks) [![Build Status ](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-healthchecks/job/master/badge/icon?style=flat-square )](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-healthchecks/job/master/) [![ ](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/healthchecks/latest/badge.svg )](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/healthchecks/latest/index.html)
2019-02-10 13:38:37 +00:00
2020-04-28 15:23:37 +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.
2019-09-29 12:37:54 +00:00
2019-02-10 13:38:37 +00:00
## Supported Architectures
2019-09-01 12:38:04 +00:00
Our images support multiple architectures such as `x86-64` , `arm64` and `armhf` . 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/ ).
2019-02-10 13:38:37 +00:00
Simply pulling `linuxserver/healthchecks` 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 | Tag |
2020-04-28 15:23:37 +00:00
| :---: | :--- |
2019-02-10 13:38:37 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 19:41:19 +00:00
| armhf | arm32v7-latest |
2019-02-10 13:38:37 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-04-28 15:23:37 +00:00
```text
2019-02-10 13:38:37 +00:00
docker create \
--name=healthchecks \
2019-03-03 13:37:46 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-10 13:38:37 +00:00
-e SITE_ROOT=< SITE_ROOT > \
-e SITE_NAME=< SITE_NAME > \
-e DEFAULT_FROM_EMAIL=< DEFAULT_FROM_EMAIL > \
-e EMAIL_HOST=< EMAIL_HOST > \
-e EMAIL_PORT=< EMAIL_PORT > \
-e EMAIL_HOST_USER=< EMAIL_HOST_USER > \
-e EMAIL_HOST_PASSWORD=< EMAIL_HOST_PASSWORD > \
2020-04-21 13:55:49 +00:00
-e EMAIL_USE_TLS=< True or False > \
2019-02-10 13:38:37 +00:00
-e ALLOWED_HOSTS=< ALLOWED_HOSTS > \
2019-10-24 18:42:59 +00:00
-e SUPERUSER_EMAIL=< SUPERUSER_EMAIL > \
-e SUPERUSER_PASSWORD=< SUPERUSER_PASSWORD > \
2019-02-10 13:38:37 +00:00
-p 8000:8000 \
2020-04-21 02:49:00 +00:00
-v < path to data on host > :/config \
2019-02-10 13:38:37 +00:00
--restart unless-stopped \
linuxserver/healthchecks
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-12 12:38:13 +00:00
version: "2.1"
2019-02-10 13:38:37 +00:00
services:
healthchecks:
image: linuxserver/healthchecks
container_name: healthchecks
environment:
2019-03-03 13:37:46 +00:00
- PUID=1000
- PGID=1000
2019-02-10 13:38:37 +00:00
- SITE_ROOT=< SITE_ROOT >
- SITE_NAME=< SITE_NAME >
- DEFAULT_FROM_EMAIL=< DEFAULT_FROM_EMAIL >
- EMAIL_HOST=< EMAIL_HOST >
- EMAIL_PORT=< EMAIL_PORT >
- EMAIL_HOST_USER=< EMAIL_HOST_USER >
- EMAIL_HOST_PASSWORD=< EMAIL_HOST_PASSWORD >
2020-04-21 13:55:49 +00:00
- EMAIL_USE_TLS=< True or False >
2019-02-10 13:38:37 +00:00
- ALLOWED_HOSTS=< ALLOWED_HOSTS >
2019-10-24 18:42:59 +00:00
- SUPERUSER_EMAIL=< SUPERUSER_EMAIL >
- SUPERUSER_PASSWORD=< SUPERUSER_PASSWORD >
2019-02-10 13:38:37 +00:00
volumes:
2020-04-21 02:49:00 +00:00
- < path to data on host > :/config
2019-02-10 13:38:37 +00:00
ports:
- 8000:8000
restart: unless-stopped
```
## Parameters
2020-04-28 15:23:37 +00:00
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` 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.
2019-02-10 13:38:37 +00:00
2020-04-28 15:23:37 +00:00
### Ports \(`-p`\)
2019-02-10 13:38:37 +00:00
| Parameter | Function |
2020-04-28 15:23:37 +00:00
| :---: | :--- |
2019-02-10 13:38:37 +00:00
| `8000` | will map the container's port 8000 to port 8000 on the host |
2020-04-28 15:23:37 +00:00
### Environment Variables \(`-e`\)
2019-02-10 13:38:37 +00:00
| Env | Function |
2020-04-28 15:23:37 +00:00
| :---: | :--- |
2019-03-03 13:37:46 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2020-04-28 15:23:37 +00:00
| `SITE_ROOT=<SITE_ROOT>` | The site's top-level URL \(e.g., [https://healthchecks.example.com ](https://healthchecks.example.com )\) |
| `SITE_NAME=<SITE_NAME>` | The site's name \(e.g., "Example Corp HealthChecks"\) |
2019-02-10 13:38:37 +00:00
| `DEFAULT_FROM_EMAIL=<DEFAULT_FROM_EMAIL>` | From email for alerts |
| `EMAIL_HOST=<EMAIL_HOST>` | SMTP host |
| `EMAIL_PORT=<EMAIL_PORT>` | SMTP port |
| `EMAIL_HOST_USER=<EMAIL_HOST_USER>` | SMTP user |
| `EMAIL_HOST_PASSWORD=<EMAIL_HOST_PASSWORD>` | SMTP password |
2020-04-28 15:23:37 +00:00
| `EMAIL_USE_TLS=<True or False>` | Use TLS for SMTP \(`True` or `False` \) |
2020-04-21 02:49:00 +00:00
| `ALLOWED_HOSTS=<ALLOWED_HOSTS>` | array of valid hostnames for the server `["test.com","test2.com"]` or `"*"` |
2020-04-21 13:55:49 +00:00
| `SUPERUSER_EMAIL=<SUPERUSER_EMAIL>` | Superuser email |
2019-10-24 18:42:59 +00:00
| `SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>` | Superuser password |
2019-02-10 13:38:37 +00:00
2020-04-28 15:23:37 +00:00
### Volume Mappings \(`-v`\)
2019-02-10 13:38:37 +00:00
| Volume | Function |
2020-04-28 15:23:37 +00:00
| :---: | :--- |
2020-04-21 02:49:00 +00:00
| `/config` | database and healthchecks config directory volume mapping |
2019-02-10 13:38:37 +00:00
## User / Group Identifiers
2020-04-28 15:23:37 +00:00
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` .
2019-02-10 13:38:37 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-03 13:37:46 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-10 13:38:37 +00:00
2020-04-28 15:23:37 +00:00
```text
2019-02-10 13:38:37 +00:00
$ id username
2019-03-03 13:37:46 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-10 13:38:37 +00:00
```
## Application Setup
2020-04-28 15:23:37 +00:00
Access the WebUI at :8000. For more information, check out [Healthchecks ](https://github.com/healthchecks/healthchecks ).
2019-09-29 12:37:54 +00:00
2020-04-12 12:38:13 +00:00
## Docker Mods
2020-04-28 15:23:37 +00:00
[![Docker Mods ](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&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)
2020-04-12 12:38:13 +00:00
2020-04-28 15:23:37 +00:00
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\) can be accessed via the dynamic badge above.
2019-02-10 13:38:37 +00:00
## Support Info
2019-09-01 12:38:04 +00:00
* Shell access whilst the container is running:
2019-02-10 13:38:37 +00:00
* `docker exec -it healthchecks /bin/bash`
2019-09-01 12:38:04 +00:00
* To monitor the logs of the container in realtime:
2019-02-10 13:38:37 +00:00
* `docker logs -f healthchecks`
2019-09-01 12:38:04 +00:00
* Container version number
2019-02-10 13:38:37 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' healthchecks`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/healthchecks`
## Versions
2020-04-12 17:38:23 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-11-12 17:26:17 +00:00
* **31.10.19:** - Add postgres client and fix config for CSRF.
2019-10-24 18:42:59 +00:00
* **23.10.19:** - Allow to create superuser
2019-10-31 21:22:47 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-04-13 06:29:34 +00:00
* **12.04.19:** - Rebase to Alpine 3.9.
2019-03-24 19:41:19 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-03-01 00:24:49 +00:00
* **14.02.19:** - Adding mysql libs needed for using a database.
2019-02-10 13:38:37 +00:00
* **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.
2020-04-28 15:23:37 +00:00