[![](https://images.microbadger.com/badges/version/linuxserver/healthchecks.svg)](https://microbadger.com/images/linuxserver/healthchecks "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/healthchecks.svg)](https://microbadger.com/images/linuxserver/healthchecks "Get your own version badge on microbadger.com")
[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.
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/).
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 |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
```
docker create \
--name=healthchecks \
-e PUID=1001 \
-e PGID=1001 \
-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> \
-e EMAIL_USE_TLS=<EMAIL_USE_TLS> \
-e ALLOWED_HOSTS=<ALLOWED_HOSTS> \
-p 8000:8000 \
-v <pathtodata>:/config \
--restart unless-stopped \
linuxserver/healthchecks
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
healthchecks:
image: linuxserver/healthchecks
container_name: healthchecks
environment:
- PUID=1001
- PGID=1001
- 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>
- EMAIL_USE_TLS=<EMAIL_USE_TLS>
- ALLOWED_HOSTS=<ALLOWED_HOSTS>
volumes:
-<pathtodata>:/config
ports:
- 8000:8000
mem_limit: 4096m
restart: unless-stopped
```
## Parameters
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.
### Ports (`-p`)
| Parameter | Function |
| :----: | --- |
| `8000` | will map the container's port 8000 to port 8000 on the host |
### Environment Variables (`-e`)
| Env | Function |
| :----: | --- |
| `PUID=1001` | for UserID - see below for explanation |
| `PGID=1001` | for GroupID - see below for explanation |
| `SITE_ROOT=<SITE_ROOT>` | The site's domain (i.e., example.com) |
| `SITE_NAME=<SITE_NAME>` | The site's name |
| `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_USE_TLS=<EMAIL_USE_TLS>` | Use TLS for SMTP |
| `ALLOWED_HOSTS=<ALLOWED_HOSTS>` | array of valid hostnames for the server ["test.com","test2.com"] |
### Volume Mappings (`-v`)
| Volume | Function |
| :----: | --- |
| `/config` | database and healthchecks config |
## 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=1001` and `PGID=1001`, to find yours use `id user` as below: