完善README

pull/21/merge
ouqiang 2017-04-28 16:06:06 +08:00
parent 317741b187
commit fa7b13d245
1 changed files with 47 additions and 10 deletions

View File

@ -1,13 +1,50 @@
# gocron - 定时任务web管理平台
# gocron - 定时任务web管理系统
[![Build Status](https://travis-ci.org/ouqiang/gocron.png)](https://travis-ci.org/ouqiang/gocron)
---------------------------
## 安装, 解压后执行
```shell
Windows gocron.exe web
Linux、OSX ./gocron web
```
可选参数
+ -p 端口, 指定端口, 默认5920
+ -e 指定运行环境, dev|test|prod, dev模式下可查看更多日志信息, 默认prod
+ -h 查看帮助
## 功能特性
* 定时任务统一调度和管理
* 支持对任务CURD
* crontab时间表达式支持秒级任务定义
* 任务执行失败重试设置
* 任务超时设置
* 任务执行方式
* 调用本机系统命令
* 通过SSH执行远程命令
* 执行HTTP-GET请求
* 查看任务执行日志
* 任务执行结果通知, 支持邮件、Slack
### 支持平台
> Windows、Linux、OSX
---------------------------
### 环境要求
> MySQL
---------------------------
## 安装
### 二进制安装
>
1. 解压压缩包
2. `cd 解压目录`
3. 启动
* Windows `./gocron.exe web`
* Linux、OSX `./gocron web`
### 源码安装
> `go get https://github.com/ouqiang/gocron`
### 启动可选参数
* -p 端口, 指定端口, 默认5920
* -e 指定运行环境, dev|test|prod, dev模式下可查看更多日志信息, 默认prod
* -h 查看帮助
## 安全
* 使用`https`访问保证数据传输安全, 可在web服务器如nginx中配置https通过反向代理访问内部的gocron
* 网站访问设置IP白名单
* SSH登录设置IP白名单