diff --git a/README.md b/README.md index 1076bbfc..76a94d6b 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,11 @@ ## 功能 -- 支持python3、javaScript、shell、typescript脚本语言 -- 支持在线编辑、新增、删除脚本 -- 支持在线编辑、新增、删除环境变量 +- 支持多种脚本语言(python3、javaScript、shell、typescript) +- 支持在线管理脚本、环境变量、配置文件 - 支持在线查看任务日志 - 支持秒级任务设置 +- 支持系统级通知 - 支持暗黑模式 - 支持手机端操作 @@ -41,7 +41,7 @@ ### 本机部署 ```bash -# 待补充 +# 待完善 ``` ### docker 部署 @@ -81,7 +81,7 @@ sudo curl -L https://github.com/docker/compose/releases/download/1.16.1/docker-c ```bash mkdir qinglong -wget https://raw.githubusercontent.com/whyour/qinglong/develop/docker-compose.yml +wget https://raw.githubusercontent.com/whyour/qinglong/master/docker-compose.yml # 启动 docker-compose up -d @@ -89,6 +89,53 @@ docker-compose up -d docker-compose down ``` +## 使用 + +1. 内置命令 + +```bash +# 更新并重启青龙 +ql update +# 运行自定义脚本extra.sh +ql extra +# 添加单个脚本文件 +ql raw +# 添加单个仓库的指定脚本 +ql repo +# 删除旧日志 +ql rmlog +# 启动tg-bot +ql bot +# 检测青龙环境并修复 +ql check +# 重置登录错误次数 +ql resetlet +# 禁用两步登录 +ql resettfa + +# 依次执行,如果设置了随机延迟,将随机延迟一定秒数 +task +# 依次执行,无论是否设置了随机延迟,均立即运行,前台会输出日,同时记录在日志文件中 +task now +# 并发执行,无论是否设置了随机延迟,均立即运行,前台不产生日,直接记录在日志文件中,且可指定账号执行 +task conc (可选的) +# 指定账号执行,无论是否设置了随机延迟,均立即运行 +task desi +``` + +2. 参数说明 + +* file_url: 脚本地址 +* repo_url: 仓库地址 +* whitelist: 拉取仓库时的白名单,即就是需要拉取的脚本的路径包含的字符串 +* blacklist: 拉取仓库时的黑名单,即就是需要拉取的脚本的路径不包含的字符串 +* dependence: 拉取仓库需要的依赖文件,会直接从仓库拷贝到scripts下的仓库目录,不受黑名单影响 +* branch: 拉取仓库的分支 +* days: 需要保留的日志的天数 +* file_path: 任务执行时的文件路径 +* env_name: 任务执行时需要并发或者指定时的环境变量名称 +* account_number: 任务执行时指定某个环境变量需要执行的账号序号 + ## 链接 - [nevinee](https://gitee.com/evine) @@ -112,6 +159,10 @@ $ yarn start 打开你的浏览器,访问 http://127.0.0.1:5601 +## 交流 + +[telegram频道](https://t.me/jiao_long) + ## 名称来源 青龙,又名苍龙,在中国传统文化中是四象之一、[天之四灵](https://zh.wikipedia.org/wiki/%E5%A4%A9%E4%B9%8B%E5%9B%9B%E7%81%B5)之一,根据五行学说,它是代表东方的灵兽,为青色的龙,五行属木,代表的季节是春季,八卦主震。苍龙与应龙一样,都是身具羽翼。《张果星宗》称“又有辅翼,方为真龙”。 diff --git a/public/images/qinglong.png b/public/images/qinglong.png deleted file mode 100644 index 8ba23cea..00000000 Binary files a/public/images/qinglong.png and /dev/null differ