Deployment ​

Docker Container Deployment ​

Docker Container Deployment is the easiest way to deploy QD.

Please always remember to back up your database before updating or redeploying.

Container ​

DockerHub URL : https://hub.docker.com/r/qdtoday/qd

Tag meaning:

• latest: Latest Release version
• lite-latest: Latest Release version without OCR related functions
• ja3-latest: Integrated curl-impersonate to solve the problem that ja3 fingerprint is identified as curl, does not support http3 and Quic connection
• 20xxxxxx: Specify Release version, version number is represented by Release release date
• dev: Latest development version, synchronized with the latest source code, no stability guarantee

Deploy Method ​

1. Docker Compose (Recommend) ​

# Create and switch to the QD directory.
mkdir -p $(pwd)/qd/config && cd $(pwd)/qd
# Download docker-compose.yml
wget https://fastly.jsdelivr.net/gh/qd-today/qd@master/docker-compose.yml
# Modify the configuration environment variables according to the requirements and configuration description
vi ./docker-compose.yml
# Execute Docker Compose command
docker-compose up -d

See Configuration below for configuration description

If you don't need OCR or hard disk space is not larger than 600M, please use qdtoday/qd:lite-latest image, this image only removes OCR related functions, other than the mainline version to keep consistent.

Please don't use AliCloud image source to pull Docker container, it will not pull the latest image.

2. 1Panel Deployment ​

2.1. Create a new application in 1Panel

The QD framework name may be different in different 1Panel versions, but they are all QD icons.

2.2. Configure related settings

If you need to set environment variables, please click Edit Compose file

See Configuration below for configuration description

If you don't need OCR or hard disk space is not larger than 600M, please use qdtoday/qd:lite-latest image, this image only removes OCR related functions, other than the mainline version to keep consistent.

2.3. Click Confirm to install QD via 1Panel

3. Docker Run ​

docker run -d --name qd -p 8923:80 -v $(pwd)/qd/config:/usr/src/app/config qdtoday/qd

Try this command if you cannot connect to the external network inside the container:

# Create container using Host network mode, port: 8923
docker run -d --name qd --env PORT=8923 --net=host -v $(pwd)/qd/config:/usr/src/app/config qdtoday/qd

Please note that after creating a container with this command, please change the api request of http://localhost/ form in the template to api:// or http://localhost:8923/ manually in order to complete the related API request properly.

Do not run both old and new versions of QD framework, or map different running QD container databases to the same file.

Source Code Deployment ​

1. Version >= python3.9

   sh

   # Please cd to the root of the framework source code first
   pip3 install -r requirements.txt

2. Modify the configuration

   sh

   # Execute the following command to copy the configuration file
   # Modifying the content of the local_config.py file is not affected by updating the source code through git
   cp config.py local_config.py
   # Modify the configuration environment variables according to the requirements and configuration description
   vi local_config.py

3. Run

   sh

   python ./run.py

4. Access

   sh

   # Access the web page
   http://localhost:8923/

   If you are using the source code deployment method, please change the api request of http://localhost/ form in the template to api:// or http://localhost:8923/ manually in order to complete the related API request properly.

   Templates need to be published to be displayed in "Public Templates", and you need admin rights to approve them in "My Publish Requests".

Configure administrators ​

python ./chrole.py your@email.address admin

The first registered user is the administrator by default, you need to log out and then login to get full administrator rights

Configuration Environment Variables ​

For details, please refer to config.py