Skip to content

Commit

Permalink
chore(doc): Add 1Panel deployment method
Browse files Browse the repository at this point in the history
  • Loading branch information
a76yyyy committed Sep 10, 2023
1 parent 525c4f1 commit be81195
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 2 deletions.
22 changes: 21 additions & 1 deletion web/docs/guide/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,27 @@ docker-compose up -d
>
> **Please don't use AliCloud image source to pull Docker container, it will not pull the latest image.**

#### 2. Docker Run
#### 2. 1Panel Deployment

2.1. Create a new application in 1Panel

![Click to install](../public/panel1.png)

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

2.2. Configure related settings

![Installation configuration](../public/panel2.png)

> If you need to set environment variables, please click `Edit Compose file`
>
> See [Configuration](#configuration-environment-variables) 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

``` sh
docker run -d --name qd -p 8923:80 -v $(pwd)/qd/config:/usr/src/app/config qdtoday/qd
Expand Down
Binary file added web/docs/public/panel1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added web/docs/public/panel2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 21 additions & 1 deletion web/docs/zh_CN/guide/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,27 @@ docker-compose up -d
>
> **请勿使用 阿里云镜像源 拉取 Docker 容器, 会导致无法拉取最新镜像**

#### 2. Docker 运行
#### 2. 1Panel 部署

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

![点击安装](../../public/panel1.png)

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

2.2. 配置相关设置

![安装配置](../../public/panel2.png)

> 如需设置环境变量请点击 `编辑 Compose 文件`
>
> 配置描述见下文 [Configuration](#配置环境变量)
>
> 如不需要`OCR功能`或者`硬盘空间不大于600M`, 请使用 **`qdtoday/qd:lite-latest`** 镜像, **该镜像仅去除了OCR相关功能, 其他与主线版本保持一致**。

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

#### 3. Docker 运行

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

0 comments on commit be81195

Please sign in to comment.