Skip to content

Commit

Permalink
docs: update the instructions for the initial administrator in the de…
Browse files Browse the repository at this point in the history
…ployment document

Signed-off-by: Ryan Wang <[email protected]>
  • Loading branch information
ruibaby committed Aug 16, 2023
1 parent 72c2ef8 commit 6e1e3b0
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 89 deletions.
6 changes: 1 addition & 5 deletions docs/getting-started/first-post.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,7 @@ description: 安装完成后,如何写下第一篇文章。

## 登录管理端

浏览器访问 `/console` 即可进入 Halo 管理端。用户名密码为部署在配置文件中时设置的 `halo.security.initializer.superadminusername``halo.security.initializer.superadminpassword`

:::info
如果你在安装时没有设置 `halo.security.initializer.superadminpassword` 变量或忘记了设置的密码,可以参考[常见问题中的忘记密码章节](../user-guide/faq.md#忘记密码怎么办)进行处理。
:::
浏览器访问 `/console` 即可进入 Halo 管理端。

## 新建文章

Expand Down
29 changes: 4 additions & 25 deletions docs/getting-started/install/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ import DockerArgs from "./slots/docker-args.md"

1. 创建 Halo + PostgreSQL 的实例:

```yaml {24-34,51} title="~/halo/docker-compose.yaml"
```yaml {24-30,47} title="~/halo/docker-compose.yaml"
version: "3"
services:
Expand Down Expand Up @@ -85,10 +85,6 @@ import DockerArgs from "./slots/docker-args.md"
- --spring.sql.init.platform=postgresql
# 外部访问地址,请根据实际需要修改
- --halo.external-url=http://localhost:8090/
# 初始化的超级管理员用户名
- --halo.security.initializer.superadminusername=admin
# 初始化的超级管理员密码
- --halo.security.initializer.superadminpassword=P@88w0rd
halodb:
image: postgres:latest
container_name: halodb
Expand Down Expand Up @@ -116,7 +112,7 @@ import DockerArgs from "./slots/docker-args.md"

2. 创建 Halo + MySQL 的实例:

```yaml {24-34,59} title="~/halo/docker-compose.yaml"
```yaml {24-30,55} title="~/halo/docker-compose.yaml"
version: "3"
services:
Expand Down Expand Up @@ -147,10 +143,6 @@ import DockerArgs from "./slots/docker-args.md"
- --spring.sql.init.platform=mysql
# 外部访问地址,请根据实际需要修改
- --halo.external-url=http://localhost:8090/
# 初始化的超级管理员用户名
- --halo.security.initializer.superadminusername=admin
# 初始化的超级管理员密码
- --halo.security.initializer.superadminpassword=P@88w0rd
halodb:
image: mysql:8.0.31
Expand Down Expand Up @@ -205,14 +197,10 @@ import DockerArgs from "./slots/docker-args.md"
command:
# 外部访问地址,请根据实际需要修改
- --halo.external-url=http://localhost:8090/
# 初始化的超级管理员用户名
- --halo.security.initializer.superadminusername=admin
# 初始化的超级管理员密码
- --halo.security.initializer.superadminpassword=P@88w0rd
```
4. 仅创建 Halo 实例(使用已有外部数据库,MySQL 为例):

```yaml {8,21-24} title="~/halo/docker-compose.yaml"
```yaml {8,12-20} title="~/halo/docker-compose.yaml"
version: "3"
services:
Expand All @@ -231,13 +219,8 @@ import DockerArgs from "./slots/docker-args.md"
- --spring.sql.init.platform=mysql
# 外部访问地址,请根据实际需要修改
- --halo.external-url=http://localhost:8090/
# 初始化的超级管理员用户名
- --halo.security.initializer.superadminusername=admin
# 初始化的超级管理员密码
- --halo.security.initializer.superadminpassword=P@88w0rd
# 端口号 默认8090
- --server.port=8090
```

参数详解:
Expand All @@ -256,7 +239,7 @@ import DockerArgs from "./slots/docker-args.md"
docker-compose logs -f
```

4. 用浏览器访问 `/console` 即可进入 Halo 管理页面,用户名和密码为在 `docker-compose.yaml` 文件中设置的 `superadminusername``superadminpassword`
4. 用浏览器访问 /console 即可进入 Halo 管理页面,首次启动会进入初始化页面

:::tip
如果需要配置域名访问,建议先配置好反向代理以及域名解析再进行初始化。如果通过 `http://ip:端口号` 的形式无法访问,请到服务器厂商后台将运行的端口号添加到安全组,如果服务器使用了 Linux 面板,请检查此 Linux 面板是否有还有安全组配置,需要同样将端口号添加到安全组。
Expand Down Expand Up @@ -366,10 +349,6 @@ services:
command:
# 外部访问地址,请根据实际需要修改
- --halo.external-url=https://yourdomain.com
# 初始化的超级管理员用户名
- --halo.security.initializer.superadminusername=admin
# 初始化的超级管理员密码
- --halo.security.initializer.superadminpassword=P@88w0rd
labels:
traefik.enable: "true"
traefik.docker.network: traefik
Expand Down
24 changes: 4 additions & 20 deletions docs/getting-started/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,7 @@ import DockerArgs from "./slots/docker-args.md"
1. 创建容器

```bash
docker run \
-it -d \
--name halo \
-p 8090:8090 \
-v ~/.halo2:/root/.halo2 \
halohub/halo:2.8 \
--halo.external-url=http://localhost:8090/ \
--halo.security.initializer.superadminusername=admin \
--halo.security.initializer.superadminpassword=P@88w0rd
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.8 --halo.external-url=http://localhost:8090/
```

:::info
Expand All @@ -67,7 +59,7 @@ import DockerArgs from "./slots/docker-args.md"

<DockerArgs />

1. 用浏览器访问 `/console` 即可进入 Halo 管理页面,用户名和密码为启动参数中的 `superadminusername``superadminpassword`
1. 用浏览器访问 `/console` 即可进入 Halo 管理页面,首次启动会进入初始化页面

:::tip
如果需要配置域名访问,建议先配置好反向代理以及域名解析再进行初始化。如果通过 `http://ip:端口号` 的形式无法访问,请到服务器厂商后台将运行的端口号添加到安全组,如果服务器使用了 Linux 面板,请检查此 Linux 面板是否有还有安全组配置,需要同样将端口号添加到安全组。
Expand Down Expand Up @@ -100,14 +92,6 @@ import DockerArgs from "./slots/docker-args.md"

修改版本号后,按照最初安装的方式,重新创建容器即可。

```bash {6}
docker run \
-it -d \
--name halo \
-p 8090:8090 \
-v ~/.halo2:/root/.halo2 \
halohub/halo:2.8 \
--halo.external-url=http://localhost:8090/ \
--halo.security.initializer.superadminusername=admin \
--halo.security.initializer.superadminpassword=P@88w0rd
```bash
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.8 --halo.external-url=http://localhost:8090/
```
4 changes: 0 additions & 4 deletions docs/getting-started/install/other/traefik.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,6 @@ services:
command:
# 外部访问地址,请根据实际需要修改
- --halo.external-url=https://yourdomain.com
# 初始化的超级管理员用户名
- --halo.security.initializer.superadminusername=admin
# 初始化的超级管理员密码
- --halo.security.initializer.superadminpassword=P@88w0rd
labels:
traefik.enable: "true"
traefik.docker.network: traefik
Expand Down
2 changes: 0 additions & 2 deletions docs/getting-started/install/slots/docker-args.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
| `spring.r2dbc.password` | 数据库密码 |
| `spring.sql.init.platform` | 数据库平台名称,支持 `postgresql``mysql``h2` |
| `halo.external-url` | 外部访问链接,如果需要在公网访问,需要配置为实际访问地址 |
| `halo.security.initializer.superadminusername` | 初始超级管理员用户名 |
| `halo.security.initializer.superadminpassword` | 初始超级管理员密码 |
| `halo.cache.page.disabled` | 是否禁用页面缓存,默认为禁用,如需页面缓存可以手动添加此配置,并设置为 `false`。<br />开启缓存之后,在登录的情况下不会经过缓存,且默认一个小时会清理掉不活跃的缓存,也可以在 Console 仪表盘的快捷访问中手动清理缓存。 |

数据库配置:
Expand Down
9 changes: 1 addition & 8 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,7 @@ slug: /
## 快速开始

```bash
docker run \
-it -d \
--name halo \
-p 8090:8090 \
-v ~/.halo2:/root/.halo2 \
halohub/halo:2.8 \
--halo.security.initializer.superadminusername=admin \
--halo.security.initializer.superadminpassword=P@88w0rd
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.8
```

以上仅作为体验使用,详细部署文档请查阅:<https://docs.halo.run/getting-started/install/docker-compose>
Expand Down
28 changes: 3 additions & 25 deletions docs/user-guide/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@ description: 使用上的常见问题

### 忘记密码怎么办?

如果安装时没有指定 `halo.security.initializer.superadminpassword` 参数,系统会随机一个初始化密码,可以通过下面的命令进行查看。

```bash
docker logs halo | grep 'Generated random password:' | tail -1
```

如果你已经修改过初始化密码后忘记了密码,假设系统中还有可用的具有用户管理权限的其他用户,可以通过该用户参考[修改用户密码](./users#修改用户密码)部分,修改指定用户的密码。没有可用的具有用户管理权限的管理员用户时,目前需要通过删除数据库记录的方式,触发管理员用户的初始化任务进行密码重置。

假设 Halo 使用容器方式运行,容器名称为 `halo`,具体操作如下。
Expand All @@ -25,7 +19,7 @@ docker logs halo | grep 'Generated random password:' | tail -1
docker stop halo
```

2. 连接 Halo 使用的数据库,删除管理员的用户记录(配置文件中的 `halo.security.initializer.superadminusername`,这里以 `admin` 为例
2. 连接 Halo 使用的数据库,删除管理员的用户记录,这里以 `admin` 为例

以容器化部署的 PostgreSQL 为例,假设容器名称为 `halo_db`

Expand Down Expand Up @@ -96,26 +90,10 @@ server {

```bash
# 第一个 Halo 容器
docker run \
-it -d \
--name halo-1 \
-p 8090:8090 \
-v ~/.halo2:/root/.halo2 \
halohub/halo:2.8 \
--halo.external-url=http://localhost:8090/ \
--halo.security.initializer.superadminusername=admin \
--halo.security.initializer.superadminpassword=P@88w0rd
docker run -it -d --name halo-1 -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.8 --halo.external-url=http://localhost:8090/
# 第二个 Halo 容器
docker run \
-it -d \
--name halo-2 \
-p 8091:8090 \
-v ~/.halo2_2:/root/.halo2 \
halohub/halo:2.8 \
--halo.external-url=http://localhost:8091/ \
--halo.security.initializer.superadminusername=admin \
--halo.security.initializer.superadminpassword=P@88w0rd
docker run -it -d --name halo-2 -p 8091:8090 -v ~/.halo2_2:/root/.halo2 halohub/halo:2.8 --halo.external-url=http://localhost:8091/
```

更多 Docker 相关的教程请参考:[使用 Docker 部署 Halo](../getting-started/install/docker.md)
Expand Down

0 comments on commit 6e1e3b0

Please sign in to comment.