docs: add description of the docker environment variable (#137)

为部署文档提供 Docker 环境变量的解释。 /kind documentation ```release-note None ```
halo-dev · Dec 16, 2022 · dcb7a89 · dcb7a89 · vercel · Dec 16, 2022
1 parent 039159d
commit dcb7a89
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 2 deletions.
diff --git a/docs/getting-started/install/docker-compose.md b/docs/getting-started/install/docker-compose.md
@@ -3,6 +3,8 @@ title: 使用 Docker Compose 部署
 description: 使用 Docker Compose 部署
 ---
 
+import DockerEnv from "./slots/docker-env.md"
+
 :::info
 在继续操作之前，我们推荐您先阅读[《写在前面》](../prepare.md)，这可以快速帮助你了解 Halo。
 :::
@@ -39,7 +41,7 @@ description: 使用 Docker Compose 部署
 
 2. 创建 `docker-compose.yaml`
 
-  此文档提供两种场景的 Docker Compose 配置文件，请根据你的需要选择一种。
+  此文档提供两种场景的 Docker Compose 配置文件，请根据你的需要**选择一种**。
 
   :::info
   需要注意的是，此文档为了更加方便的管理配置，所有与 Halo 相关的配置都使用 Docker 环境变量代替，所以无需创建 application.yaml 文件。
@@ -186,6 +188,10 @@ description: 使用 Docker Compose 部署
           - HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd
     ```
 
+  环境变量详解：
+
+  <DockerEnv />
+
 3. 启动 Halo 服务
 
   ```bash

diff --git a/docs/getting-started/install/docker.md b/docs/getting-started/install/docker.md
@@ -3,6 +3,8 @@ title: 使用 Docker 部署
 description: 使用 Docker 部署
 ---
 
+import DockerEnv from "./slots/docker-env.md"
+
 :::info
 在继续操作之前，我们推荐您先阅读[《写在前面》](../prepare)，这可以快速帮助你了解 Halo。
 :::
@@ -41,6 +43,7 @@ description: 使用 Docker 部署
       -p 8090:8090 \
       -v ~/.halo2:/root/.halo2 \
       -e HALO_EXTERNAL_URL=http://localhost:8090/ \
+      -e HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME=admin \
       -e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \
       halohub/halo:2.0.1
     ```
@@ -56,8 +59,13 @@ description: 使用 Docker 部署
     - **-v**：工作目录映射。形式为：`-v 宿主机路径:/root/.halo2`，后者不能修改。
     - **-e**：环境变量
       - `HALO_EXTERNAL_URL`: 外部可访问的链接。例如：<https://域名/>
+      - `HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME`: 超级管理员用户名
       - `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`: 超级管理员用户（admin）的初始化密码。如果该环境变量没有设置，系统将会生成随机密码并打印在日志中。
 
+    环境变量详解：
+
+    <DockerEnv />
+
 1. 用浏览器访问 `$HALO_EXTERNAL_URL/console/`（外部访问链接）即可进入 Halo 管理端。管理员用户名为 `admin`，登录密码为上方设置的 `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`。
 
     :::tip

diff --git a/docs/getting-started/install/slots/docker-env.md b/docs/getting-started/install/slots/docker-env.md
@@ -0,0 +1,17 @@
+| 变量名                                         | 描述                                                                             |
+| ---------------------------------------------- | -------------------------------------------------------------------------------- |
+| `SPRING_R2DBC_URL`                             | 数据库连接地址，详细可查阅下方的 `数据库配置`                                    |
+| `SPRING_R2DBC_USERNAME`                        | 数据库用户名                                                                     |
+| `SPRING_R2DBC_PASSWORD`                        | 数据库密码                                                                       |
+| `SPRING_SQL_INIT_PLATFORM`                     | 数据库平台名称，支持 `postgresql`、`mysql`、`h2`，需要与 `SPRING_R2DBC_URL` 对应 |
+| `HALO_EXTERNAL_URL`                            | 外部访问链接，如果需要再公网访问，需要配置为实际访问地址                         |
+| `HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME` | 初始超级管理员用户名                                                             |
+| `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD` | 初始超级管理员密码                                                               |
+
+数据库配置：
+
+| 链接方式    | 链接地址格式                                                                       | `SPRING_SQL_INIT_PLATFORM` |
+| ----------- | ---------------------------------------------------------------------------------- | -------------------------- |
+| PostgreSQL  | `r2dbc:pool:postgresql://{HOST}:{PORT}/{DATABASE}`                                 | postgresql                 |
+| MySQL       | `r2dbc:pool:mysql://{HOST}:{PORT}/{DATABASE}`                                      | mysql                      |
+| H2 Database | `r2dbc:h2:file:///${halo.work-dir}/db/halo-next?MODE=MySQL&DB_CLOSE_ON_EXIT=FALSE` | h2                         |
diff --git a/versioned_docs/version-2.0/getting-started/install/docker-compose.md b/versioned_docs/version-2.0/getting-started/install/docker-compose.md
@@ -3,6 +3,8 @@ title: 使用 Docker Compose 部署
 description: 使用 Docker Compose 部署
 ---
 
+import DockerEnv from "./slots/docker-env.md"
+
 :::info
 在继续操作之前，我们推荐您先阅读[《写在前面》](../prepare.md)，这可以快速帮助你了解 Halo。
 :::
@@ -39,7 +41,7 @@ description: 使用 Docker Compose 部署
 
 2. 创建 `docker-compose.yaml`
 
-  此文档提供两种场景的 Docker Compose 配置文件，请根据你的需要选择一种。
+  此文档提供两种场景的 Docker Compose 配置文件，请根据你的需要**选择一种**。
 
   :::info
   需要注意的是，此文档为了更加方便的管理配置，所有与 Halo 相关的配置都使用 Docker 环境变量代替，所以无需创建 application.yaml 文件。
@@ -185,6 +187,10 @@ description: 使用 Docker Compose 部署
           - HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd
     ```
 
+  环境变量详解：
+
+  <DockerEnv />
+
 3. 启动 Halo 服务
 
   ```bash

diff --git a/versioned_docs/version-2.0/getting-started/install/docker.md b/versioned_docs/version-2.0/getting-started/install/docker.md
@@ -3,6 +3,8 @@ title: 使用 Docker 部署
 description: 使用 Docker 部署
 ---
 
+import DockerEnv from "./slots/docker-env.md"
+
 :::info
 在继续操作之前，我们推荐您先阅读[《写在前面》](../prepare)，这可以快速帮助你了解 Halo。
 :::
@@ -41,6 +43,7 @@ description: 使用 Docker 部署
       -p 8090:8090 \
       -v ~/.halo2:/root/.halo2 \
       -e HALO_EXTERNAL_URL=http://localhost:8090/ \
+      -e HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME=admin \
       -e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \
       halohub/halo:2.0.1
     ```
@@ -56,8 +59,13 @@ description: 使用 Docker 部署
     - **-v**：工作目录映射。形式为：`-v 宿主机路径:/root/.halo2`，后者不能修改。
     - **-e**：环境变量
       - `HALO_EXTERNAL_URL`: 外部可访问的链接。例如：<https://域名/>
+      - `HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME`: 超级管理员用户名
       - `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`: 超级管理员用户（admin）的初始化密码。如果该环境变量没有设置，系统将会生成随机密码并打印在日志中。
 
+    环境变量详解：
+
+    <DockerEnv />
+
 1. 用浏览器访问 `$HALO_EXTERNAL_URL/console/`（外部访问链接）即可进入 Halo 管理端。管理员用户名为 `admin`，登录密码为上方设置的 `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`。
 
     :::tip

diff --git a/versioned_docs/version-2.0/getting-started/install/slots/docker-env.md b/versioned_docs/version-2.0/getting-started/install/slots/docker-env.md
@@ -0,0 +1,17 @@
+| 变量名                                         | 描述                                                                             |
+| ---------------------------------------------- | -------------------------------------------------------------------------------- |
+| `SPRING_R2DBC_URL`                             | 数据库连接地址，详细可查阅下方的 `数据库配置`                                    |
+| `SPRING_R2DBC_USERNAME`                        | 数据库用户名                                                                     |
+| `SPRING_R2DBC_PASSWORD`                        | 数据库密码                                                                       |
+| `SPRING_SQL_INIT_PLATFORM`                     | 数据库平台名称，支持 `postgresql`、`mysql`、`h2`，需要与 `SPRING_R2DBC_URL` 对应 |
+| `HALO_EXTERNAL_URL`                            | 外部访问链接，如果需要再公网访问，需要配置为实际访问地址                         |
+| `HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME` | 初始超级管理员用户名                                                             |
+| `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD` | 初始超级管理员密码                                                               |
+
+数据库配置：
+
+| 链接方式    | 链接地址格式                                                                       | `SPRING_SQL_INIT_PLATFORM` |
+| ----------- | ---------------------------------------------------------------------------------- | -------------------------- |
+| PostgreSQL  | `r2dbc:pool:postgresql://{HOST}:{PORT}/{DATABASE}`                                 | postgresql                 |
+| MySQL       | `r2dbc:pool:mysql://{HOST}:{PORT}/{DATABASE}`                                      | mysql                      |
+| H2 Database | `r2dbc:h2:file:///${halo.work-dir}/db/halo-next?MODE=MySQL&DB_CLOSE_ON_EXIT=FALSE` | h2                         |