From 9daf9148790f441b60c271e2bf3d940200549c99 Mon Sep 17 00:00:00 2001 From: Ryan Wang Date: Mon, 8 May 2023 12:27:38 +0800 Subject: [PATCH] docs: refine documentation of installation (#215) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 优化安装文档。 1. 优化安装完成之后的提示。 2. 优化 Docker 启动参数的描述。 3. Docker 的数据库配置参数添加 MariaDB 的说明。 4. 移动反向代理方式的顺序。 /kind documentation ```release-note None ``` --- .../getting-started/install/docker-compose.md | 66 +++++++++---------- docs/getting-started/install/docker.md | 4 +- .../install/slots/docker-args.md | 5 +- .../getting-started/install/docker-compose.md | 66 +++++++++---------- .../getting-started/install/docker.md | 4 +- .../install/slots/docker-args.md | 5 +- 6 files changed, 76 insertions(+), 74 deletions(-) diff --git a/docs/getting-started/install/docker-compose.md b/docs/getting-started/install/docker-compose.md index 938b9b4..8f8fa8b 100644 --- a/docs/getting-started/install/docker-compose.md +++ b/docs/getting-started/install/docker-compose.md @@ -256,7 +256,7 @@ import DockerArgs from "./slots/docker-args.md" docker-compose logs -f ``` -4. 用浏览器访问 `$HALO_EXTERNAL_URL/console/`（外部访问链接）即可进入 Halo 管理端。管理员用户名为 `admin`，登录密码为上方设置的 `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`。 +4. 用浏览器访问 `/console` 即可进入 Halo 管理页面，用户名和密码为在 `docker-compose.yaml` 文件中设置的 `superadminusername` 和 `superadminpassword`。 :::tip 如果需要配置域名访问，建议先配置好反向代理以及域名解析再进行初始化。如果通过 `http://ip:端口号` 的形式无法访问，请到服务器厂商后台将运行的端口号添加到安全组，如果服务器使用了 Linux 面板，请检查此 Linux 面板是否有还有安全组配置，需要同样将端口号添加到安全组。 @@ -305,6 +305,37 @@ import DockerArgs from "./slots/docker-args.md" 2. 使用 [Nginx Proxy Manager](../install/other/nginxproxymanager.md) 3. 使用 [Traefik](../install/other/traefik.md) +### Nginx + +```nginx {2,7,10} +upstream halo { + server 127.0.0.1:8090; +} +server { + listen 80; + listen [::]:80; + server_name www.yourdomain.com; + client_max_body_size 1024m; + location / { + proxy_pass http://halo; + proxy_set_header HOST $host; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + } +} +``` + +### Caddy 2 + +```txt {1,5} +www.yourdomain.com + +encode gzip + +reverse_proxy 127.0.0.1:8090 +``` + ### Traefik 更新 halo 容器组的配置 @@ -314,7 +345,7 @@ import DockerArgs from "./slots/docker-args.md" 3. 修改外部地址为你的域名 4. 声明路由规则、开启 TLS -```yaml {4-5,16,20,25-31} showLineNumbers +```yaml {4-5,16,20,25-31} version: "3.8" networks: @@ -347,34 +378,3 @@ services: traefik.http.routers.halo.tls.certresolver: myresolver traefik.http.services.halo.loadbalancer.server.port: 8090 ``` - -### Nginx - -```nginx {2,7,10} -upstream halo { - server 127.0.0.1:8090; -} -server { - listen 80; - listen [::]:80; - server_name www.yourdomain.com; - client_max_body_size 1024m; - location / { - proxy_pass http://halo; - proxy_set_header HOST $host; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - } -} -``` - -### Caddy 2 - -```txt {1,5} -www.yourdomain.com - -encode gzip - -reverse_proxy 127.0.0.1:8090 -``` diff --git a/docs/getting-started/install/docker.md b/docs/getting-started/install/docker.md index 99ac570..4c4b90b 100644 --- a/docs/getting-started/install/docker.md +++ b/docs/getting-started/install/docker.md @@ -50,7 +50,7 @@ import DockerArgs from "./slots/docker-args.md" halohub/halo:2.5 \ --halo.external-url=http://localhost:8090/ \ --halo.security.initializer.superadminusername=admin \ - --halo.security.initializer.superadminpassword=P@88w0rd + --halo.security.initializer.superadminpassword=P@88w0rd ``` :::info @@ -67,7 +67,7 @@ import DockerArgs from "./slots/docker-args.md" -1. 用浏览器访问 `$HALO_EXTERNAL_URL/console/`（外部访问链接）即可进入 Halo 管理端。管理员用户名为 `admin`，登录密码为上方设置的 `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`。 +1. 用浏览器访问 `/console` 即可进入 Halo 管理页面，用户名和密码为启动参数中的 `superadminusername` 和 `superadminpassword`。 :::tip 如果需要配置域名访问，建议先配置好反向代理以及域名解析再进行初始化。如果通过 `http://ip:端口号` 的形式无法访问，请到服务器厂商后台将运行的端口号添加到安全组，如果服务器使用了 Linux 面板，请检查此 Linux 面板是否有还有安全组配置，需要同样将端口号添加到安全组。 diff --git a/docs/getting-started/install/slots/docker-args.md b/docs/getting-started/install/slots/docker-args.md index 59583bb..a7f791a 100644 --- a/docs/getting-started/install/slots/docker-args.md +++ b/docs/getting-started/install/slots/docker-args.md @@ -3,15 +3,16 @@ | `spring.r2dbc.url` | 数据库连接地址，详细可查阅下方的 `数据库配置` | | `spring.r2dbc.username` | 数据库用户名 | | `spring.r2dbc.password` | 数据库密码 | -| `spring.sql.init.platform` | 数据库平台名称，支持 `postgresql`、`mysql`、`h2`，需要与 `SPRING_R2DBC_URL` 对应 | +| `spring.sql.init.platform` | 数据库平台名称，支持 `postgresql`、`mysql`、`h2` | | `halo.external-url` | 外部访问链接，如果需要在公网访问，需要配置为实际访问地址 | | `halo.security.initializer.superadminusername` | 初始超级管理员用户名 | | `halo.security.initializer.superadminpassword` | 初始超级管理员密码 | 数据库配置： -| 链接方式 | 链接地址格式 | `SPRING_SQL_INIT_PLATFORM` | +| 链接方式 | 链接地址格式 | `spring.sql.init.platform` | | ----------- | ---------------------------------------------------------------------------------- | -------------------------- | | PostgreSQL | `r2dbc:pool:postgresql://{HOST}:{PORT}/{DATABASE}` | postgresql | | MySQL | `r2dbc:pool:mysql://{HOST}:{PORT}/{DATABASE}` | mysql | +| MariaDB | `r2dbc:pool:mariadb://{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.5/getting-started/install/docker-compose.md b/versioned_docs/version-2.5/getting-started/install/docker-compose.md index 938b9b4..8f8fa8b 100644 --- a/versioned_docs/version-2.5/getting-started/install/docker-compose.md +++ b/versioned_docs/version-2.5/getting-started/install/docker-compose.md @@ -256,7 +256,7 @@ import DockerArgs from "./slots/docker-args.md" docker-compose logs -f ``` -4. 用浏览器访问 `$HALO_EXTERNAL_URL/console/`（外部访问链接）即可进入 Halo 管理端。管理员用户名为 `admin`，登录密码为上方设置的 `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`。 +4. 用浏览器访问 `/console` 即可进入 Halo 管理页面，用户名和密码为在 `docker-compose.yaml` 文件中设置的 `superadminusername` 和 `superadminpassword`。 :::tip 如果需要配置域名访问，建议先配置好反向代理以及域名解析再进行初始化。如果通过 `http://ip:端口号` 的形式无法访问，请到服务器厂商后台将运行的端口号添加到安全组，如果服务器使用了 Linux 面板，请检查此 Linux 面板是否有还有安全组配置，需要同样将端口号添加到安全组。 @@ -305,6 +305,37 @@ import DockerArgs from "./slots/docker-args.md" 2. 使用 [Nginx Proxy Manager](../install/other/nginxproxymanager.md) 3. 使用 [Traefik](../install/other/traefik.md) +### Nginx + +```nginx {2,7,10} +upstream halo { + server 127.0.0.1:8090; +} +server { + listen 80; + listen [::]:80; + server_name www.yourdomain.com; + client_max_body_size 1024m; + location / { + proxy_pass http://halo; + proxy_set_header HOST $host; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + } +} +``` + +### Caddy 2 + +```txt {1,5} +www.yourdomain.com + +encode gzip + +reverse_proxy 127.0.0.1:8090 +``` + ### Traefik 更新 halo 容器组的配置 @@ -314,7 +345,7 @@ import DockerArgs from "./slots/docker-args.md" 3. 修改外部地址为你的域名 4. 声明路由规则、开启 TLS -```yaml {4-5,16,20,25-31} showLineNumbers +```yaml {4-5,16,20,25-31} version: "3.8" networks: @@ -347,34 +378,3 @@ services: traefik.http.routers.halo.tls.certresolver: myresolver traefik.http.services.halo.loadbalancer.server.port: 8090 ``` - -### Nginx - -```nginx {2,7,10} -upstream halo { - server 127.0.0.1:8090; -} -server { - listen 80; - listen [::]:80; - server_name www.yourdomain.com; - client_max_body_size 1024m; - location / { - proxy_pass http://halo; - proxy_set_header HOST $host; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - } -} -``` - -### Caddy 2 - -```txt {1,5} -www.yourdomain.com - -encode gzip - -reverse_proxy 127.0.0.1:8090 -``` diff --git a/versioned_docs/version-2.5/getting-started/install/docker.md b/versioned_docs/version-2.5/getting-started/install/docker.md index 99ac570..4c4b90b 100644 --- a/versioned_docs/version-2.5/getting-started/install/docker.md +++ b/versioned_docs/version-2.5/getting-started/install/docker.md @@ -50,7 +50,7 @@ import DockerArgs from "./slots/docker-args.md" halohub/halo:2.5 \ --halo.external-url=http://localhost:8090/ \ --halo.security.initializer.superadminusername=admin \ - --halo.security.initializer.superadminpassword=P@88w0rd + --halo.security.initializer.superadminpassword=P@88w0rd ``` :::info @@ -67,7 +67,7 @@ import DockerArgs from "./slots/docker-args.md" -1. 用浏览器访问 `$HALO_EXTERNAL_URL/console/`（外部访问链接）即可进入 Halo 管理端。管理员用户名为 `admin`，登录密码为上方设置的 `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`。 +1. 用浏览器访问 `/console` 即可进入 Halo 管理页面，用户名和密码为启动参数中的 `superadminusername` 和 `superadminpassword`。 :::tip 如果需要配置域名访问，建议先配置好反向代理以及域名解析再进行初始化。如果通过 `http://ip:端口号` 的形式无法访问，请到服务器厂商后台将运行的端口号添加到安全组，如果服务器使用了 Linux 面板，请检查此 Linux 面板是否有还有安全组配置，需要同样将端口号添加到安全组。 diff --git a/versioned_docs/version-2.5/getting-started/install/slots/docker-args.md b/versioned_docs/version-2.5/getting-started/install/slots/docker-args.md index 59583bb..a7f791a 100644 --- a/versioned_docs/version-2.5/getting-started/install/slots/docker-args.md +++ b/versioned_docs/version-2.5/getting-started/install/slots/docker-args.md @@ -3,15 +3,16 @@ | `spring.r2dbc.url` | 数据库连接地址，详细可查阅下方的 `数据库配置` | | `spring.r2dbc.username` | 数据库用户名 | | `spring.r2dbc.password` | 数据库密码 | -| `spring.sql.init.platform` | 数据库平台名称，支持 `postgresql`、`mysql`、`h2`，需要与 `SPRING_R2DBC_URL` 对应 | +| `spring.sql.init.platform` | 数据库平台名称，支持 `postgresql`、`mysql`、`h2` | | `halo.external-url` | 外部访问链接，如果需要在公网访问，需要配置为实际访问地址 | | `halo.security.initializer.superadminusername` | 初始超级管理员用户名 | | `halo.security.initializer.superadminpassword` | 初始超级管理员密码 | 数据库配置： -| 链接方式 | 链接地址格式 | `SPRING_SQL_INIT_PLATFORM` | +| 链接方式 | 链接地址格式 | `spring.sql.init.platform` | | ----------- | ---------------------------------------------------------------------------------- | -------------------------- | | PostgreSQL | `r2dbc:pool:postgresql://{HOST}:{PORT}/{DATABASE}` | postgresql | | MySQL | `r2dbc:pool:mysql://{HOST}:{PORT}/{DATABASE}` | mysql | +| MariaDB | `r2dbc:pool:mariadb://{HOST}:{PORT}/{DATABASE}` | mysql | | H2 Database | `r2dbc:h2:file:///${halo.work-dir}/db/halo-next?MODE=MySQL&DB_CLOSE_ON_EXIT=FALSE` | h2 |