crazymax/healthchecks

Healthchecks Docker镜像文档

镜像概述

本镜像为Healthchecks应用的容器化版本，基于Alpine Linux构建，旨在提供轻量级、易于部署的任务监控解决方案。Healthchecks是一款开源工具，用于跟踪定时任务、后台作业、备份脚本等的执行状态，当任务未按时运行或执行失败时，可通过多种渠道发送通知，帮助用户及时发现并处理异常。

核心功能与特性

• 任务状态监控：跟踪任务是否按计划执行，支持设置超时时间、重试策略
• 多通知渠道：支持邮件、Slack、、、Webhook等多种通知方式
• Web管理界面：提供直观的Web UI，用于创建、管理监控任务和查看执行历史
• API支持：通过REST API实现任务管理、状态查询等自动化操作
• 数据持久化：支持SQLite、PostgreSQL等数据库存储任务数据，确保数据持久化
• 轻量级：基于Alpine Linux，镜像体积小，资源占用低

使用场景

• 服务器定时任务监控：监控Linux cron任务、Windows计划任务的执行状态
• 备份脚本监控：跟踪数据库备份、文件同步等关键脚本的运行结果
• CI/CD流水线监控：监控CI/CD pipeline中关键步骤的执行状态
• 自定义应用作业监控：监控业务系统中的后台定时任务（如数据清洗、报表生成）

使用方法

前提条件

• Docker Engine 19.03+ 或 Docker Desktop
• （可选）Docker Compose 2.0+

镜像拉取

bash
docker pull docker.xuanyuan.run/crazymax/healthchecks:latest

快速启动（Docker Run）

bash
docker run -d \
  --name=healthchecks \
  -p 8000:8000 \
  -v /path/to/data:/data \
  -e TZ=Asia/Shanghai \
  -e HC_DB=sqlite:////data/hc.sqlite \
  -e HC_SECRET_KEY=your-secret-key \
  -e HC_ALLOWED_HOSTS=localhost,127.0.0.1 \
  -e HC_ADMIN_EMAIL=admin@example.com \
  --restart unless-stopped \
  docker.xuanyuan.run/crazymax/healthchecks:latest

Docker Compose 配置

yaml
version: "3.8"

services:
  healthchecks:
    image: docker.xuanyuan.run/crazymax/healthchecks:latest
    container_name: healthchecks
    ports:
      - "8000:8000"
    volumes:
      - ./data:/data
    environment:
      - TZ=Asia/Shanghai
      - HC_DB=sqlite:////data/hc.sqlite  # 或使用PostgreSQL: postgres://user:pass@db:5432/hc
      - HC_SECRET_KEY=your-strong-secret-key
      - HC_ALLOWED_HOSTS=localhost,127.0.0.1,your-domain.com
      - HC_ADMIN_EMAIL=admin@example.com
      - HC_SITE_ROOT=http://localhost:8000
      - HC_EMAIL_HOST=smtp.example.com
      - HC_EMAIL_PORT=587
      - HC_EMAIL_USE_TLS=True
      - HC_EMAIL_HOST_USER=notifications@example.com
      - HC_EMAIL_HOST_PASSWORD=smtp-password
    restart: unless-stopped

环境变量配置

访问与使用

1. 启动容器后，通过 http://<容器IP>:8000 访问Web界面
2. 使用配置的 HC_ADMIN_EMAIL ***登录（首次登录需设置密码）
3. 在Web界面创建监控任务，获取任务唯一URL
4. 将任务URL集成到待监控的脚本/任务中（任务执行成功时请求该URL）
5. 配置通知渠道，当任务失败/超时后接收通知

数据持久化

建议通过 -v /path/to/data:/data 挂载宿主机目录，确保任务数据、数据库文件等持久化存储。

参考链接

• 官方GitHub仓库：https://github.com/crazy-max/docker-healthchecks
• Healthchecks官方文档：https://healthchecks.io/docs/