kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
47298b1079
commit
ec8c8386b6
|
|
@ -1,9 +1,18 @@
|
|||
# linuxserver/healthchecks
|
||||
# [linuxserver/healthchecks](https://github.com/linuxserver/docker-healthchecks)
|
||||
|
||||
[](https://github.com/linuxserver/docker-healthchecks) [](https://github.com/linuxserver/docker-healthchecks/releases) [](https://github.com/linuxserver/docker-healthchecks/packages) [](https://gitlab.com/Linuxserver.io/docker-healthchecks/container_registry) [](https://microbadger.com/images/linuxserver/healthchecks) [](https://hub.docker.com/r/linuxserver/healthchecks) [](https://hub.docker.com/r/linuxserver/healthchecks) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-healthchecks/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/healthchecks/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-healthchecks)
|
||||
[](https://github.com/linuxserver/docker-healthchecks/releases)
|
||||
[](https://github.com/linuxserver/docker-healthchecks/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-healthchecks/container_registry)
|
||||
[](https://microbadger.com/images/linuxserver/healthchecks "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/healthchecks)
|
||||
[](https://hub.docker.com/r/linuxserver/healthchecks)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-healthchecks/job/master/)
|
||||
[](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 +22,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 +56,7 @@ docker create \
|
|||
linuxserver/healthchecks
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -80,45 +91,48 @@ services:
|
|||
|
||||
## 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.
|
||||
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`\)
|
||||
### 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=<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"\) |
|
||||
| `SITE_ROOT=<SITE_ROOT>` | The site's top-level URL (e.g., https://healthchecks.example.com) |
|
||||
| `SITE_NAME=<SITE_NAME>` | The site's name (e.g., "Example Corp HealthChecks") |
|
||||
| `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 |
|
||||
| `EMAIL_USE_TLS=<True or False>` | Use TLS for SMTP \(`True` or `False`\) |
|
||||
| `EMAIL_USE_TLS=<True or False>` | Use TLS for SMTP (`True` or `False`) |
|
||||
| `ALLOWED_HOSTS=<ALLOWED_HOSTS>` | array of valid hostnames for the server `["test.com","test2.com"]` or `"*"` |
|
||||
| `SUPERUSER_EMAIL=<SUPERUSER_EMAIL>` | Superuser email |
|
||||
| `SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>` | Superuser password |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | database and healthchecks config directory volume mapping |
|
||||
|
||||
## Environment variables from files \(Docker secrets\)
|
||||
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```text
|
||||
```
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
|
|
@ -126,30 +140,33 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
|||
|
||||
## Umask for running applications
|
||||
|
||||
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
|
||||
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||
|
||||
|
||||
## 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 <your-ip>:8000. For more information, check out [Healthchecks](https://github.com/healthchecks/healthchecks).
|
||||
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=healthchecks "view available mods for this container.")
|
||||
|
||||
[](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
|
||||
|
||||
|
|
@ -175,4 +192,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.
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue