alseambusher/crontab-ui

Crontab UI Docker镜像文档

镜像概述

Crontab UI是一个用于简化crontab任务管理的工具，旨在解决直接编辑纯文本crontab文件时易出错的问题（如添加、删除或暂停任务时的操作失误）。通过提供直观的Web界面，Crontab UI使crontab任务管理更安全、高效，尤其适合需要维护大量定时任务的场景。

核心功能与特性

1. 简易部署：支持从现有crontab导入任务，快速搭建管理环境
2. 安全任务管理：安全地添加、删除或暂停任务，轻松维护数百个任务
3. 任务备份：支持crontab备份，防止配置丢失
4. 跨机器部署：导出crontab配置，方便在其他机器上部署
5. 错误日志支持：为每个任务提供独立的错误日志
6. 邮件与钩子集成：支持任务执行后的邮件通知和钩子触发

使用场景

• 需要管理多个定时任务的服务器管理员
• 希望避免手动编辑crontab文件导致错误的用户
• 需要在多台机器上同步crontab配置的场景
• 需对任务执行情况进行日志监控和通知的场景

使用方法

Docker部署示例

基础运行

使用Docker Hub上的预构建镜像：

bash
docker run -d -p 8000:8000 alseambusher/crontab-ui

访问 http://localhost:8000 即可打开Web管理界面。

带身份验证

通过环境变量设置基本HTTP认证：

bash
docker run -e BASIC_AUTH_USER=user -e BASIC_AUTH_PWD=SecretPassword -d -p 8000:8000 alseambusher/crontab-ui

数据持久化

挂载本地目录存储数据库、备份和日志文件：

bash
mkdir -p crontabs/logs
docker run --mount type=bind,source="$(pwd)"/crontabs/,target=/crontab-ui/crontabs/ -d -p 8000:8000 alseambusher/crontab-ui

自定义构建

如需自定义镜像，可手动构建：

bash
git clone https://github.com/alseambusher/crontab-ui.git
cd crontab-ui
docker build -t alseambusher/crontab-ui .
docker run -d -p 8000:8000 alseambusher/crontab-ui

环境变量配置

示例：启用SSL和自动保存

bash
docker run -e SSL_CERT=/path/to/cert.pem -e SSL_KEY=/path/to/key.pem -e ENABLE_AUTOSAVE=true \
  --mount type=bind,source=/local/ssl/,target=/ssl/ \
  -d -p 443:8000 alseambusher/crontab-ui

功能使用说明

任务管理

部署后通过Web界面可直接进行任务的添加、删除、暂停和恢复操作，无需手动编辑crontab文件。

导入现有crontab

支持从现有crontab文件自动导入任务，简化迁移过程。

备份与恢复

可创建crontab配置备份，在配置出错时快速恢复。

跨实例导出导入

导出配置文件后，可在其他Crontab UI实例中导入，实现多机器任务同步。

错误日志查看

每个任务有独立的错误日志，便于排查任务执行问题。

资源链接

• 完整使用说明
• https://github.com/alseambusher/crontab-ui/blob/master/README/issues.md
• 邮件通知设置
• https://github.com/alseambusher/crontab-ui/blob/master/README/nginx.md
• 树莓派部署指南

许可证

MIT