Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/whyour/qinglong

支持 Python3、JavaScript、Shell、Typescript 的定时任务管理平台（Timed task management platform supporting Python3, JavaScript, Shell, Typescript）
https://github.com/whyour/qinglong

crontab docker javascript python shell task-manager typescript

Last synced: 24 days ago
JSON representation

支持 Python3、JavaScript、Shell、Typescript 的定时任务管理平台（Timed task management platform supporting Python3, JavaScript, Shell, Typescript）

Lists

README 

        





Qinglong



[简体中文](./README.md) | English



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)



## Features



- Support for multiple scripting languages (python3, javaScript, shell, typescript)

- Support online management of scripts, environment variables, configuration files

- Support online view task log

- Support second-level task setting

- Support system level notification

- Support dark mode

- Support cell phone operation



## Version



### docker



The `latest` image is built on `alpine` and the `debian` image is built on `debian-slim`. If you need to use a dependency that is not supported by `alpine`, it is recommended that you use the `debian` image.



```bash

docker pull whyour/qinglong:latest

docker pull whyour/qinglong:debian

```



### npm



The npm version supports `debian/ubuntu/centos/alpine` systems and requires `node/python3` to be installed.



```bash

npm i @whyour/qinglong

```



## Built-in commands



- task



```bash

# Execute in sequence, if a random delay is set, it will be randomly delayed by a certain number of seconds

task                                              

# Execute in sequence, regardless of whether a random delay is set, all run immediately, 

# and the foreground will output the day, while recorded in the log file

task  now                                         

# Concurrent execution, regardless of whether a random delay is set, are run immediately, 

# the foreground does not generate the day, directly recorded in the log file, and can be specified account execution

task  conc  (Optional) 

# Specify the account to execute and run immediately regardless of whether a random delay is set 

task  desi         

# Set task timeout   

task -m  

# Use -- to split, -- followed by a parameter that is passed to the script, as in the following example, the script receives the parameter -u whyour -p password

task  -- -u whyour -p password

```



- ql



```bash

# Update and restart Green Dragon

ql update                                                    

# Run custom scripts extra.sh

ql extra                                                     

# Adding a single script file

ql raw                                              

# Add a specific script for a single repository

ql repo        

# Delete old logs

ql rmlog                                               

# Start bot

ql bot                                                       

# Detecting the Green Dragon environment and repairing it

ql check                                                     

# Reset the number of login errors

ql resetlet                                                  

# Disable two-step login

ql resettfa                                                  

```



| **Parameter** | **Description** |

|---|---|

| file_url | Script address |

| repo_url | Repository address |

| whitelist | The whitelist when pulling the repository, i.e., the string contained in the path of the script to be pulled |

| blacklist | Blacklisting when pulling repositories, i.e. strings that are not included in the path of the script to be pulled |

| dependence | Pulling the dependencies needed for the repository will be copied directly from the repository to the repository directory under scripts, regardless of the blacklist |

| extensions | Pull the branch of the repository |

| branch | Number of days of logs to be kept |

| days | File path for task execution |

| file_path | The name of the environment variable that needs to be concurrent or specified at the time of task execution |



## Deployment



### Docker (Recommended)



```bash

# curl -sSL get.docker.com | sh

docker run -dit \

  -v $PWD/ql/data:/ql/data \

  # The 5700 after the colon is the default port, if QlPort is set, it needs to be the same as QlPort.

  -p 5700:5700 \

  # Deployment paths are not required, e.g. /test.

  -e QlBaseUrl="/" \

  # Deployment port is not required, when using host mode, you can set the port after service startup, default 5700

  -e QlPort="5700" \

  --name qinglong \

  --hostname qinglong \

  --restart unless-stopped \

  whyour/qinglong:latest

```



### Docker-compose (Recommended)



```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



# start

docker-compose up -d

# stop

docker-compose down

```



### Podman (Recommended)



```bash

# https://podman.io/getting-started/installation

podman run -dit \

  --network bridge \

  -v $PWD/ql/data:/ql/data \

  # The 5700 after the colon is the default port, if QlPort is set, it needs to be the same as QlPort.

  -p 5700:5700 \

  # Deployment paths are not required, e.g. /test.

  -e QlBaseUrl="/" \

  # Deployment port is not required, when using host mode, you can set the port after service startup, default 5700

  -e QlPort="5700" \

  --name qinglong \

  --hostname qinglong \

  docker.io/whyour/qinglong:latest

```



### Local



It is recommended to use a pure system installation to avoid losing the original system data, you need to install node/npm/python3/pip3 yourself



```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 [email protected]

npm install -g @whyour/qinglong

qinglong

# Add the environment variables QL_DIR and QL_DATA_DIR when prompted

export QL_DIR=""

export QL_DATA_DIR=""

# Run again

qinglong

```



## Development



```bash

$ git clone https://github.com/whyour/qinglong.git

$ cd qinglong

$ cp .env.example .env

# Recommended use pnpm https://pnpm.io/zh/installation

$ npm install -g [email protected]

$ pnpm install

$ pnpm start

```



Open your browser and visit 



## Links



- [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)



## Name Origin



The Green Dragon, also known as the Canglong, is one of the four elephants and one of the [four spirits of the heavens](https://zh.wikipedia.org/wiki/%E5%A4%A9%E4%B9%8B%E5%9B%9B%E7%81%B5) in traditional Chinese culture. According to the Five Elements, it is a spirit animal representing the East as a green dragon, the five elements are wood, and the season represented is spring, with the eight trigrams dominating vibration. Like the Ying Long, the Cang Long has feathered wings. According to the Zhang Guo Xing Zong (Zhang Guo Xing Zong), "a true dragon is one that has complementary wings".



In the Book of the Later Han Dynasty (後漢書-律曆志下), it is written: "The sun is in the sky, a cold and a summer, the four seasons are ready, all things are changed, the regency moves, and the green dragon moves to the star, which is called the year. (The Year of the Star)



Among the [twenty-eight Chinese constellations](https://zh.wikipedia.org/wiki/%E4%BA%8C%E5%8D%81%E5%85%AB%E5%AE%BF), the Green Dragon is the generic name for the seven eastern constellations (Horn, Hyper, Diao, Fang, Heart, Tail and Minchi). It is known in Taoism as "Mengzhang" and in different Taoist scriptures as "Dijun", "Shengjian", "Shenjian" and He is also known in different Daoist scriptures as "Dijun", "Shengjun", "Shenjun" and "Ghost Catcher"[1], and is the guardian deity of Daoism, together with the White Tiger Supervisor of Soldiers.