https://github.com/up9cloud/gocron2

A simple scheduler
https://github.com/up9cloud/gocron2

cron cronjob crontab scheduler

Last synced: 2 months ago
JSON representation

A simple scheduler

• Host: GitHub
• URL: https://github.com/up9cloud/gocron2
• Owner: up9cloud
• License: mit
• Created: 2024-06-28T09:40:28.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-25T03:54:11.000Z (almost 2 years ago)
• Last Synced: 2025-01-28T01:13:32.036Z (over 1 year ago)
• Topics: cron, cronjob, crontab, scheduler
• Language: Go
• Homepage:
• Size: 9.23 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
###

2025-04-10 註

本專案比較舊了。

強烈建議改為使用 [青龙](https://github.com/whyour/qinglong) 或是 [n8n](https://github.com/n8n-io/n8n)

###

# gocron2

[![Downloads](https://img.shields.io/github/downloads/up9cloud/gocron2/total.svg)](https://github.com/up9cloud/gocron2/releases)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/up9cloud/gocron2/blob/master/LICENSE)

[![Release](https://img.shields.io/github/release/up9cloud/gocron2.svg?label=Release)](https://github.com/up9cloud/gocron2/releases)

定时任务管理系统

## 项目简介

使用Go语言开发的轻量级定时任务集中调度和管理系统, 用于替代 Linux-crontab

原有的延时任务拆分为独立项目[延迟队列](https://github.com/ouqiang/delay-queue)

原項目 [https://github.com/ouqiang/gocron](https://github.com/ouqiang/gocron) 的作者不更新了。[此為原文档](https://github.com/up9cloud/gocron2/wiki)

所以基於大家的 Folks 搞了新的 `gocron2` 縫合怪，詳細縫合訊息請看下方 Credits

## 功能特性

- Web界面管理定时任务

- crontab时间表达式, 精确到秒

- 任务执行失败可重试

- 任务执行超时, 强制结束

- 任务依赖配置, A任务完成后再执行B任务

- 账户权限控制

- 任务类型

  - shell任务

  > 在任务节点上执行shell命令, 支持任务同时在多个节点上运行

  - HTTP任务

  > 访问指定的URL地址, 由调度器直接执行, 不依赖任务节点

- 查看任务执行结果日志

- 任务执行结果通知, 支持邮件、Slack、Webhook

## 截图

![列表](./assets/screenshot/task.png)

![日志](./assets/screenshot/task-log.png)

![节点](./assets/screenshot/node.png)

![webhook](./assets/screenshot/webhook.png)

## 流程图

![流程图](./assets/screenshot/scheduler.png)

## 支持平台

> Windows、Linux、Mac OS

## 环境要求

> MySQL

## 安装

### 二进制安装

- 解压压缩包  

- `cd 解压目录`

- 启动

  - 调度器启动

    - Windows: `gocron2.exe web`

    - Linux、Mac OS:  `./gocron2 web`

  - 任务节点启动, 默认监听 0.0.0.0:5921

    - Windows:  `gocron2-node.exe`

    - Linux、Mac OS:  `./gocron2-node`

- 浏览器访问 `http://localhost:5920`

### 源码安装

- 安装Go 1.16+

- `go get -d github.com/up9cloud/gocron2`

- `export GO111MODULE=on`

- 编译 `make`

- 启动

  - gocron2 `./bin/gocron2 web`

  - gocron2-node `./bin/gocron2-node`

### docker

See: `https://github.com/docker-sstc/docker-gocron2`

配置: /app/conf/app.ini

日志: /app/log/cron.log

## 命令

- gocron2

  - -v 查看版本

- gocron2 web

  - --host 默认0.0.0.0

  - -p 端口, 指定端口, 默认5920

  - -e 指定运行环境, dev|test|prod, dev模式下可查看更多日志信息, 默认prod

  - -h 查看帮助

- gocron2-node

  - -allow-root *nix平台允许以root用户运行

  - -s ip:port 监听地址

  - -enable-tls 开启TLS

  - -ca-file   CA证书文件

  - -cert-file 证书文件

  - -key-file  私钥文件

  - -h 查看帮助

  - -v 查看版本

## 开发安装

- 安装 Go1.16+, Node.js (Npm), Docker

- 启动 gocron2, gocron2-node `docker compose up`

- 启动前端, `make run-vue`

  - install 的時候，主机名填入 `db`

  - API请求預設会转发给 gocron2, 若要代理到遠端伺服器, 需新增 `web/vue/.secret.config.js` 檔案加參數, 詳閱 `web/vue/vite.config.js`

`其他指令請詳查 ./makefile`

## 發布

- edit CHANGELOG.md

- edit `AppVersion` in main.go

- git commit

- git tag vx.x.x

- git push && git push --tags

- wait for github action

## TODO

- [ ] Move readme commands intro to cli

- [ ] merge `https://github.com/peng49/gocron`

- [ ] Fix or remove super admin logic

- [x] Support sqlite3 (Only for 开发安装)

- [x] 版本升级

- [x] 批量开启、关闭、删除任务

- [x] 调度器与任务节点通信支持https

- [x] 任务分组

- [x] 多用户

- [x] 权限控制

## 程序使用的组件

- Web框架 [Macaron](http://go-macaron.com/)

- 定时任务调度 [Cron](https://github.com/robfig/cron)

- ORM [Xorm](https://github.com/go-xorm/xorm)

- UI框架 [Element Plus](https://element-plus.org)

- 依赖管理 [Govendor](https://github.com/kardianos/govendor)

- RPC框架 [gRPC](https://github.com/grpc/grpc)

## Credits

- `https://github.com/ouqiang/gocron/pull/375`

- `https://github.com/gaowei-space/gocron`

- `https://github.com/ghostong/gocron.git`