PPGo_Job 开源项目安装及使用教程
1. 项目目录结构及介绍
PPGo_Job 的目录结构如下:
.
├── conf # 配置文件目录
│ └── app.conf # 主配置文件
├── controllers # 控制器文件
├── crons # 定时任务脚本存放目录
├── jobs # 任务定义文件
├── libs # 辅助函数库
├── models # 数据模型文件
├── notify # 通知模块
├── routers # 路由定义
├── static # 静态资源文件
├── views # 视图模板文件
├── .gitattributes # Git 属性配置
├── .gitignore # Git 忽略规则
├── .travis.yml # Travis CI 配置
├── README.md # 项目说明文档
├── main.go # 项目主入口文件
└── ppgo_job2.sql # 数据库初始化脚本
└── run.sh # 启动脚本 (Linux/Mac)
该目录结构中,conf
存放项目配置,controllers
和 views
分别负责后台逻辑和前端页面,jobs
是任务定义的位置,而 models
包含数据模型,lib
用于放置通用函数,notify
处理通知机制,routers
定义路由,static
和 views
服务于前端界面,.git*
文件用于 Git 版本控制。
2. 项目启动文件介绍
run.sh
文件是 Linux/Mac 平台上用来启动 PPGo_Job 的脚本。通过执行以下命令来启动服务:
./run.sh start
同样,你可以使用 ./run.sh stop
来停止服务。
请注意,Windows 平台目前暂不支持此启动方式。
3. 项目配置文件介绍
主要的配置文件位于 conf/app.conf
,以下是其中的关键设置项:
appname = PPGo_Job2 # 应用名
httpport = 8080 # HTTP 服务监听端口号
runmode = dev # 运行模式(dev/test/prod)
version= V2.2 # 项目版本号
# 允许同时运行的任务数
jobs pool = 1000
# 站点名称
site name = 定时任务管理器
# 通知方式 0=邮件 1=信息
notify type = 0
# 数据库配置
db.host = 127.0.0.1 # 数据库主机
db.user = root # 数据库用户名
db.password = "123456" # 数据库密码
db.port = 3306 # 数据库端口
db.name = ppgo_job2 # 数据库名称
db.prefix = pp_ # 表前缀
db.timezone = Asia/Shanghai # 数据库时区
# 邮件通知配置
email.host = smtp.mxhichina.com # SMTP 主机
email.port = 25 # SMTP 端口
email.from = ci@xxx.cn # 发送邮箱
email.user = ci@xxx.cn # 邮箱认证用户名
email.password = "xxxxxx" # 邮箱认证密码
email.pool = 10 # 连接池大小
# 短信通知方式配置
msg.url = http://chanxiyou.com/api/tools/send_sms # 短信服务商 API 地址
msg.pool = 10 # 短信连接池大小
在部署之前,你需要根据实际环境修改这些配置,特别是数据库连接信息以及通知服务的参数。