diff --git a/docs/getting-started/install/docker-compose.md b/docs/getting-started/install/docker-compose.md index ed29bd4..02f532b 100644 --- a/docs/getting-started/install/docker-compose.md +++ b/docs/getting-started/install/docker-compose.md @@ -3,7 +3,7 @@ title: 使用 Docker Compose 部署 description: 使用 Docker Compose 部署 --- -import DockerEnv from "./slots/docker-env.md" +import DockerArgs from "./slots/docker-args.md" :::info 在继续操作之前,我们推荐您先阅读[《写在前面》](../prepare.md),这可以快速帮助你了解 Halo。 @@ -49,7 +49,7 @@ import DockerEnv from "./slots/docker-env.md" 1. 创建 Halo + PostgreSQL 的实例: - ```yaml {18-28,46} title="~/halo/docker-compose.yaml" + ```yaml {18-28,45} title="~/halo/docker-compose.yaml" version: "3" services: @@ -66,19 +66,18 @@ import DockerEnv from "./slots/docker-env.md" - ./:/root/.halo2 ports: - "8090:8090" - environment: - - SPRING_R2DBC_URL=r2dbc:pool:postgresql://halodb/halo - - SPRING_R2DBC_USERNAME=halo + command: + - --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo + - --spring.r2dbc.username=halo # PostgreSQL 的密码,请保证与下方 POSTGRES_PASSWORD 的变量值一致。 - - SPRING_R2DBC_PASSWORD=openpostgresql - - SPRING_SQL_INIT_PLATFORM=postgresql + - --spring.r2dbc.password=openpostgresql + - --spring.sql.init.platform=postgresql # 外部访问地址,请根据实际需要修改 - - HALO_EXTERNAL_URL=http://localhost:8090/ + - --halo.external-url=http://localhost:8090/ # 初始化的超级管理员用户名 - - HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME=admin + - --halo.security.initializer.superadminusername=admin # 初始化的超级管理员密码 - - HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd - + - --halo.security.initializer.superadminpassword=P@88w0rd halodb: image: postgres:latest container_name: halodb @@ -106,7 +105,7 @@ import DockerEnv from "./slots/docker-env.md" 2. 创建 Halo + MySQL 的实例: - ```yaml + ```yaml {18-28,53} title="~/halo/docker-compose.yaml" version: "3" services: @@ -123,18 +122,18 @@ import DockerEnv from "./slots/docker-env.md" - ./:/root/.halo2 ports: - "8090:8090" - environment: - - SPRING_R2DBC_URL=r2dbc:pool:mysql://halodb:3306/halo - - SPRING_R2DBC_USERNAME=root + command: + - --spring.r2dbc.url=r2dbc:pool:mysql://halodb:3306/halo + - --spring.r2dbc.username=root # MySQL 的密码,请保证与下方 MYSQL_ROOT_PASSWORD 的变量值一致。 - - SPRING_R2DBC_PASSWORD=o#DwN&JSa56 - - SPRING_SQL_INIT_PLATFORM=mysql + - --spring.r2dbc.password=o#DwN&JSa56 + - --spring.sql.init.platform=mysql # 外部访问地址,请根据实际需要修改 - - HALO_EXTERNAL_URL=http://localhost:8090/ + - --halo.external-url=http://localhost:8090/ # 初始化的超级管理员用户名 - - HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME=admin + - --halo.security.initializer.superadminusername=admin # 初始化的超级管理员密码 - - HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd + - --halo.security.initializer.superadminpassword=P@88w0rd halodb: image: mysql:8.0.27 @@ -142,10 +141,11 @@ import DockerEnv from "./slots/docker-env.md" restart: on-failure:3 networks: halo_network: - command: --default-authentication-plugin=mysql_native_password - --character-set-server=utf8mb4 - --collation-server=utf8mb4_general_ci - --explicit_defaults_for_timestamp=true + command: + - --default-authentication-plugin=mysql_native_password + - --character-set-server=utf8mb4 + - --collation-server=utf8mb4_general_ci + - --explicit_defaults_for_timestamp=true volumes: - ./mysql:/var/lib/mysql - ./mysqlBackup:/data/mysqlBackup @@ -179,18 +179,18 @@ import DockerEnv from "./slots/docker-env.md" - ./:/root/.halo2 ports: - "8090:8090" - environment: + command: # 外部访问地址,请根据实际需要修改 - - HALO_EXTERNAL_URL=http://localhost:8090/ + - --halo.external-url=http://localhost:8090/ # 初始化的超级管理员用户名 - - HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME=admin + - --halo.security.initializer.superadminusername=admin # 初始化的超级管理员密码 - - HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd + - --halo.security.initializer.superadminpassword=P@88w0rd ``` - 环境变量详解: + 参数详解: - + 3. 启动 Halo 服务 diff --git a/docs/getting-started/install/docker.md b/docs/getting-started/install/docker.md index 9bdef06..e91205d 100644 --- a/docs/getting-started/install/docker.md +++ b/docs/getting-started/install/docker.md @@ -3,7 +3,7 @@ title: 使用 Docker 部署 description: 使用 Docker 部署 --- -import DockerEnv from "./slots/docker-env.md" +import DockerArgs from "./slots/docker-args.md" :::info 在继续操作之前,我们推荐您先阅读[《写在前面》](../prepare),这可以快速帮助你了解 Halo。 @@ -42,10 +42,10 @@ import DockerEnv from "./slots/docker-env.md" --name halo \ -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.1.0 + halohub/halo:2.1.0 \ + --halo.external-url=http://localhost:8090/ \ + --halo.security.initializer.superadminuser=admin \ + --halo.security.initializer.superadminpassword=P@88w0rd ``` :::info @@ -57,14 +57,10 @@ import DockerEnv from "./slots/docker-env.md" - **--name**:为容器指定一个名称 - **-p**:端口映射,格式为 `主机(宿主)端口:容器端口` ,可在 `application.yaml` 配置。 - **-v**:工作目录映射。形式为:`-v 宿主机路径:/root/.halo2`,后者不能修改。 - - **-e**:环境变量 - - `HALO_EXTERNAL_URL`: 外部可访问的链接。例如: - - `HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME`: 超级管理员用户名 - - `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`: 超级管理员用户(admin)的初始化密码。如果该环境变量没有设置,系统将会生成随机密码并打印在日志中。 - 环境变量详解: + 变量详解: - + 1. 用浏览器访问 `$HALO_EXTERNAL_URL/console/`(外部访问链接)即可进入 Halo 管理端。管理员用户名为 `admin`,登录密码为上方设置的 `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`。 diff --git a/docs/getting-started/install/slots/docker-env.md b/docs/getting-started/install/slots/docker-args.md similarity index 74% rename from docs/getting-started/install/slots/docker-env.md rename to docs/getting-started/install/slots/docker-args.md index 98b9cf3..468fe5b 100644 --- a/docs/getting-started/install/slots/docker-env.md +++ b/docs/getting-started/install/slots/docker-args.md @@ -1,12 +1,12 @@ -| 变量名 | 描述 | +| 参数名 | 描述 | | ---------------------------------------------- | -------------------------------------------------------------------------------- | -| `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.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` | 初始超级管理员密码 | 数据库配置: diff --git a/docs/intro.md b/docs/intro.md index e20f446..73b9f85 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -39,10 +39,10 @@ docker run \ --name halo \ -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 + halohub/halo:2.1 \ + --halo.external-url=http://localhost:8090/ \ + --halo.security.initializer.superadminuser=admin \ + --halo.security.initializer.superadminpassword=P@88w0rd ``` 以上仅作为体验使用,详细部署文档请查阅: diff --git a/versioned_docs/version-2.1/getting-started/install/docker-compose.md b/versioned_docs/version-2.1/getting-started/install/docker-compose.md index ed29bd4..02f532b 100644 --- a/versioned_docs/version-2.1/getting-started/install/docker-compose.md +++ b/versioned_docs/version-2.1/getting-started/install/docker-compose.md @@ -3,7 +3,7 @@ title: 使用 Docker Compose 部署 description: 使用 Docker Compose 部署 --- -import DockerEnv from "./slots/docker-env.md" +import DockerArgs from "./slots/docker-args.md" :::info 在继续操作之前,我们推荐您先阅读[《写在前面》](../prepare.md),这可以快速帮助你了解 Halo。 @@ -49,7 +49,7 @@ import DockerEnv from "./slots/docker-env.md" 1. 创建 Halo + PostgreSQL 的实例: - ```yaml {18-28,46} title="~/halo/docker-compose.yaml" + ```yaml {18-28,45} title="~/halo/docker-compose.yaml" version: "3" services: @@ -66,19 +66,18 @@ import DockerEnv from "./slots/docker-env.md" - ./:/root/.halo2 ports: - "8090:8090" - environment: - - SPRING_R2DBC_URL=r2dbc:pool:postgresql://halodb/halo - - SPRING_R2DBC_USERNAME=halo + command: + - --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo + - --spring.r2dbc.username=halo # PostgreSQL 的密码,请保证与下方 POSTGRES_PASSWORD 的变量值一致。 - - SPRING_R2DBC_PASSWORD=openpostgresql - - SPRING_SQL_INIT_PLATFORM=postgresql + - --spring.r2dbc.password=openpostgresql + - --spring.sql.init.platform=postgresql # 外部访问地址,请根据实际需要修改 - - HALO_EXTERNAL_URL=http://localhost:8090/ + - --halo.external-url=http://localhost:8090/ # 初始化的超级管理员用户名 - - HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME=admin + - --halo.security.initializer.superadminusername=admin # 初始化的超级管理员密码 - - HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd - + - --halo.security.initializer.superadminpassword=P@88w0rd halodb: image: postgres:latest container_name: halodb @@ -106,7 +105,7 @@ import DockerEnv from "./slots/docker-env.md" 2. 创建 Halo + MySQL 的实例: - ```yaml + ```yaml {18-28,53} title="~/halo/docker-compose.yaml" version: "3" services: @@ -123,18 +122,18 @@ import DockerEnv from "./slots/docker-env.md" - ./:/root/.halo2 ports: - "8090:8090" - environment: - - SPRING_R2DBC_URL=r2dbc:pool:mysql://halodb:3306/halo - - SPRING_R2DBC_USERNAME=root + command: + - --spring.r2dbc.url=r2dbc:pool:mysql://halodb:3306/halo + - --spring.r2dbc.username=root # MySQL 的密码,请保证与下方 MYSQL_ROOT_PASSWORD 的变量值一致。 - - SPRING_R2DBC_PASSWORD=o#DwN&JSa56 - - SPRING_SQL_INIT_PLATFORM=mysql + - --spring.r2dbc.password=o#DwN&JSa56 + - --spring.sql.init.platform=mysql # 外部访问地址,请根据实际需要修改 - - HALO_EXTERNAL_URL=http://localhost:8090/ + - --halo.external-url=http://localhost:8090/ # 初始化的超级管理员用户名 - - HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME=admin + - --halo.security.initializer.superadminusername=admin # 初始化的超级管理员密码 - - HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd + - --halo.security.initializer.superadminpassword=P@88w0rd halodb: image: mysql:8.0.27 @@ -142,10 +141,11 @@ import DockerEnv from "./slots/docker-env.md" restart: on-failure:3 networks: halo_network: - command: --default-authentication-plugin=mysql_native_password - --character-set-server=utf8mb4 - --collation-server=utf8mb4_general_ci - --explicit_defaults_for_timestamp=true + command: + - --default-authentication-plugin=mysql_native_password + - --character-set-server=utf8mb4 + - --collation-server=utf8mb4_general_ci + - --explicit_defaults_for_timestamp=true volumes: - ./mysql:/var/lib/mysql - ./mysqlBackup:/data/mysqlBackup @@ -179,18 +179,18 @@ import DockerEnv from "./slots/docker-env.md" - ./:/root/.halo2 ports: - "8090:8090" - environment: + command: # 外部访问地址,请根据实际需要修改 - - HALO_EXTERNAL_URL=http://localhost:8090/ + - --halo.external-url=http://localhost:8090/ # 初始化的超级管理员用户名 - - HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME=admin + - --halo.security.initializer.superadminusername=admin # 初始化的超级管理员密码 - - HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd + - --halo.security.initializer.superadminpassword=P@88w0rd ``` - 环境变量详解: + 参数详解: - + 3. 启动 Halo 服务 diff --git a/versioned_docs/version-2.1/getting-started/install/docker.md b/versioned_docs/version-2.1/getting-started/install/docker.md index 9bdef06..7512541 100644 --- a/versioned_docs/version-2.1/getting-started/install/docker.md +++ b/versioned_docs/version-2.1/getting-started/install/docker.md @@ -3,7 +3,7 @@ title: 使用 Docker 部署 description: 使用 Docker 部署 --- -import DockerEnv from "./slots/docker-env.md" +import DockerArgs from "./slots/docker-args.md" :::info 在继续操作之前,我们推荐您先阅读[《写在前面》](../prepare),这可以快速帮助你了解 Halo。 @@ -42,10 +42,10 @@ import DockerEnv from "./slots/docker-env.md" --name halo \ -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.1.0 + halohub/halo:2.1.0 \ + --halo.external-url=http://localhost:8090/ \ + --halo.security.initializer.superadminuser=admin \ + --halo.security.initializer.superadminpassword=P@88w0rd ``` :::info @@ -57,14 +57,10 @@ import DockerEnv from "./slots/docker-env.md" - **--name**:为容器指定一个名称 - **-p**:端口映射,格式为 `主机(宿主)端口:容器端口` ,可在 `application.yaml` 配置。 - **-v**:工作目录映射。形式为:`-v 宿主机路径:/root/.halo2`,后者不能修改。 - - **-e**:环境变量 - - `HALO_EXTERNAL_URL`: 外部可访问的链接。例如: - - `HALO_SECURITY_INITIALIZER_SUPERADMINUSERNAME`: 超级管理员用户名 - - `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`: 超级管理员用户(admin)的初始化密码。如果该环境变量没有设置,系统将会生成随机密码并打印在日志中。 - 环境变量详解: + 参数详解: - + 1. 用浏览器访问 `$HALO_EXTERNAL_URL/console/`(外部访问链接)即可进入 Halo 管理端。管理员用户名为 `admin`,登录密码为上方设置的 `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`。 diff --git a/versioned_docs/version-2.1/getting-started/install/slots/docker-env.md b/versioned_docs/version-2.1/getting-started/install/slots/docker-args.md similarity index 74% rename from versioned_docs/version-2.1/getting-started/install/slots/docker-env.md rename to versioned_docs/version-2.1/getting-started/install/slots/docker-args.md index 98b9cf3..468fe5b 100644 --- a/versioned_docs/version-2.1/getting-started/install/slots/docker-env.md +++ b/versioned_docs/version-2.1/getting-started/install/slots/docker-args.md @@ -1,12 +1,12 @@ -| 变量名 | 描述 | +| 参数名 | 描述 | | ---------------------------------------------- | -------------------------------------------------------------------------------- | -| `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.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` | 初始超级管理员密码 | 数据库配置: diff --git a/versioned_docs/version-2.1/intro.md b/versioned_docs/version-2.1/intro.md index e20f446..73b9f85 100644 --- a/versioned_docs/version-2.1/intro.md +++ b/versioned_docs/version-2.1/intro.md @@ -39,10 +39,10 @@ docker run \ --name halo \ -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 + halohub/halo:2.1 \ + --halo.external-url=http://localhost:8090/ \ + --halo.security.initializer.superadminuser=admin \ + --halo.security.initializer.superadminpassword=P@88w0rd ``` 以上仅作为体验使用,详细部署文档请查阅: