pdone/lite-cron repository overview

lite-cron/
├── 📄 config.yml                 # 任务配置文件
├── 📄 config.example.yml         # 配置示例文件
├── 🐳 Dockerfile                 # 镜像构建文件
├── 🐳 compose.yml                # 容器编排配置
├── 🐳 compose.example.yml        # 容器编排配置示例
├── 📜 manage.py                  # 管理脚本（Python实现，支持交互式菜单）
├── 📝 requirements.txt           # Python 依赖
├── 📁 src/                       # 源代码目录
│   ├── webapp.py                 # Web 管理界面（Flask）
│   ├── notify.py                 # 通知模块
│   ├── make_cron.py              # 生成 crontab 配置文件
│   ├── make_env.py               # 生成环境变量配置文件
│   ├── task_wrapper.py           # 任务执行包装器（Python）
│   ├── logger.py                 # 统一日志管理模块（Python）
│   ├── logger.sh                 # 统一日志管理模块（Shell）
│   ├── entrypoint.sh             # 容器启动入口
│   ├── 📁 template/              # HTML 模板目录
│   │   ├── index.html            # 主页面模板
│   │   └── login.html            # 登录页模板
│   └── 📁 static/                # 静态资源目录
│       ├── app.js                # 前端交互逻辑
│       └── style.css             # 样式文件
├── 📁 tasks/                     # 任务脚本目录（项目内置，可手动添加新脚本）
│   ├── ikuuu.py                  # iKuuu 签到
│   ├── pttime.py                 # PTTime 签到
│   ├── smzdm.py                  # 什么值得买签到
│   ├── tieba.py                  # 百度贴吧签到
│   ├── fnclub.py                 # 飞牛Nas论坛签到
│   ├── aliyunpan.py              # 阿里云盘签到
│   ├── bilibili.py               # 哔哩哔哩签到
│   ├── v2ex.py                   # V2EX 签到
│   ├── nodeseek.py               # NodeSeek 签到
│   └── zhutix.py                 # 致美化签到
├── 📁 data/                      # 持久化数据目录
└── 📁 logs/                      # 运行时日志目录

git clone https://github.com/pdone/lite-cron.git
cd lite-cron

cp config.example.yml config.yml
vim config.yml

tasks:
  - name: "ExampleTask"
    schedule: "0 2 * * *"  # 每天凌晨2点
    script: "tasks/example.py"
    description: "示例任务"
    enabled: true
    env:
      API_KEY: "your_key"

# 通知配置
notify:
  on_failure: true
  webhook:
    url: "https://hooks.example.com/send"
    method: "POST"

cp compose.example.yml compose.yml
docker compose up -d

# 构建并启动
python manage.py build
python manage.py start

# 查看状态
python manage.py status

environment:
  - WEBUI_TOKEN=change-me-to-a-long-random-secret
  # 可选：仅在 token 已设置且需公网访问时开启
  # - WEBUI_HOST=0.0.0.0

webui:
  token: "change-me-to-a-long-random-secret"
  # host: "127.0.0.1"   # 默认仅本地

python -c "import secrets; print(secrets.token_urlsafe(32))"

python manage.py              # 启动交互式菜单

# 容器管理
python manage.py start        # 启动容器
python manage.py stop         # 停止容器
python manage.py restart      # 重启容器
python manage.py status       # 查看状态
python manage.py logs         # 查看日志
python manage.py shell        # 进入容器
python manage.py reload       # 重新加载配置

# 任务执行
python manage.py list               # 查看定时任务计划
python manage.py run TaskName       # 执行指定任务（容器内，需先启动容器）
python manage.py run --all          # 执行所有已启用任务（容器内）
python manage.py run-local TaskName # 本地直接执行任务（不依赖 Docker）
python manage.py run-local --all    # 本地执行所有已启用任务
python manage.py tasklogs           # 查看任务日志
python manage.py validate           # 验证配置

# 系统维护
python manage.py build              # 构建镜像
python manage.py build v1.0.0       # 构建并指定标签
python manage.py build --no-cache   # 强制重新安装依赖
python manage.py update             # 更新项目
python manage.py clean              # 清理旧日志
python manage.py notify "消息"      # 发送测试通知
python manage.py help               # 查看帮助

#!/usr/bin/env python3
"""
任务描述：一句话说明任务功能

环境变量：
- API_KEY: API 密钥（必需）
- OPTIONAL_VAR: 可选配置（可选）
"""
import os
import sys

# 导入项目日志模块（必须使用项目 logger，不要用标准 logging）
sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", "src"))
from logger import log_info, log_success, log_error, log_warning, log_debug

# 从环境变量读取配置
API_KEY = os.environ.get('API_KEY')


def main() -> int:
    """主函数：任务逻辑，返回 0 表示成功，1 表示失败"""
    log_info("🚀 任务开始")

    try:
        # 任务逻辑
        log_info("📋 执行操作...")
        result = do_something(API_KEY)

        if result:
            log_success("✅ 任务成功")
            return 0
        else:
            log_warning("⚠️ 任务失败")
            return 1

    except Exception as e:
        log_error(f"❌ 任务异常: {str(e)}")
        return 1

    finally:
        log_info("🏁 任务结束")


def do_something(api_key: str) -> bool:
    """业务逻辑函数"""
    # 实现你的任务逻辑
    return True


if __name__ == '__main__':
    sys.exit(main())

# 顶部声明锚点
proxy: &proxy
  http://127.0.0.1:7890

tasks:
  - name: "V2EX"
    env:
      V2EX_PROXY: *proxy      # 引用共享代理
  - name: "NodeSeek"
    env:
      NODESEEK_PROXY: *proxy  # 引用共享代理
  - name: "ZhuTiX"
    env:
      ZHUTIX_PROXY: *proxy    # 引用共享代理

* * * * *
│ │ │ │ └── 星期 (0-7, 0和7都代表星期日)
│ │ │ └──── 月份 (1-12)
│ │ └────── 日期 (1-31)
│ └──────── 小时 (0-23)
└────────── 分钟 (0-59)

notify:
  webhook:
    url: "https://hooks.example.com/send"
    method: "POST"
    content_type: "application/json"
    headers: |
      Authorization: Bearer your_token

notify:
  ntfy:
    url: "https://ntfy.sh"
    topic: "lite-cron"
    priority: "3"
    username: "user"
    password: "pass"

# 检查端口是否被占用
netstat -tlnp | grep 5000

# 查看详细错误
docker compose logs

# 检查配置文件语法
python manage.py validate

# 1. 查看容器状态
python manage.py status

# 2. 检查容器日志
python manage.py logs

# 3. 验证 cron 表达式
python manage.py list

# 4. 确认任务已启用
# 检查 config.yml 中 enabled: true

python manage.py notify "消息"                    # 发送测试通知
python manage.py notify "消息" -l                 # 发送测试通知附带最近 15 行日志
python manage.py notify "消息" -l -n 30           # 发送测试通知附带最近 30 行日志
python manage.py notify "消息" --log-lines 20     # 同上，使用长参数
python manage.py help                             # 查看帮助

# 查看容器日志
python manage.py logs

# 查看任务日志
python manage.py tasklogs

feat 改进xxx体验

- 优化 xxxx
- 重构 xxxx