DailyCheckIn 项目使用教程
1. 项目的目录结构及介绍
DailyCheckIn 项目的目录结构如下:
/config/config.json: 配置文件
/cron/crontab_list.sh: 配置定时任务的文件
/logs: 日志文件
/docker-compose.yml: docker 启动文件(只在有 docker-compose 的情况下创建)
目录结构介绍
- config: 存放配置文件的目录。
config.json
: 主要配置文件,包含项目的各项设置。
- cron: 存放定时任务配置文件的目录。
crontab_list.sh
: 定时任务脚本,定义了项目的定时执行任务。
- logs: 存放日志文件的目录,记录项目的运行日志。
- docker-compose.yml: Docker 启动文件,用于通过 Docker Compose 启动和管理项目。
2. 项目的启动文件介绍
Docker 启动文件
docker-compose.yml
文件是 Docker Compose 的配置文件,用于定义和启动多个 Docker 容器。以下是该文件的主要内容:
version: '3'
services:
dailycheckin:
image: sitoi/dailycheckin:latest
container_name: dailycheckin
volumes:
- ./config:/dailycheckin/config
- ./logs:/dailycheckin/logs
- ./cron:/dailycheckin/cron
restart: always
启动命令
通过以下命令启动项目:
docker-compose up -d
3. 项目的配置文件介绍
配置文件路径
配置文件位于 /config/config.json
。
配置文件内容
config.json
文件包含了项目的各项配置,例如:
{
"NOTIFY_MODE": "Telegram",
"TELEGRAM_BOT_TOKEN": "your_telegram_bot_token",
"TELEGRAM_USER_ID": "your_telegram_user_id",
"CHECKIN_LIST": [
{
"name": "Baidu",
"url": "https://www.baidu.com",
"method": "GET"
},
{
"name": "Bilibili",
"url": "https://www.bilibili.com",
"method": "POST",
"data": {
"key1": "value1",
"key2": "value2"
}
}
]
}
配置文件说明
- NOTIFY_MODE: 通知方式,例如 Telegram。
- TELEGRAM_BOT_TOKEN: Telegram 机器人的 Token。
- TELEGRAM_USER_ID: Telegram 用户的 ID。
- CHECKIN_LIST: 签到任务列表,包含每个任务的名称、URL、请求方法和数据。
通过以上配置,可以灵活地设置项目的运行参数和签到任务。