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…

What is this?Qinglong (青龙) is a self-hosted timed task management platform — a web-based alternative to crontab — that schedules and runs scripts written in Python3, JavaScript, Shell or TypeScript.
Is this something I install on my computer, or run on a server?It runs as a server-side web platform you deploy (usually in Docker) and drive from a browser; the UI works on phones, has dark mode, and can push system-level notifications.
How do I get it running?Docker is the main path: the 'latest' image is Alpine-based and a 'debian' image is Debian-slim-based. An npm build also exists for Debian/Ubuntu/Alpine hosts, but you must install node/npm/python3/pip3/pnpm yourself; full deployment steps are in the docs.
Any Docker pitfalls I should know about upfront?Two: if your scripts need dependencies Alpine can't provide, switch to the debian image. And to run the container as a non-root user you must use the debian image, since Alpine's crond requires root — there, run with --user qinglong.
Do I need to know how to code to use it?Basic scripting, yes — tasks are scripts you write yourself in Python3, JavaScript, Shell or TypeScript; the web UI handles the scheduling, environment variables and logs around them.
What can I actually do from the web interface?You manage scripts, environment variables and config files online, view task logs, and set schedules down to the second. The platform also sends system-level notifications, offers dark mode, and is usable from a phone.
Why is it called Qinglong?Qinglong (青龙) means Azure Dragon — one of the Four Symbols of Chinese astronomy, the azure guardian of the East and of spring. The README has a whole section on this mythology behind the name.
Can I trigger or inspect tasks from other tools?Yes — besides the web UI, the platform ships a built-in API and a set of built-in commands; both have their own documentation linked from the README.
Is there a demo before I install anything?Yes, the README links a demo instance alongside a Telegram channel and feedback links, so you can poke around the interface before deploying anything.
Creator
whyour
Size
19.3 MB
Stars
20K
Updated
CommitOct 17
Age
5y
Commits · 90 Days