qinglong README

The project's README from github.com/whyour/qinglong. As one markdown file: README.md.

青龙

简体中文 | English

支持 Python3、JavaScript、Shell、Typescript 的定时任务管理平台

Timed task management platform supporting Python3, JavaScript, Shell, Typescript

npm version docker pulls docker stars docker image size

Demo / Issues / Telegram Channel / Buy Me a Coffee

演示 / 反馈 / Telegram 频道 / 打赏开发者

cover

功能

版本

docker

latest 镜像是基于 alpine 构建，debian 镜像是基于 debian-slim 构建。如果需要使用 alpine 不支持的依赖，建议使用 debian 镜像

⚠️ 重要提示: 如果您需要以非 root 用户运行 Docker，请使用 debian 镜像。Alpine 的 crond 需要 root 权限。

docker pull whyour/qinglong:latest
docker pull whyour/qinglong:debian

使用 debian 镜像以非 root 用户运行时，需指定 --user qinglong：

docker run -d \
  -v /path/to/ql/data:/ql/data \
  -p 5700:5700 \
  --user qinglong \
  --name qinglong \
  whyour/qinglong:debian

npm

npm 版本支持 debian/ubuntu/alpine 系统，需要自行安装 node/npm/python3/pip3/pnpm

npm i @whyour/qinglong

部署

查看文档

内置 API

查看文档

内置命令

查看文档

开发

git clone https://github.com/whyour/qinglong.git
cd qinglong
cp .env.example .env
# 推荐使用 pnpm https://pnpm.io/zh/installation
npm install -g [email protected]
pnpm install
pnpm start

打开你的浏览器，访问 http://127.0.0.1:5700

链接

名称来源

青龙，又名苍龙，在中国传统文化中是四象之一、天之四灵之一，根据五行学说，它是代表东方的灵兽，为青色的龙，五行属木，代表的季节是春季，八卦主震。苍龙与应龙一样，都是身具羽翼。《张果星宗》称“又有辅翼，方为真龙”。

《后汉书·律历志下》记载：日周于天，一寒一暑，四时备成，万物毕改，摄提迁次，青龙移辰，谓之岁。

在中国二十八宿中，青龙是东方七宿（角、亢、氐、房、心、尾、箕）的总称。 在早期星宿信仰中，祂是最尊贵的天神。 但被道教信仰吸纳入其神系后，神格大跌，道教将其称为“孟章”，在不同的道经中有“帝君”、“圣将”、“神将”和“捕鬼将”等称呼，与白虎监兵神君一起，是道教的护卫天神。

qinglong (whyour/qinglong)

Searching Database…

20K ·GitHub
Qinglong
这是什么东西?Qinglong(青龙)是一个可自托管的定时任务管理平台——相当于网页版的 crontab 替代品——可以定时调度并运行用 Python3、JavaScript、Shell 或 TypeScript 编写的脚本。
这是装在我电脑上的,还是跑在服务器上的?它是一个部署在服务端的网页平台(通常用 Docker 部署),通过浏览器操作;界面支持手机使用,有深色模式,还能推送系统级通知。
我怎么把它跑起来?主要方式是 Docker:'latest' 镜像基于 Alpine,'debian' 镜像基于 Debian slim。在 Debian/Ubuntu/Alpine 主机上也可以用 npm 构建,但需要自己安装 node/npm/python3/pip3/pnpm;完整的部署步骤见文档。
用 Docker 有什么坑需要提前知道?有两个:如果你的脚本需要 Alpine 提供不了的依赖,就换用 debian 镜像。另外,要以非 root 用户运行容器也必须用 debian 镜像,因为 Alpine 的 crond 只能以 root 运行——这种情况下用 --user qinglong 启动即可。
用这个需要会写代码吗?需要一点基础:任务就是你自己在 Python3、JavaScript、Shell 或 TypeScript 里写的脚本;网页界面负责脚本之外的定时调度、环境变量和日志管理。
在网页界面上我具体能做些什么?你可以在线管理脚本、环境变量和配置文件,查看任务日志,并把定时安排精确到秒。平台还支持推送系统级通知、提供深色模式,手机上也能用。
它为什么叫 Qinglong?Qinglong(青龙)即青龙——中国天文四象之一,是守护东方与春天的青色神兽。README 里专门有一节讲这个名字背后的神话典故。
我能用其他工具来触发或查看任务吗?可以——除了网页界面,平台还内置了一套 API 和一组内置命令,两者的文档都在 README 里有链接。
安装之前有没有演示可以先看看?有,README 里附了一个演示实例的链接,还有 Telegram 频道和反馈入口,你可以在部署之前先随便点点界面熟悉一下。
What are similar projects?planka, walle-web, taskview-community, pyspider, talorys, celery, py12306, TrendRadar
Which topics is it in?task-manager, ant-design, task-management, scheduler, notifications, shell, web-app, chinese, automation, tool, apache-2.0, server
Creator
whyour
Size
19.3 MB
Stars
20K
Updated
CommitOct 17
Age
5y
Commits · 90 Days