Bot Updating Documentation

pull/19/head
LinuxServer-CI 2020-10-04 08:37:55 -04:00
rodzic 47473ff292
commit bbd9f97a17
1 zmienionych plików z 28 dodań i 28 usunięć

Wyświetl plik

@ -32,32 +32,7 @@ The architectures supported by this image are:
Here are some example snippets to help you get started creating a container from this image.
### docker
```
docker create \
--name=healthchecks \
-e PUID=1000 \
-e PGID=1000 \
-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=<True or False> \
-e ALLOWED_HOSTS=<ALLOWED_HOSTS> \
-e SUPERUSER_EMAIL=<SUPERUSER_EMAIL> \
-e SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD> \
-p 8000:8000 \
-v <path to data on host>:/config \
--restart unless-stopped \
linuxserver/healthchecks
```
### docker-compose
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
Compatible with docker-compose v2 schemas.
@ -89,6 +64,31 @@ services:
restart: unless-stopped
```
### docker cli
```
docker run -d \
--name=healthchecks \
-e PUID=1000 \
-e PGID=1000 \
-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=<True or False> \
-e ALLOWED_HOSTS=<ALLOWED_HOSTS> \
-e SUPERUSER_EMAIL=<SUPERUSER_EMAIL> \
-e SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD> \
-p 8000:8000 \
-v <path to data on host>:/config \
--restart unless-stopped \
linuxserver/healthchecks
```
## 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.
@ -163,9 +163,9 @@ Access the WebUI at <your-ip>:8000. For more information, check out [Healthcheck
## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&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?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=healthchecks&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 Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
## Support Info