青龙

简体中文 | [English](./README-en.md) 支持 Python3、JavaScript、Shell、Typescript 的定时任务管理平台 Timed task management platform supporting Python3, JavaScript, Shell, Typescript [![npm version][npm-version-image]][npm-version-url] [![docker pulls][docker-pulls-image]][docker-pulls-url] [![docker stars][docker-stars-image]][docker-stars-url] [![docker image size][docker-image-size-image]][docker-image-size-url] [npm-version-image]: https://img.shields.io/npm/v/@whyour/qinglong?style=flat [npm-version-url]: https://www.npmjs.com/package/@whyour/qinglong?activeTab=readme [docker-pulls-image]: https://img.shields.io/docker/pulls/whyour/qinglong?style=flat [docker-pulls-url]: https://hub.docker.com/r/whyour/qinglong [docker-stars-image]: https://img.shields.io/docker/stars/whyour/qinglong?style=flat [docker-stars-url]: https://hub.docker.com/r/whyour/qinglong [docker-image-size-image]: https://img.shields.io/docker/image-size/whyour/qinglong?style=flat [docker-image-size-url]: https://hub.docker.com/r/whyour/qinglong [Demo](http://demo.dlww.cc:4433/) / [Issues](https://github.com/whyour/qinglong/issues) / [Telegram Channel](https://t.me/jiao_long) / [Buy Me a Coffee](https://www.buymeacoffee.com/qinglong) [演示](http://demo.dlww.cc:4433/) / [反馈](https://github.com/whyour/qinglong/issues) / [Telegram 频道](https://t.me/jiao_long) / [打赏开发者](https://user-images.githubusercontent.com/22700758/244744295-29cd0cd1-c8bb-4ea1-adf6-29bd390ad4dd.jpg)
![cover](https://user-images.githubusercontent.com/22700758/244847235-8dc1ca21-e03f-4606-9458-0541fab60413.png) ## 功能 - 支持多种脚本语言（python3、javaScript、shell、typescript） - 支持在线管理脚本、环境变量、配置文件 - 支持在线查看任务日志 - 支持秒级任务设置 - 支持系统级通知 - 支持暗黑模式 - 支持手机端操作 ## 版本 ### docker `latest` 镜像是基于 `alpine` 构建，`debian` 镜像是基于 `debian-slim` 构建。如果需要使用 `alpine` 不支持的依赖，建议使用 `debian` 镜像 ```bash docker pull whyour/qinglong:latest docker pull whyour/qinglong:debian ``` ### npm npm 版本支持 `debian/ubuntu/centos/alpine` 系统，需要自行安装 `node/python3` ```bash npm i @whyour/qinglong ``` ## 内置命令 - task ```bash # 依次执行，如果设置了随机延迟，将随机延迟一定秒数 task # 依次执行，无论是否设置了随机延迟，均立即运行，前台会输出日，同时记录在日志文件中 task now # 并发执行，无论是否设置了随机延迟，均立即运行，前台不产生日，直接记录在日志文件中，且可指定账号执行 task conc (可选的) # 指定账号执行，无论是否设置了随机延迟，均立即运行 task desi # 设置任务超时时间 task -m # 使用 -- 分割，-- 后面的参数会传给脚本，下面的例子，脚本就可接收到参数 -u whyour -p password task -- -u whyour -p password ``` - ql ```bash # 更新并重启青龙 ql update # 运行自定义脚本extra.sh ql extra # 添加单个脚本文件 ql raw # 添加单个仓库的指定脚本 ql repo # 删除旧日志 ql rmlog # 启动tg-bot ql bot # 检测青龙环境并修复 ql check # 重置登录错误次数 ql resetlet # 禁用两步登录 ql resettfa ``` | **参数** | **说明** | |------------|---------------------------------------------------------------------------------------------| | file_url | 脚本地址 | | repo_url | 仓库地址 | | whitelist | 拉取仓库时的白名单，即就是需要拉取的脚本的路径包含的字符串，多个竖线分割 | | blacklist | 拉取仓库时的黑名单，即就是需要拉取的脚本的路径不包含的字符串，多个竖线分割 | | dependence | 拉取仓库需要的依赖文件，会直接从仓库拷贝到scripts下的仓库目录，不受黑名单影响，多个竖线分割 | | extensions | 拉取仓库的文件后缀，多个竖线分割 | | branch | 拉取仓库的分支 | | days | 需要保留的日志的天数 | | file_path | 任务执行时的文件路径 | ## 部署 ### docker (推荐) ```bash # curl -sSL get.docker.com | sh docker run -dit \ -v $PWD/ql/data:/ql/data \ # 冒号后面的 5700 为默认端口，如果设置了 QlPort, 需要跟 QlPort 保持一致 -p 5700:5700 \ # 部署路径非必须，比如 /test -e QlBaseUrl="/" \ # 部署端口非必须，当使用 host 模式时，可以设置服务启动后的端口，默认 5700 -e QlPort="5700" \ --name qinglong \ --hostname qinglong \ --restart unless-stopped \ whyour/qinglong:latest ``` ### docker-compose (推荐) ```bash # curl -L https://github.com/docker/compose/releases/download/1.16.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose mkdir qinglong wget https://raw.githubusercontent.com/whyour/qinglong/master/docker/docker-compose.yml # 启动 docker-compose up -d # 停止 docker-compose down ``` ### podman (推荐) ```bash # https://podman.io/getting-started/installation podman run -dit \ --network bridge \ -v $PWD/ql/data:/ql/data \ # 冒号后面的 5700 为默认端口，如果设置了 QlPort, 需要跟 QlPort 保持一致 -p 5700:5700 \ # 部署路径非必须，比如 /test -e QlBaseUrl="/" \ # 部署端口非必须，当使用 host 模式时，可以设置服务启动后的端口，默认 5700 -e QlPort="5700" \ --name qinglong \ --hostname qinglong \ docker.io/whyour/qinglong:latest ``` ### 本机 建议使用纯净系统安装，避免系统原有数据丢失，需要自己安装 node/npm/python3/pip3 ```bash # Debian/Ubuntu curl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash - # Centos curl --silent --location https://rpm.nodesource.com/setup_20.x | sudo bash ``` ```bash npm install -g node-pre-gyp pnpm@8.3.1 npm install -g @whyour/qinglong qinglong # 根据提示增加环境变量 QL_DIR 和 QL_DATA_DIR export QL_DIR="" export QL_DATA_DIR="" # 再次执行 qinglong ``` ## 开发 ```bash $ git clone https://github.com/whyour/qinglong.git $ cd qinglong $ cp .env.example .env # 推荐使用 pnpm https://pnpm.io/zh/installation $ npm install -g pnpm@8.3.1 $ pnpm install $ pnpm start ``` 打开你的浏览器，访问 ## 链接 - [nevinee](https://gitee.com/evine) - [crontab-ui](https://github.com/alseambusher/crontab-ui) - [Ant Design](https://ant.design) - [Ant Design Pro](https://pro.ant.design/) - [Umijs](https://umijs.org) - [darkreader](https://github.com/darkreader/darkreader) - [admin-server](https://github.com/sunpu007/admin-server) ## 名称来源 青龙，又名苍龙，在中国传统文化中是四象之一、[天之四灵](https://zh.wikipedia.org/wiki/%E5%A4%A9%E4%B9%8B%E5%9B%9B%E7%81%B5)之一，根据五行学说，它是代表东方的灵兽，为青色的龙，五行属木，代表的季节是春季，八卦主震。苍龙与应龙一样，都是身具羽翼。《张果星宗》称“又有辅翼，方为真龙”。 《后汉书·律历志下》记载：日周于天，一寒一暑，四时备成，万物毕改，摄提迁次，青龙移辰，谓之岁。 在中国[二十八宿](https://zh.wikipedia.org/wiki/%E4%BA%8C%E5%8D%81%E5%85%AB%E5%AE%BF)中，青龙是东方七宿（角、亢、氐、房、心、尾、箕）的总称。 在早期星宿信仰中，祂是最尊贵的天神。 但被道教信仰吸纳入其神系后，神格大跌，道教将其称为“孟章”，在不同的道经中有“帝君”、“圣将”、“神将”和“捕鬼将”等称呼，与白虎监兵神君一起，是道教的护卫天神。