galexrt/healthchecks

docker-healthchecks

![Docker Repository on Quay.io]([***]

镜像可从以下地址获取：

• Quay.io
• https://hub.docker.com/r/galexrt/healthchecks

用于 https://github.com/healthchecks/healthchecks 的易用Docker镜像。

Healthchecks版本

当前镜像中安装的Healthchecks版本为 v1.21.0。

运行镜像

注意 默认情况下，Healthchecks使用SQLite数据库，位于 /data/hc.sqlite。

要配置 https://github.com/healthchecks/healthchecks 服务器，只需添加环境变量，如Healthchecks项目的 https://github.com/healthchecks/healthchecks/blob/master/hc/settings.py 所示。

bash
docker run \
    -d \
    --name=healthchecks \
    -p 80:8000 \
    -e 'DB_NAME=/data/hc.sqlite' \
    -e 'SECRET_KEY=YOUR_SECRET_KEY' \
    -e 'PING_EMAIL_DOMAIN=example.com' \
    -e 'SITE_ROOT=http://example.com' \
    -e 'EMAIL_HOST=smtp.example.com' \
    -e 'EMAIL_PORT=25' \
    -e 'EMAIL_USE_TLS=True' \
    -e 'EMAIL_HOST_USER=user@example.com' \
    -e 'EMAIL_HOST_PASSWORD=YOUR_PASSWORD' \
    -e 'ALLOWED_HOSTS=localhost,*' \
    -e 'CONTAINER_PRUNE_INTERVAL=600' \
    -v /opt/docker/healthchecks/data:/data \
    galexrt/healthchecks:latest

警告 默认使用SQLite数据库，更多信息请查看 数据库配置 部分。如果不使用SQLite，可以移除 -v ...:... 标志（除非有其他需要）。

注意 如果要使用 https://github.com/healthchecks/healthchecks#receiving-emails%EF%BC%8C%E6%B7%BB%E5%8A%A0 -p 2525:2525 标志（容器内端口 2525/tcp 不可更改）。

容器内Healthchecks的端口为 8000/tcp，在示例命令中映射到主机的 80/tcp。

Healthchecks需要HTTPS代理才能正常访问，这是因为未使用HTTPS时CSRF验证会失败。HTTPS代理必须传递/创建 X-FORWARDED-* 头。Docker的简单HTTPS代理示例可参考：https://github.com/jwilder/nginx-proxy%E3%80%82

生产环境运行

有关安全配置的信息，请查阅官方 https://github.com/healthchecks/healthchecks#running-in-production%E3%80%82

数据库配置

默认 情况下使用SQLite，除非另行配置。

警告 对于SQLite，DB_NAME 必须设置为 /data/hc.sqlite。应将卷挂载到容器内的 /data（docker run [...] -v /opt/docker/healthchecks/data:/data [...] galexrt/healthchecks:latest），否则容器删除后SQLite数据库会丢失。

当不使用SQLite时，可通过以下环境变量配置数据库连接：

（参见 https://github.com/healthchecks/healthchecks/blob/master/hc/settings.py#L100-L142%EF%BC%89

邮件配置

可通过以下环境变量配置邮件通知（使用SMTP）：

（参见 https://github.com/healthchecks/healthchecks/blob/master/hc/settings.py#L173-L179%EF%BC%89

特殊配置变量

以下环境变量可用于配置Healthchecks的一些"特殊"值：

其他配置变量

若需设置 https://github.com/healthchecks/healthchecks/blob/master/hc/settings.py 中的其他变量，只需在容器上设置相应的环境变量。例如，要设置 SLACK_CLIENT_ID，只需为容器添加环境变量 SLACK_CLIENT_ID。

在容器内运行 manage.py

需要Healthchecks实例的容器名称或ID。可通过运行 docker ps 查找运行Healthchecks的容器。

bash
docker exec -it CONTAINER_NAME /entrypoint.sh app:managepy YOUR_MANAGE_PY_FLAGS_COMMAND

激活*** Bot及其他Bot

使用上一节的命令，将 YOUR_MANAGE_PY_FLAGS_COMMAND 替换为：

bash
settelegramwebhook

为此，需设置以下变量：

• SITE_NAME
• TELEGRAM_TOKEN

其他Bot

除非 https://github.com/healthchecks/healthchecks 项目文档另有说明，否则只需在Docker容器上设置环境变量（重启后生效）即可。

关闭调试模式/生产模式运行

向Docker容器添加环境变量 DEBUG: "false"。

bash
docker run \
[...]
    -e 'DEBUG=false' \
[...]

创建Healthchecks超级用户

需要Healthchecks容器实例的名称或ID。可通过运行 docker ps 查找运行Healthchecks的容器。

bash
docker exec -it CONTAINER_NAME python3 /healthchecks/manage.py createsuperuser

按照提示创建Healthchecks超级用户。

Docker-Compose

示例 docker-compose.yml：

yaml
version: '3'
services:
  hc:
    image: galexrt/healthchecks:latest
    restart: always
    ports:
      - "8000:8000"
    volumes:
      - SQLite:/data
    environment:
      # DB_NAME必须如此设置才能使用/data卷，否则容器删除后SQLite数据库会丢失
      DB_NAME: "/data/hc.sqlite"
      SECRET_KEY: "blablabla123"
      ALLOWED_HOSTS: 'localhost,healthchecks.example.com,myhealthchecks.example.com'
      DEBUG: "False"
      DEFAULT_FROM_*** "***"
      USE_PAYMENTS: "False"
      REGISTRATION_OPEN: "False"
      EMAIL_HOST: ""
      EMAIL_PORT: "587"
      EMAIL_HOST_USER: ""
      EMAIL_HOST_PASSWORD: ""
      EMAIL_USE_TLS: "True"
      SITE_ROOT: "[***]"
      SITE_NAME: "Mychecks"
      MASTER_BADGE_LABEL: "Mychecks"
      PING_ENDPOINT: "[***]"
      PING_EMAIL_DOMAIN: "hc.example.com"
      TWILIO_ACCOUNT: "None"
      TWILIO_AUTH: "None"
      TWILIO_FROM: "None"
      PD_VENDOR_KEY: "None"
      TRELLO_APP_KEY: "None"
      CONTAINER_PRUNE_INTERVAL: 600
volumes:
  SQLite: