https://github.com/crazy-max/docker-healthchecks
Healthchecks Docker image
https://github.com/crazy-max/docker-healthchecks
alpine-linux docker healthchecks multi-platform
Last synced: 10 days ago
JSON representation
Healthchecks Docker image
- Host: GitHub
- URL: https://github.com/crazy-max/docker-healthchecks
- Owner: crazy-max
- License: mit
- Created: 2020-10-11T19:40:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-23T12:36:25.000Z (10 months ago)
- Last Synced: 2024-10-18T07:32:45.871Z (6 months ago)
- Topics: alpine-linux, docker, healthchecks, multi-platform
- Language: Dockerfile
- Homepage:
- Size: 149 KB
- Stars: 39
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
## ⚠️ Abandoned project
This project is not maintained anymore and is abandoned. Feel free to fork and
make your own changes, or you can switch to the [official image](https://hub.docker.com/r/healthchecks/healthchecks).
## About
Docker image for [Healthchecks](https://github.com/healthchecks/healthchecks),
a cron monitoring tool.
> [!TIP]
> Want to be notified of new releases? Check out 🔔 [Diun (Docker Image Update Notifier)](https://github.com/crazy-max/diun)
> project!
___
* [Features](#features)
* [Build locally](#build-locally)
* [Image](#image)
* [Environment variables](#environment-variables)
* [Ports](#ports)
* [Usage](#usage)
* [Docker Compose](#docker-compose)
* [Command line](#command-line)
* [Upgrade](#upgrade)
* [Contributing](#contributing)
* [License](#license)
## Features
* Run as non-root user
* Multi-platform image
* [Traefik](https://github.com/containous/traefik-library-image) as reverse proxy and creation/renewal of Let's Encrypt certificates (see [this template](examples/traefik))
## Build locally
```shell
git clone https://github.com/crazy-max/docker-healthchecks.git
cd docker-healthchecks
# Build image and output to docker (default)
docker buildx bake
# Build multi-platform image
docker buildx bake image-all
```
## Image
| Registry | Image |
|--------------------------------------------------------------------------------------------------|---------------------------------|
| [Docker Hub](https://hub.docker.com/r/crazymax/healthchecks/) | `crazymax/healthchecks` |
| [GitHub Container Registry](https://github.com/users/crazy-max/packages/container/package/healthchecks) | `ghcr.io/crazy-max/healthchecks` |
Following platforms for this image are available:
```
$ docker buildx imagetools inspect crazymax/healthchecks --format "{{json .Manifest}}" | \
jq -r '.manifests[] | select(.platform.os != null and .platform.os != "unknown") | .platform | "\(.os)/\(.architecture)\(if .variant then "/" + .variant else "" end)"'
linux/amd64
linux/arm/v7
linux/arm64
```
## Environment variables
* `TZ`: The timezone assigned to the container (default `UTC`)
* `PUID`: Process UID (default `1000`)
* `PGID`: Process GID (default `1000`)
* `SUPERUSER_EMAIL`: Superuser email to access [admin panel](https://github.com/healthchecks/healthchecks#accessing-administration-panel)
* `SUPERUSER_PASSWORD`: Superuser password
* `USE_OFFICIAL_LOGO`: Replace generic logo with official branding (default `false`)
To configure the application, you just add the environment variables as shown in the
[Configuration page](https://github.com/healthchecks/healthchecks#configuration) of Healthchecks Project.
> 💡 `SUPERUSER_PASSWORD_FILE` can be used to fill in the value from a file, especially for Docker's secrets feature.
## Volumes
* `/data`: Contains SQLite database and static images folder
> :warning: Note that the volumes should be owned by the user/group with the specified `PUID` and `PGID`. If you don't
> give the volume correct permissions, the container may not start.
## Ports
* `2500`: [Healthchecks SMTP](https://github.com/healthchecks/healthchecks#receiving-emails) listener service
* `8000`: HTTP port
## Usage
### Docker Compose
Docker compose is the recommended way to run this image. You can use the following
[docker compose template](examples/compose/compose.yml), then run the container:
```bash
docker compose up -d
docker compose logs -f
```
### Command line
You can also use the following minimal command:
```bash
$ docker run -d -p 8000:8000 --name healthchecks \
-e "TZ=Europe/Paris" \
-e "SECRET_KEY=5up3rS3kr1t" \
-e "DB=sqlite" \
-e "DB_NAME=/data/hc.sqlite" \
-e "ALLOWED_HOSTS=*" \
-v $(pwd)/data:/data \
crazymax/healthchecks:latest
```
## Upgrade
Recreate the container whenever I push an update:
```bash
docker compose pull
docker compose up -d
```
## Contributing
Want to contribute? Awesome! The most basic way to show your support is to star
the project, or to raise issues. You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max)
or by making a [PayPal donation](https://www.paypal.me/crazyws) to ensure this
journey continues indefinitely!
Thanks again for your support, it is much appreciated! :pray:
## License
MIT. See `LICENSE` for more details.