moexiaohei/qinglong

青龙镜像文档

镜像概述和主要用途

青龙镜像是一个用于部署和管理自动化脚本任务的Docker镜像，提供便捷的部署方式和丰富的内置命令，支持脚本的拉取、更新、执行及日志管理等功能，适用于需要自动化执行脚本任务的场景。

核心功能和特性

• 多部署方式：支持Docker直接部署和docker-compose编排部署
• 数据持久化：通过挂载目录实现配置、日志、数据库、仓库等数据的持久化存储
• 丰富内置命令：提供脚本更新、执行、日志清理、环境检测等多种管理命令
• 端口映射：默认暴露5700端口，用于Web管理界面访问
• 灵活任务执行：支持按顺序执行、立即执行、并发执行及指定账号执行任务

使用场景和适用范围

适用于需要自动化执行脚本任务的场景，如定时任务调度、脚本批量管理、自动化操作执行等，适合个人用户或企业用于管理各类自动化脚本。

使用方法和配置说明

Docker部署

Docker安装

bash
sudo curl -sSL get.docker.com | sh

启动容器

bash
docker run -dit \
  -v $PWD/ql/config:/ql/config \
  -v $PWD/ql/log:/ql/log \
  -v $PWD/ql/db:/ql/db \
  -v $PWD/ql/repo:/ql/repo \
  -v $PWD/ql/raw:/ql/raw \
  -v $PWD/ql/scripts:/ql/scripts \
  -p 5700:5700 \
  --name qinglong \
  --hostname qinglong \
  --restart unless-stopped \
  docker.xuanyuan.run/whyour/qinglong:latest

docker-compose部署

docker-compose安装

bash
sudo curl -L https://github.com/docker/compose/releases/download/1.16.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose

配置与启动

1. 创建目录并获取配置文件

bash
mkdir qinglong
wget https://raw.githubusercontent.com/whyour/qinglong/master/docker-compose.yml

2. 启动容器

bash
docker-compose up -d

3. 停止容器

bash
docker-compose down

内置命令说明

系统管理命令

• 更新并重启青龙

  bash
  ql update
  

• 运行自定义脚本extra.sh

  bash
  ql extra
  

• 添加单个脚本文件

  bash
  ql raw <file_url>
  

• 添加单个仓库的指定脚本

  bash
  ql repo <repo_url> <whitelist> <blacklist> <dependence> <branch>
  

• 删除旧日志

  bash
  ql rmlog <days>
  

• 启动tg-bot

  bash
  ql bot
  

• 检测青龙环境并修复

  bash
  ql check
  

• 重置登录错误次数

  bash
  ql resetlet
  

• 禁用两步登录

  bash
  ql resettfa
  

任务执行命令

• 依次执行（若设置随机延迟则延迟执行）

  bash
  task <file_path>
  

• 立即运行（无视随机延迟，前台输出日志）

  bash
  task <file_path> now
  

• 并发执行（无视随机延迟，日志直接记录，可指定账号）

  bash
  task <file_path> conc <env_name> <account_number>(可选)
  

• 指定账号执行（无视随机延迟）

  bash
  task <file_path> desi <env_name> <account_number>
  

参数说明

• file_url: 脚本地址
• repo_url: 仓库地址
• whitelist: 拉取仓库时的白名单（脚本路径包含的字符串）
• blacklist: 拉取仓库时的黑名单（脚本路径不包含的字符串）
• dependence: 拉取仓库需要的依赖文件（直接拷贝到scripts目录，不受黑名单影响）
• branch: 拉取仓库的分支
• days: 需要保留的日志天数
• file_path: 任务执行时的文件路径
• env_name: 任务执行时的环境变量名称
• account_number: 任务执行时指定的账号序号