From 118479e05e295b3a8a2893dd11cc3f166b1556d5 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sun, 10 Feb 2019 13:38:37 +0000 Subject: [PATCH] Bot Updating Templated Files --- images/docker-healthchecks.md | 157 ++++++++++++++++++++++++++++++++++ 1 file changed, 157 insertions(+) create mode 100755 images/docker-healthchecks.md diff --git a/images/docker-healthchecks.md b/images/docker-healthchecks.md new file mode 100755 index 000000000..2fa07ef0e --- /dev/null +++ b/images/docker-healthchecks.md @@ -0,0 +1,157 @@ +# [linuxserver/healthchecks](https://github.com/linuxserver/docker-healthchecks) + +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) +[![](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") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/healthchecks.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/healthchecks.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-healthchecks/master)](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) + +[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 + +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). + +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= \ + -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 ALLOWED_HOSTS= \ + -p 8000:8000 \ + -v :/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_NAME= + - DEFAULT_FROM_EMAIL= + - EMAIL_HOST= + - EMAIL_PORT= + - EMAIL_HOST_USER= + - EMAIL_HOST_PASSWORD= + - EMAIL_USE_TLS= + - ALLOWED_HOSTS= + volumes: + - :/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 `:` 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=` | The site's domain (i.e., example.com) | +| `SITE_NAME=` | The site's name | +| `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 | +| `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: + +``` + $ id username + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) +``` + +## Application Setup + +Access the WebUI at :8000. For more information, check out [Healthchecks](https://github.com/healthchecks/healthchecks). + + + +## 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" }}' linuxserver/healthchecks` + +## Versions + +* **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.