From b94faa3fafcd80d1ee7ddd82945c608467aa4101 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sun, 3 May 2020 12:37:52 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-healthchecks.md | 56 ++++++++++++++++++++++------------- 1 file changed, 36 insertions(+), 20 deletions(-) diff --git a/images/docker-healthchecks.md b/images/docker-healthchecks.md index 5cf9942dd3..3401a0ad88 100644 --- a/images/docker-healthchecks.md +++ b/images/docker-healthchecks.md @@ -1,9 +1,19 @@ -# linuxserver/healthchecks +# [linuxserver/healthchecks](https://github.com/linuxserver/docker-healthchecks) -[![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) +[![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 "Get your own version badge on microbadger.com") +[![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) [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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). @@ -13,18 +23,19 @@ Simply pulling `linuxserver/healthchecks` should retrieve the correct image for The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | + ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -```text +``` docker create \ --name=healthchecks \ -e PUID=1000 \ @@ -46,6 +57,7 @@ docker create \ linuxserver/healthchecks ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -80,60 +92,65 @@ services: ## 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. +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`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | | `8000` | will map the container's port 8000 to port 8000 on the host | -### Environment Variables \(`-e`\) + +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | -| `SITE_ROOT=` | The site's top-level URL \(e.g., [https://healthchecks.example.com](https://healthchecks.example.com)\) | -| `SITE_NAME=` | The site's name \(e.g., "Example Corp HealthChecks"\) | +| `SITE_ROOT=` | The site's top-level URL (e.g., https://healthchecks.example.com) | +| `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`\) | +| `EMAIL_USE_TLS=` | Use TLS for SMTP (`True` or `False`) | | `ALLOWED_HOSTS=` | array of valid hostnames for the server `["test.com","test2.com"]` or `"*"` | | `SUPERUSER_EMAIL=` | Superuser email | | `SUPERUSER_PASSWORD=` | Superuser password | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | database and healthchecks config directory volume mapping | + + + ## 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`. +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: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` ## Application Setup -Access the WebUI at :8000. For more information, check out [Healthchecks](https://github.com/healthchecks/healthchecks). +Access the WebUI at :8000. For more information, check out [Healthchecks](https://github.com/healthchecks/healthchecks). + ## Docker Mods +[![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 "view available mods for this container.") -[![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) +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. -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. ## Support Info @@ -159,4 +176,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * **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. -