Skip to content

Latest commit

 

History

History
218 lines (169 loc) · 8.14 KB

README-en.md

File metadata and controls

218 lines (169 loc) · 8.14 KB

Green Dragon

Timed task management panel with python3, javaScript, shell, typescript support

docker version docker pulls docker stars docker image size

简体中文 | English

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

Deployment

Local Deployment

# To be refined, see the development steps first (not supported on windows yet)

Podman Deployment

  1. podman installation
https://podman.io/getting-started/installation
  1. start the container
podman run -dit \
  --network bridge \
  -v $PWD/ql/data:/ql/data \
  -p 5700:5700 \
  --name qinglong \
  --hostname qinglong \
  docker.io/whyour/qinglong:latest

Docker Deployment

  1. docker installation
sudo curl -sSL get.docker.com | sh
  1. configure domestic mirror sources
mkdir -p /etc/docker
tee /etc/docker/daemon.json <<-'EOF'
{
  "registry-mirrors": [
    "https://0b27f0a81a00f3560fbdc00ddd2f99e0.mirror.swr.myhuaweicloud.com",
    "https://ypzju6vq.mirror.aliyuncs.com",
    "https://registry.docker-cn.com",
    "http://hub-mirror.c.163.com",
    "https://docker.mirrors.ustc.edu.cn"
  ]
}
EOF
systemctl daemon-reload
systemctl restart docker
  1. start the container
docker run -dit \
  -v $PWD/ql/data:/ql/data \
  -p 5700:5700 \
  --name qinglong \
  --hostname qinglong \
  --restart unless-stopped \
  whyour/qinglong:latest

Docker-compose Deployment

  1. docker-compose installation
sudo curl -L https://github.com/docker/compose/releases/download/1.16.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
  1. start the container
mkdir qinglong
wget https://raw.githubusercontent.com/whyour/qinglong/master/docker/docker-compose.yml

# start
docker-compose up -d
# stop
docker-compose down
  1. access

Open your browser and visit http://{ip}:5700

Use

  1. built-in commands
# Update and restart Green Dragon
ql update                                                    
# Run custom scripts extra.sh
ql extra                                                     
# Adding a single script file
ql raw <file_url>                                             
# Add a specific script for a single repository
ql repo <repo_url> <whitelist> <blacklist> <dependence> <branch>   
# Delete old logs
ql rmlog <days>                                              
# 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                                                  

# Execute in sequence, if a random delay is set, it will be randomly delayed by a certain number of seconds
task <file_path>                                             
# 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 <file_path> 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 <file_path> conc <env_name> <account_number>(Optional) 
# Specify the account to execute and run immediately regardless of whether a random delay is set 
task <file_path> desi <env_name> <account_number>       
# Set task timeout   
task -m <max_time> <file_path>
# Print task log in real time, no need to carry this parameter when creating timed tasks
task -l <file_path>  
  1. 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
  • branch: Pull the branch of the repository
  • days: Number of days of logs to be kept
  • file_path: File path for task execution
  • env_name: The name of the environment variable that needs to be concurrent or specified at the time of task execution
  • account_number: Specify the account number of an environment variable to be executed when the task is executed
  • max_time: Timeout, suffix "s" for seconds (default), "m" for minutes, "h" for hours, "d" for days

Links

Development

$ git clone git@github.com:whyour/qinglong.git
$ cd qinglong
$ cp .env.example .env
# Recommended use pnpm https://pnpm.io/zh/installation
$ npm install -g pnpm
$ pnpm install
$ pnpm start

Open your browser and visit http://127.0.0.1:5700

Communication

telegram channel

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 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, 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.