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…

Что это такое?Qinglong (青龙) — это самостоятельно размещаемая платформа для управления задачами по расписанию, работающая в браузере как альтернатива crontab. Она запускает по расписанию скрипты, написанные на Python3, JavaScript, Shell или TypeScript.
Это программа, которую я устанавливаю на компьютер, или то, что работает на сервере?Это серверная веб-платформа: вы её разворачиваете (обычно в Docker) и управляете ею через браузер. Интерфейс работает на телефоне, есть тёмная тема и возможность отправлять системные уведомления.
Как её запустить?Основной способ — Docker: образ 'latest' построен на Alpine, а образ 'debian' — на Debian-slim. Есть также npm-сборка для хостов с Debian/Ubuntu/Alpine, но node/npm/python3/pip3/pnpm придётся установить самому; полные шаги развёртывания описаны в документации.
Есть ли подводные камни в Docker, о которых стоит знать заранее?Два: если вашим скриптам нужны зависимости, которых нет в Alpine, переходите на образ debian. А чтобы запустить контейнер от пользователя без root, тоже нужен образ debian, потому что crond в Alpine требует root — там запускайте с --user qinglong.
Мне нужно уметь программировать, чтобы пользоваться этим?Базовые навыки написания скриптов — да: задачи — это скрипты, которые вы пишете сами на Python3, JavaScript, Shell или TypeScript; веб-интерфейс берёт на себя расписание, переменные окружения и логи.
Что реально можно делать через веб-интерфейс?Управлять скриптами, переменными окружения и файлами конфигурации прямо в браузере, смотреть логи задач и настраивать расписание вплоть до секунд. Платформа также отправляет системные уведомления, поддерживает тёмную тему и работает с телефона.
Почему она называется Qinglong?Qinglong (青龙) означает «Лазурный дракон» — один из четырёх символов китайской астрономии, лазурный страж Востока и весны. В README есть целый раздел об этой мифологии, стоящей за названием.
Можно ли запускать задачи или смотреть их из других инструментов?Да — помимо веб-интерфейса, в платформу встроены API и набор встроенных команд; у каждого есть своя документация, ссылки на которую есть в README.
Есть ли демо, чтобы попробовать до установки?Да, в README есть ссылка на демо-версию, а также на Telegram-канал и формы обратной связи — можно всё изучить в интерфейсе, прежде чем что-то разворачивать.
Creator
whyour
Size
19.3 MB
Stars
20K
Updated
CommitOct 17
Age
5y
Commits · 90 Days