1.5.43.1. linuxserver/healthchecks
[!TIP]
前半部分是翻译官方的文档,最后一部分是我的简单试用(个别软件会深度试用),如果对Docker已经有一定的了解了,可以直接跳转到最后面 翻译之外 这部分来查看。
Healthchecks → https://github.com/healthchecks/healthchecks
GitHub → https://github.com/linuxserver/docker-healthchecks
Docker Hub → https://hub.docker.com/r/linuxserver/healthchecks
Healthchecks 是cron任务的看门狗,可以侦听cron任务的运行情况,并提供给了Web界面。
1.5.43.1.1. 支持的系统架构
得益于docker的跨平台属性,我们的镜像也支持多架构(如,x86-64、arm64、armhf)。
直接拉取 ghcr.io/linuxserver/healthchecks
应该就可以自动获取适合你系统架构的版本,当然你也可以通过 tag 获取特定的版本。
架构 | Tag |
---|---|
x86-64 | amd64-latest |
arm64 | arm64v8-latest |
armhf | arm32v7-latest |
1.5.43.1.2. 拉取镜像
docker pull ghcr.io/linuxserver/healthchecks
1.5.43.1.3. 使用方法
以下是一些简单的示例。
1.5.43.1.3.1. docker-compose
兼容docker-compose v2
---
version: "2.1"
services:
healthchecks:
image: ghcr.io/linuxserver/healthchecks
container_name: healthchecks
environment:
- PUID=1000
- PGID=1000
- SITE_ROOT=<SITE_ROOT>
- SITE_NAME=<SITE_NAME>
- DEFAULT_FROM_EMAIL=<DEFAULT_FROM_EMAIL>
- EMAIL_HOST=<EMAIL_HOST>
- EMAIL_PORT=<EMAIL_PORT>
- EMAIL_HOST_USER=<EMAIL_HOST_USER>
- EMAIL_HOST_PASSWORD=<EMAIL_HOST_PASSWORD>
- EMAIL_USE_TLS=<True or False>
- ALLOWED_HOSTS=<ALLOWED_HOSTS>
- SUPERUSER_EMAIL=<SUPERUSER_EMAIL>
- SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>
volumes:
- <path to data on host>:/config
ports:
- 8000:8000
restart: unless-stopped
1.5.43.1.3.2. 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 \
ghcr.io/linuxserver/healthchecks
1.5.43.1.4. 参数
Docker镜像在使用的时候需要配置一些参数,这些参数使用 :
分隔,分别表示 宿主机:容器内
。例如 -p 8080:80
指的是将容器内的80
端口映射到宿主机上的8080
端口,即通过宿主机网络访问的话,访问8080
端口即是访问容器内的80
端口。
1.5.43.1.4.1. 端口(-p)
port | 说明 |
---|---|
8000 |
Web界面 |
1.5.43.1.4.2. 环境变量(-e)
env | 说明 |
---|---|
PUID=1000 |
用户的 UID,详见下面的说明 |
PGID=1000 |
用户的 GID,详见下面的说明 |
TZ=Europe/London |
设置时区,在国内的话可以使用 Asia/Shanghai |
SITE_ROOT=<SITE_ROOT> |
网站的URL(如 https://healthchecks.example.com) |
SITE_NAME=<SITE_NAME> |
网站的名称 |
DEFAULT_FROM_EMAIL=<DEFAULT_FROM_EMAIL> |
邮箱(用来发送警告) |
EMAIL_HOST=<EMAIL_HOST> |
SMTP 主机 |
EMAIL_PORT=<EMAIL_PORT> |
SMTP 端口 |
EMAIL_HOST_USER=<EMAIL_HOST_USER> |
SMTP 用户 |
EMAIL_HOST_PASSWORD=<EMAIL_HOST_PASSWORD> |
SMTP 密码 |
EMAIL_USE_TLS=<True or False> |
是否使用TLS(True or False ) |
ALLOWED_HOSTS=<ALLOWED_HOSTS> |
服务器的有效主机名 ["test.com", "test2.com"] 或 "*" |
SUPERUSER_EMAIL=<SUPERUSER_EMAIL> |
超级用户的邮箱 |
SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD> |
超级用户的密码 |
1.5.43.1.4.3. 卷映射(-v)
volume | 说明 |
---|---|
/config |
配置文件所在路径 |
1.5.43.1.5. 从文件加载环境变量
可以使用前缀名为 FILE__
的文件来加载环境变量。
例:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
将把 /run/secrets/mysecretpassword
文件中的内容作为 PASSWORD
变量的值。
1.5.43.1.6. 运行程序的umask(文件掩码)
我们所有的镜像都可以使用 -e UMASK=022 来设置覆盖容器内服务的umask。关于Linux umask可以通过这里了解,或自行百度学习。
1.5.43.1.7. UID和GID
当使用 -v
映射卷的时候,宿主机和容器内会出现关于权限的问题,我们的镜像可以通过指定 PUID
和 GUID
来避免此类问题。
可以使用你目前正在使用的用户的UID和GID进行设置,这样就不会存在权限问题。
可以通过如下的方式查看当前用户的UID和GID:
$ id $user
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
[!NOTE]
如果没特殊需求,可以将后续所有容器的id都设置为当前非root用户的id,这样会省去解决很多关于文件权限的问题(可以查看 什么是PUID和PGID 这篇文章了解更多)。当然,如果有特殊需要可以给不同的容器设置不同的id,即分配给不同的用户。使用
useradd
命令即可添加用户。通常来说,除root账户外,第一个建立的用户的UID和GID都是1000,然后递增生成。
1.5.43.1.8. 安装说明
访问 http://ip:8000
即可进行配置,更多信息请查看:https://github.com/healthchecks/healthchecks
1.5.43.1.9. 支持
- 进入容器:
docker exec -it healthchecks /bin/bash
- 查看容器日志:
docker logs -f healthchecks
- 查看容器版本号:
docker inspect -f '{{ index .Config.Labels "build_version" }}' healthchecks
- 查看镜像版本号:
docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/healthchecks
1.5.43.1.10. 翻译之外
暂未试用