File: README.md Copy Chapter

QD for Python3

操作说明

请参阅 使用指南

更新日志

详见 CHANGELOG.md

维护项目精力有限, 仅保证对 Chrome 浏览器的支持。如果测试了其他浏览器可以 Pull Request。

许可

MIT 许可协议

致谢

Contributors ✨ Copy Chapter

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Stargazers over time

File: web/docs/guide/deployment.md Copy Chapter

Deployment

Docker Container Deployment Copy Chapter

Docker Container Deployment is the easiest way to deploy QD.

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

Container Copy Section

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 Copy Section

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 Copy Chapter

1. Version >= python3.9

   sh Copy

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

2. Modify the configuration

   sh Copy

   # 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 Copy

   python ./run.py

4. Access

   sh Copy

   # 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 Copy Chapter

python ./chrole.py [email protected] 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 Copy Chapter

For details, please refer to config.py

File: web/docs/guide/faq.md Copy Chapter

FAQ

how to backup and restore the database? Copy Chapter

QD uses sqlite3 as the framework database by default, and the database.db file is saved in config directory. When deploying with a Docker container, you can use the docker cp command to back up the database file, and then use the docker cp command to restore the database file in the new container.

# database backup
docker cp container_name:/usr/src/app/config/database.db .
# Database recovery
docker cp database.db container_name:/usr/src/app/config/

how to configure the email server in Docker? Copy Chapter

docker run -d --name qd -p 8923:80 -v $(pwd)/qd/config:/usr/src/app/config --env MAIL_SMTP=$STMP_Server_ --env MAIL_PORT=$Mailbox_server_port --env MAIL_USER=$Username --env MAIL_PASSWORD=$Password --env DOMAIN=$Domain qdtoday/qd

how to use MySQL in Docker? Copy Chapter

docker run -d --name qd -p 8923:80 -v $(pwd)/qd/config:/usr/src/app/config --ENV DB_TYPE=mysql --ENV JAWSDB_MARIA_URL=mysql://$username:$password@$hostname:$port/$database_name?auth_plugin= qdtoday/qd

how to build a Docker image by myself? Copy Chapter

Please refer to the build file Dockerfile of this image.

How to view the API and Jinja2 template variables supported by the current framework? Copy Chapter

Please access the home page of the framework, and then click the Common API/Filter button in the upper left corner to view the API and Jinja2 template variables supported by the current framework.

how to submit a bug issue? Copy Chapter

Please enable Debug mode after encountering a problem, and then submit detailed error information to Issue.

Which requests are necessary for QD? Copy Chapter

Empirically, the following requests are necessary:

• login page
• POST to login page
• Issue a request for username, password
• The page that caused the page to jump after sending
• The first page before and after page turning

Will my username and password be revealed? Copy Chapter

In order to help users initiate requests, user names and passwords still need to be recorded. This can only rely on the self-discipline of server maintainers to ensure the security of back-end data. But in the framework design, each user is encrypted with a secure key when storing. Encrypting user data with a key can ensure that user data cannot be decrypted only by obtaining the database. (Encrypted user data includes templates uploaded by users, variables set by users for tasks, etc.)

If you are still worried, you can build the QD framework by yourself, download the template and run it on your own server.

Prompt `PermissionError: [Errno 1] Operation not permitted` Copy Chapter

1. If it is an ARM32 Debian system, please check whether the Docker version is less than 20.10.0, and whether the libseccomp version is less than 2.4.4. If so, please upgrade the above components.

   Update libseccomp reference operation:

   sh Copy

   # Get signing keys to verify the new packages, otherwise they will not install
   sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 04EE7237B7D453EC 648ACFD622F3D138
   
   # Add the Buster backport repository to apt sources.list
   echo 'deb http://httpredir.debian.org/debian buster-backports main contrib non-free' | sudo tee -a /etc/apt/sources.list.d/debian-backports.list
   
   sudo apt update
   sudo apt install libseccomp2 -t buster-backports

   Source:

   • https://github.com/Taxel/PlexTraktSync/pull/474
   • https://stackoverflow.com/questions/70195968/dockerfile-raspberry-pi-python-pip-install-permissionerror-errno-1-operation

2. Check if the /usr/src/app directory inside the container is mapped to the outside of the container.

   Note that the framework only needs to map the /usr/src/app/config directory.

Prompt warning message: `Connect Redis falied: Error 10061` Copy Chapter

QD uses redis as a flow limiting tool. If the redis service is not installed, the framework will prompt the following warning message.

[W xxxxxx xx:xx:xx QD.RedisDB redisdb:28] Connect Redis falied: Error 10061 connecting to localhost:6379. No connection could be made because the target machine actively refused it.

However, redis is not required in this framework, if you don't need to use the flow-limiting feature, you can ignore the warning message.

It is recommended to use Docker compose to deploy the QD framework, and the Docker compose configuration already installs the redis container by default.

Prompt warning message: `Import PyCurl module falied` Copy Chapter

QD uses the pycurl module to send HTTP proxy requests. If the pycurl module is not installed, the framework will prompt the following warning message:

[W xxxxxx xx:xx:xx QD.Http.Fetcher fetcher:34] Import PyCurl module falied: No module named 'pycurl'

However, pycurl is not required in this framework, if you don't need to use the proxy function, you can ignore the warning message.

The pycurl module is cumbersome to install on the Windows system, and the libcurl library needs to be installed. For the specific installation method, please refer to pycurl official documentation.

It is recommended to use a container or linux system to deploy the QD framework. The docker container has a pre-installed Curl environment, and the pycurl module is installed by default

How to Register Notification Tools Copy Chapter

You can register different notification tools to receive notifications when specific events (such as failed check-ins) occur.

Please refer to Pusher for details.

Subscribe updating page prompts undefined error Copy Chapter

• issue#423

The subscribe updating web page prompts an error code of undefined, or the console shows WebSocket connection failed but does not show the reason for the error

Please check if the "reverse proxy" configuration is correct, refer to Nginx reverse proxy WebSocket service connection error

Reference configuration is as follows:

nginx Copy

server {
    listen 80;
    # Modify server_name  by yourself
    server_name qd.example.com;
    location / {
        proxy_pass http://ip:port;

        # Set WebSocket Configuration
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";

        # Set other optional configuration
        proxy_set_header  Host $host;
        proxy_set_header  X-Real-IP  $remote_addr;
        proxy_set_header  X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header  X-Forwarded-Proto  $scheme;
    }
}

Error Code: 4006 Copy Chapter

Error message: "Update failed, reason: Cannot connect to host xxx.xxx:443 ssl:False"

Cause: Unable to connect to Github or GitHub acceleration source.

Solution 1: Use a proxy

Solution 2: Change the GitHub acceleration source

Add/modify the environment variable in the container: SUBSCRIBE_ACCELERATE_URL=https://xxx.xxx/https://raw.githubusercontent.com/
Replace https://xxx.xxx/ with an available acceleration source. If you can't find an acceleration source, you can refer to https://ghproxy.link/ or https://gh-proxy.com for published acceleration sources.

File: web/docs/guide/how-to-use.md Copy Chapter

How to Use?

Har Obtain Copy Chapter

1. What is HAR? Copy Section

HAR: https://toolbox.googleapps.com/apps/har_analyzer/?lang=

2. Packet capture Copy Section

2.1. Chrome or Edge

1. Press F12, Ctrl + Shift + I, or from the Chrome menu select More tools > Developer tools.

2. From the panel that opens at the bottom of your screen, select the Network tab.

3. Make sure the Record button in the upper left corner of the Network tab is shown in red.

4. If it's grey, click it once to start recording.

5. Check the box next to Preserve log.

6. Click the Clear button to clear out any existing logs from the Network tab.

7. Now try to reproduce the task you were trying to do.

8. Once you have reproduced the task, right-click anywhere on the grid of network requests.

9. Select Save as HAR with Content.

10. Save the file to your computer.

2.2. Firefox

1. Press F12 ​(or Go to Tools > Web Developer > Network).
2. Now try to reproduce the task you were trying to do.
3. Right-click on the loaded results.
4. Select Save all as har.

2.3. Windows - Fiddler

1. Open Fiddler, open the Tools menu, select Options.
2. Select the HTTPS tab, check Capture HTTPS Connects.
3. Select the Connections tab, check Decrypt HTTPS traffic.
4. Now try to reproduce the task you were trying to do.
5. export to HAR format - please select HTTPArchive as the export method.

2.4. IOS - Stream

1. Open Stream.
2. Before capture the HTTPS request, you need to install the CA certificate, setting > General > About > Certificate Trust Settings to trust the CA certificate.
3. Click the start packet capture button, the phone will automatically pop up the VPN configuration window, and then select Allow.
4. Now try to reproduce the task you were trying to do.
5. On the app page, click Stop Capture to end this capture.
6. export the HAR file.

3. Community HAR Copy Section

1. Click the Community Template button to the right of my template.
2. Update the repository to get the latest HAR file list.
3. Select the HAR file you want to use and click the Subscribe button to subscribe to the template.
4. Modify the template according to your needs.
5. Then jump to step 5 of 3. Edit the template to continue editing.

Upload the HAR file Copy Chapter

1. Access and login to QD framework.
2. Click the + button to the right of my template.
3. Upload the HAR file you just saved.
4. Click upload to continue.

Edit the template Copy Chapter

::: v-pre

1. Replace the username, password, cookie, header and other parts that change according to the user with a template similar to {{ username }}. (templates support jinja2 syntax)
2. Use the test panel in request editing to test whether the template is returned correctly, use the correct and wrong user names to test。
3. Fill in success/failure assertion, which helps to detect sign-in failures and template failures.
4. When some data from the previous request is needed in the request, variable extraction is used to extract the data through regularization and save it in the environment variable. Use ab(\w+)cd, the group selector, to select part of it.
5. Use __log__ to extract task logs.
6. When all request edits are complete, use Test next to the Download button to test the overall.
7. The template being edited will be automatically saved in the browser cache, so don't worry about losing it.
8. Click the Save button to save the template.
9. Click the Download button to download the template.
   :::

Create scheduled task Copy Chapter

1. Click the + button to the right of my task.
2. Select the template you just created.
3. Fill in the task variables, task interval, task group and task execution time.
4. Click the Test button to test the task.
5. Click the Save button to save the task.

File: web/docs/guide/update.md Copy Chapter

Update

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

After the update, please restart the container or clear the browser cache.

Source Code Deployment Update Copy Chapter

# First cd to the directory of source code, execute the command and restart the process
wget https://gitee.com/qd-today/qd/raw/master/update.sh -O ./update.sh && \
sh ./update.sh

Docker Compose Deployment Update Copy Chapter

# First cd to the directory of docker-compose.yml, execute the command and restart the container
docker compose pull && \
docker compose up -d

Docker Container Deployment Update Copy Chapter

# Enter the container background first, restart the container after executing the command
wget https://gitee.com/qd-today/qd/raw/master/update.sh -O /usr/src/app/update.sh && \
sh /usr/src/app/update.sh

Forcibly synchronize the latest source code Copy Chapter

# First cd to the root directory of code, execute the command and restart the process
# docker exec -it "container name" /bin/sh
wget https://gitee.com/qd-today/qd/raw/master/update.sh -O ./update.sh && \
sh ./update.sh -f

File: web/docs/guide/what-is-qd.md Copy Chapter

What is QD?

QD is a web framework for HTTP timed task automation base on HAR Editor and Tornado Server.

Features Copy Chapter

• Har-based: By simply uploading Har obtained through packet capture, you can create HTTP task template required by the framework.
• Tornado Server: Use Tornado as a server to asynchronously respond to front-end and initiate HTTP requests.
• API & Plugin Support: Various APIs and filters are built in for template creation, and custom plugins will be provided later.
• Open source: QD is an open source project based on the MIT license.

How to deploy Copy Chapter

Please refer: Deployment

How to use Copy Chapter

Please refer: How to use

How to Update Copy Chapter

Please refer: Update

Discussion Copy Chapter

• Github: Issue
• Github: Discussion

File: web/docs/toolbox/pusher.md Copy Chapter

Pusher

Push Registration Copy Chapter

The QD framework provides various [push methods](#push methods), and you can register different push tools in Toolbox->Push Registration to push notifications to you when specific events occur (e.g. timed task execution failure).

::: tip

The parameters filled in when registering the push are separated and connected by ;. If the parameter value is empty, please be sure to keep the ; after the parameter position, otherwise it may cause parameter parsing error.

:::

Push Registration Test Copy Section

After registering the push method in Toolbox->Push Registration, you can click the Test button to test whether the push method is available.

If the push method is available, you will receive a push message, otherwise you will be prompted that the push failed.

::: tip

When testing the push registration, please make sure that the following conditions are met:

• The correct parameters are filled in;

• The email and password are filled in with the user's email and password of the QD framework.

:::

Push Registration Former value Copy Section

After registering the push method in Toolbox->Push Registration, you can click the Former value button to view the former value of the push registration.

::: tip

When viewing the former value of the push registration, please make sure that the email and password are filled in with the user's email and password of the QD framework.

:::

Push Methods Copy Chapter

The QD framework provides the following push methods:

E-mail Push Copy Section

E-mail push does not need to set parameters in Toolbox->Push Registration, you need to configure the following parameters in the environment variables:

If you are using the following email, refer to the SMTP enable method and configuration method below to get your SMTP server address and port.

::: tip MailGun

If you have configured MailGun, please configure the following parameters in the environment variables:

:::

Bark Push Copy Section

Bark push needs to set parameters in Toolbox->Push Registration:

Server Chan Push Copy Section

Server Chan push needs to set parameters in Toolbox->Push Registration:

Telegram Bot Push Copy Section

Telegram Bot push needs to set parameters in Toolbox->Push Registration:

::: details Example

Assume that you have created a Telegram Bot API with a custom domain name:

https://tg.mydomain.com/bot1111111111:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/sendMessage?chat_id=222222222&text=HelloWorld

The above request will send a HelloWorld message to the chat 222222222, then when registering the Telegram Bot as a push method:

• TG_TOKEN is 1111111111:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
• TG_USERID is 222222222
• TG_HOST is tg.mydomain.com

Therefore, the final form is as follows:

1111111111:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA;222222222;tg.mydomain.com

:::

DingTalk Push Copy Section

DingTalk push needs to set parameters in Toolbox->Push Registration:

WXPusher Push Copy Section

WXPusher push needs to set parameters in Toolbox->Push Registration:

WeCom Application Push Copy Section

WeCom application push needs to set parameters in Toolbox->Push Registration:

::: tip QYWX_PROXY_HOST

If you use Nginx to proxy the WeCom application push, the following is an example of Nginx configuration:

server {
    listen 443 ssl;
    server_name qywx.mydomain.com;
    ssl_certificate /etc/nginx/ssl/qywx.mydomain.com.crt;
    ssl_certificate_key /etc/nginx/ssl/qywx.mydomain.com.key;
    ssl_session_timeout 5m;
    ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
    ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:HIGH:!aNULL:!MD5:!RC4:!DHE;
    ssl_prefer_server_ciphers on;
    location / {
        proxy_pass https://qyapi.weixin.qq.com/;
    }
}

:::

WeCom Webhook Push Copy Section

WeCom Webhook push needs to set parameters in Toolbox->Push Registration:

Custom Push Copy Section

Custom push supports GET and POST push methods, using {log} and {t} to represent the log and title to be replaced.

Custom push needs to set parameters in Toolbox->Push Registration:

Custom Get Push

Custom Post Push

Push Settings Copy Chapter

After registering the push method in Toolbox->Push Registration, you can set the trigger conditions of the push method in Toolbox->Push Settings.

In Push Settings, you can set the push switch of each task, the task result push channel, the task result notification selection, and the task result batch push.

Task Result Push Channel Copy Section

The task result push channel is used to set the task result push channel. The task result push channel includes the following:

• Bark Push
• Server Chan Push
• WXPusher Push
• E-mail Push
• WeCom Application Push
• Telegram Bot Push
• DingTalk Push
• WeCom Webhook Push
• Custom Push

Task Result Notification Selection Copy Section

The task result notification selection is used to set when to push the task result. The task result notification selection includes the following:

• Manual execution success notification
• Manual execution failure notification
• Automatic execution success notification
• Automatic execution failure notification

Notify after automatic error can be set to push notifications after automatic execution fails several times. For example, if set to 3, the notification will be pushed after automatic execution fails 3 times.

Task Result Batch Push Copy Section

The task result batch push is used to set the batch push of the task result. When Enable batch push is turned on, the task result within the specified time interval before the current push time will be batch pushed according to the Batch push time setting and Batch push time interval when the task result is pushed.

• Batch push time setting: The initial batch push time setting, for example, set to 12:00:00, then a batch push will be made at 12:00:00 on the same day.

• Batch push time interval: Set how many seconds to push the task result once. The default is 86400 seconds, that is, the task result within 86400 seconds before the current push time will be batch pushed every day.

File: web/docs/zh_CN/guide/deployment.md Copy Chapter

部署

Docker 容器部署 Copy Chapter

Docker 容器部署是部署 QD 的最简单方式。

操作前请一定要记得备份数据库!!!

容器 Copy Section

DockerHub 网址：https://hub.docker.com/r/qdtoday/qd

Tag 含义:

• latest: 最新 Release 版本
• lite-latest: 去除 OCR 相关功能的最新 Release 版本
• ja3-latest: 集成 curl-impersonate 解决 ja3 指纹被识别为 curl 的问题, 不支持 http3 和 Quic 连接
• 20xxxxxx: 指定 Release 版本, 版本号表示为 Release 发布日期
• dev: 最新开发版, 同步最新源码, 不保证稳定性

部署方法 Copy Section

1. Docker Compose（推荐）

# 创建并切换到 QD 目录。
mkdir -p $(pwd)/qd/config && cd $(pwd)/qd
# 下载 docker-compose.yml
wget https://fastly.jsdelivr.net/gh/qd-today/qd@master/docker-compose.yml
# 根据需求和配置说明修改配置环境变量
vi ./docker-compose.yml
# 执行 Docker Compose 命令
docker-compose up -d

配置描述见下文 Configuration

如不需要OCR功能或者硬盘空间不大于600M, 请使用 qdtoday/qd:lite-latest 镜像, 该镜像仅去除了OCR相关功能, 其他与主线版本保持一致。

请勿使用 阿里云镜像源 拉取 Docker 容器, 会导致无法拉取最新镜像

2. 1Panel 部署

2.1. 在 1Panel 中创建一个新的应用

不同 1Panel 版本显示 QD 框架名称可能不同, 但均为 QD 图标.

2.2. 配置相关设置

如需设置环境变量请点击 编辑 Compose 文件

配置描述见下文 Configuration

如不需要OCR功能或者硬盘空间不大于600M, 请使用 qdtoday/qd:lite-latest 镜像, 该镜像仅去除了OCR相关功能, 其他与主线版本保持一致。

2.3. 点击 确认 即可通过 1Panel 安装 QD

3. Docker 运行

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

容器内部无法连通外部网络时尝试该命令:

# 使用 Host 网络模式创建容器, 端口号: 8923
docker run -d --name qd --env PORT=8923 --net=host -v $(pwd)/qd/config:/usr/src/app/config qdtoday/qd

注意: 使用该命令创建容器后, 请将模板里 http://localhost/ 形式的 api 请求, 手动改成 api:// 或 http://localhost:8923/ 后, 才能正常完成相关API请求。

请勿同时运行新旧版 QD 框架, 或将不同运行中的 QD 容器数据库映射为同一文件。

源码部署 Copy Chapter

1. Version >= python3.9

   sh Copy

   # 请先cd到框架源码根目录
   pip3 install -r requirements.txt

2. 修改相关设置

   sh Copy

   # 执行以下命令复制配置文件
   # 修改 local_config.py 文件的内容不受通过 git 更新源码的影响
   cp config.py local_config.py
   # 根据需求和配置说明修改配置文件或环境变量值
   vi local_config.py

3. 启动

   sh Copy

   python ./run.py

4. 访问

   sh Copy

   # 访问网页
   http://localhost:8923/

   如果您使用的是源码部署方式，请手动将模板中 http://localhost/ 形式的 api 请求改为 api:// 或 http://localhost:8923/ ，以便正确完成相关API 请求。

   模板需要发布才会在「公开模板」中展示, 你需要管理员权限在「我的发布请求」中审批通过。

设置管理员 Copy Chapter

python ./chrole.py [email protected] admin

首位注册用户默认为管理员, 需要先登出再登陆后才能获得完整管理员权限

配置环境变量 Copy Chapter

详细信息请查阅config.py

File: web/docs/zh_CN/guide/faq.md Copy Chapter

常见问题

如何备份和恢复数据库? Copy Chapter

QD 默认使用 sqlite3 作为框架数据库，database.db 文件保存在 config 目录下。使用 Docker 容器部署时，可以使用 docker cp 命令备份数据库文件，然后使用 docker cp 命令在新容器中恢复数据库文件。

# 数据库备份
docker cp container_name:/usr/src/app/config/database.db .
# 数据库恢复
docker cp database.db container_name:/usr/src/app/config/

如何在 Docker 中配置邮箱服务器? Copy Chapter

docker run -d --name qd -p 8923:80 -v $(pwd)/qd/config:/usr/src/app/config --env MAIL_SMTP=STMP服务器 --env MAIL_PORT=邮箱服务器端口 --env MAIL_USER=用户名 --env MAIL_PASSWORD=密码  --env DOMAIN=域名 qdtoday/qd

如何在 Docker 中使用 MySQL? Copy Chapter

docker run -d --name qd -p 8923:80 -v $(pwd)/qd/config:/usr/src/app/config --ENV DB_TYPE=mysql --ENV JAWSDB_MARIA_URL=mysql://用户名:密码@hostname:port/数据库名 qdtoday/qd

如何自己搭建 Docker 镜像? Copy Chapter

请参考此镜像的构建文件 Dockerfile。

如何查看当前框架支持的 API 和 Jinja2 模板变量? Copy Chapter

请进入框架首页，然后点击左上角的 常用 API/过滤器 按钮，可以查看当前框架支持的 API 和 Jinja2 模板变量。

如何提交 bug 问题? Copy Chapter

请在遇到问题后开启 Debug 模式，然后将详细的错误日志提交至 Issue。

QD 模板一般需要哪些请求? Copy Chapter

根据经验，以下请求是必要的：

• 登录页面
• 发布到登录页面
• 发起 用户名、密码 请求
• 发送后导致页面跳转的页面
• 翻页前后的第一个网页

我的用户名和密码会被泄露吗? Copy Chapter

为了帮助用户发起请求，终究需要记录用户名和密码。这只能靠服务器维护人员的自律来保证后端数据的安全。但在框架设计中，每个用户在存储时都使用安全密钥进行加密。使用密钥对用户数据进行加密，可以保证仅获取数据库就无法解密用户数据。（加密的用户数据包括用户上传的模板、用户为任务设置的变量等）

如果还是不放心，可以自己搭建 QD 框架，下载模板在自己的服务器上运行。

提示错误信息 `PermissionError: [Errno 1] Operation not permitted`? Copy Chapter

1. 如果是 ARM32 Debian 系统, 请检查 Docker 版本是否小于 20.10.0, 且 libseccomp 版本是否小于 2.4.4, 如果是的话, 请升级以上组件.

   更新 libseccomp 参考操作:

   sh Copy

   # Get signing keys to verify the new packages, otherwise they will not install
   sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 04EE7237B7D453EC 648ACFD622F3D138
   
   # Add the Buster backport repository to apt sources.list
   echo 'deb http://httpredir.debian.org/debian buster-backports main contrib non-free' | sudo tee -a /etc/apt/sources.list.d/debian-backports.list
   
   sudo apt update
   sudo apt install libseccomp2 -t buster-backports

   来源于:

   • https://github.com/Taxel/PlexTraktSync/pull/474
   • https://stackoverflow.com/questions/70195968/dockerfile-raspberry-pi-python-pip-install-permissionerror-errno-1-operation

2. 请检查是否将容器内的 /usr/src/app 目录映射至容器外部.

   请注意框架仅需映射 /usr/src/app/config 目录即可.

提示警告信息: `Connect Redis falied: Error 10061` Copy Chapter

QD 使用 redis 作为限流工具，如果没有安装 redis 服务，框架会提示以下警告信息。

[W xxxxxx xx:xx:xx QD.RedisDB redisdb:28] Connect Redis falied: Error 10061 connecting to localhost:6379. 由于目标计算机积极拒绝，无法连接。

然而，redis 在框架中并不是必须的，如果你不需要使用 限流 功能，可以忽略该警告信息。

建议使用 Docker compose 部署 QD 框架, Docker compose 配置已默认安装 redis 容器。

提示警告信息: `Import PyCurl module falied` Copy Chapter

QD 使用 pycurl 模块来发送 HTTP Proxy 请求。如果没有安装 pycurl 模块，框架会提示以下警告信息。

[W xxxxxx xx:xx:xx QD.Http.Fetcher fetcher:34] Import PyCurl module falied: No module named 'pycurl'

然而，pycurl 在框架中并不是必须的，如果你不需要使用 Proxy 功能，可以忽略该警告信息。

pycurl 模块在 Windows 系统上安装比较麻烦，需要安装 libcurl 库，具体安装方法请参考 pycurl 官方文档。

建议使用容器或 linux 系统部署 QD 框架, Docker 容器已预装 Curl 环境, 默认安装 pycurl 模组。

如何注册推送方式 Copy Chapter

你可以在 工具箱->推送注册中注册不同的推送工具，以便在发生特定事件（例如定时任务执行失败）时向你推送通知

请参考 推送工具

公共模板更新页面提示错误代码为 undefined Copy Chapter

• issue#423

公共模板更新页面提示错误代码为 undefined, 或者控制台显示 WebSocket 连接 failed 但不显示错误原因

请检查反向代理相关配置是否正确, 参考 Nginx 反向代理 WebSocket 服务连接报错

参考配置如下:

nginx Copy

server {
    listen 80;
    # 自行修改 server_name
    server_name qd.example.com;
    location / {
        proxy_pass http://ip:port;

        # WebSocket 关键配置 开始
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        # WebSocket 关键配置 结束

        # 其他可选配置 开始
        proxy_set_header  Host $host;
        proxy_set_header  X-Real-IP  $remote_addr;
        proxy_set_header  X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header  X-Forwarded-Proto  $scheme;
        # 其他可选配置 结束
    }
}

错误代码：4006 Copy Chapter

提示错误信息为："更新失败，原因：Cannot connect to host xxx.xxx:443 ssl:False"

报错原因：Github 或 GitHub 加速源无法连接。

解决方法 1：使用代理

解决方法 2：更换 Github 加速源

容器的环境变量中增加/修改 SUBSCRIBE_ACCELERATE_URL=https://xxx.xxx/https://raw.githubusercontent.com/
https://xxx.xxx/ 替换为可用的加速源，找不到加速源的可以参考 https://ghproxy.link 或 https://gh-proxy.com 中发布的加速源

File: web/docs/zh_CN/guide/how-to-use.md Copy Chapter

如何使用?

获取 HAR Copy Chapter

1. 什么是 HAR? Copy Section

HAR：https://toolbox.googleapps.com/apps/har_analyzer/?lang=zh_CN

2. 抓包 Copy Section

2.1. Chrome 或 Edge

1. 按 F12 、 Ctrl + Shift + I ，或从 Chrome 菜单中选择 更多工具 > 开发者工具 。

2. 从屏幕底部或右侧打开的面板中，选择 网络 选项卡。

3. 确保 网络 选项卡左上角的 录制 按钮显示为 红色。

4. 如果它是灰色的，单击一下开始录制。

5. 选中 保留日志 旁边的框。

6. 单击 清除 按钮以清除 网络 选项卡中的所有现有日志。

7. 现在尝试重现您计划发起的 HTTP 请求。

8. 重现任务后，右键单击网络请求网格上的任意位置。

9. 选择 另存为带内容的 HAR。

10. 将文件保存到您的计算机。

2.2. 火狐

1. 按 F12 （或转到 Tools > Web Developer > Network ）。
2. 现在尝试重现您计划发起的 HTTP 请求。
3. 右键单击​​加载的结果。
4. 选择全部另存为 har。

2.3. Windows - Fiddler

1. 打开 Fiddler，打开 Tools 菜单，选择 Options。
2. 选择 HTTPS 选项卡 ，勾选 Capture HTTPS Connects 。
3. 选择 连接 选项卡，选中 解密 HTTPS 流量 。
4. 现在尝试重现您计划发起的 HTTP 请求。
5. 导出为 HAR 格式 - 请选择 HTTPArchive 作为导出方式。

2.4. IOS - Stream

1. 打开 Stream。
2. 抓取HTTPS请求前，需要安装CA证书， setting > General > About > Certificate Trust Settings 信任CA证书。
3. 点击开始抓包按钮，手机会自动弹出VPN配置窗口，然后选择允许。
4. 现在尝试重现您计划发起的 HTTP 请求。
5. 在应用页面，点击停止抓拍结束本次抓拍。
6. 导出HAR文件。

3. 公共模板 Copy Section

1. 点击 我的模板 右侧的 社区模板 按钮。
2. 更新存储库以获取最新的 HAR 文件列表。
3. 选择你要使用的HAR文件，点击 Subscribe 按钮订阅模板。
4. 根据需要修改模板。
5. 然后跳到 3.编辑模板 继续编辑。

上传 HAR 文件 Copy Chapter

1. 访问并登录 QD 首页。
2. 点击 我的模板 右侧的 + 按钮。
3. 上传刚刚保存的 HAR 文件。
4. 点击 上传 继续。

编辑模板 Copy Chapter

::: v-pre

1. 将用户名、密码、cookie、header 等根据用户变化的部分替换成类似 {{ username }} 的模板。（模板支持 jinja2 语法）
2. 在请求编辑中使用测试面板测试模板是否正确返回，使用正确和错误的用户名进行测试。
3. 填写 成功/失败断言，这有助于检测模板任务是否运行失败。
4. 当请求中需要上一次请求的一些数据时，使用变量抽取，通过正则化抽取数据，保存在环境变量中。使用组选择器 ab(\w+)cd 选择其中的一部分。
5. 使用 __log__ 提取任务日志。
6. 当所有请求编辑完成后，使用下载按钮旁边的 测试 来测试整体。
7. 正在编辑的模板会自动保存在浏览器缓存中，不用担心丢失。
8. 单击 保存 按钮保存模板。
9. 单击 下载 按钮下载模板。
   :::

创建定时任务 Copy Chapter

1. 点击 我的任务 右侧的 + 按钮。
2. 选择刚刚创建的模板。
3. 填写任务变量，任务间隔、任务组和任务执行时间。
4. 单击 测试 按钮测试任务。
5. 单击保存按钮保存任务。