From 55b34b2e94f4cc39aecfeb8c45f3adbf868aa500 Mon Sep 17 00:00:00 2001 From: Ryan Wang Date: Wed, 23 Mar 2022 11:57:11 +0800 Subject: [PATCH] doc: update documents for Halo 1.5 (#51) --- docs/getting-started/install/docker.md | 18 +++++---- docs/getting-started/install/linux.md | 24 +++++------ .../install/other/docker-mysql.md | 6 +-- docs/getting-started/upgrade.md | 40 +++++++++---------- 4 files changed, 45 insertions(+), 43 deletions(-) diff --git a/docs/getting-started/install/docker.md b/docs/getting-started/install/docker.md index 909048d..cbcad15 100644 --- a/docs/getting-started/install/docker.md +++ b/docs/getting-started/install/docker.md @@ -4,26 +4,26 @@ description: 使用 Docker 部署 --- :::info -在继续操作之前，我们推荐您先阅读[《写在前面》](/getting-started/prepare)，这可以快速帮助你了解 Halo。 +在继续操作之前，我们推荐您先阅读[《写在前面》](../prepare)，这可以快速帮助你了解 Halo。 ::: ## 使用 Docker 镜像 Halo 在 Docker Hub 上发布的镜像为 [halohub/halo](https://hub.docker.com/r/halohub/halo) -1. 创建[工作目录](/getting-started/prepare#工作目录) +1. 创建 [工作目录](../prepare#工作目录) ```bash mkdir ~/.halo && cd ~/.halo ``` -2. 下载示例配置文件到[工作目录](/getting-started/prepare#工作目录) +2. 下载示例配置文件到 [工作目录](../prepare#工作目录) ```bash wget https://dl.halo.run/config/application-template.yaml -O ./application.yaml ``` -3. 编辑配置文件，配置数据库或者端口等，如需配置请参考[参考配置](/getting-started/config) +3. 编辑配置文件，配置数据库或者端口等，如需配置请参考 [配置参考](../config) ```bash vim application.yaml @@ -32,7 +32,7 @@ vim application.yaml 4. 拉取最新的 Halo 镜像 ```bash -docker pull halohub/halo:1.5.0-alpha.1 +docker pull halohub/halo:1.5.0 ``` :::info @@ -42,9 +42,13 @@ docker pull halohub/halo:1.5.0-alpha.1 5. 创建容器 ```bash -docker run -it -d --name halo -p 8090:8090 -v ~/.halo:/root/.halo --restart=unless-stopped halohub/halo:1.5.0-alpha.1 +docker run -it -d --name halo -p 8090:8090 -v ~/.halo:/root/.halo --restart=unless-stopped halohub/halo:1.5.0 ``` +:::info +注意：此命令默认使用自带的 H2 Database 数据库。如需使用 MySQL，请参考：[使用 Docker 部署 Halo 和 MySQL](./other/docker-mysql) +::: + - **-it：** 开启输入功能并连接伪终端 - **-d：** 后台运行容器 - **--name：** 为容器指定一个名称 @@ -60,7 +64,7 @@ docker run -it -d --name halo -p 8090:8090 -v ~/.halo:/root/.halo --restart=unle ## 反向代理 -你可以在下面的反向代理软件中任选一项，我们假设你已经安装好了其中一项，并对其的基本操作有一定了解。如果你对 Nginx 不熟悉，我们推荐使用 [OneinStack](/getting-started/install/other/oneinstack) 来管理 Nginx。 +你可以在下面的反向代理软件中任选一项，我们假设你已经安装好了其中一项，并对其的基本操作有一定了解。如果你对 Nginx 不熟悉，我们推荐使用 [OneinStack](./other/oneinstack) 来管理 Nginx。 ### Nginx diff --git a/docs/getting-started/install/linux.md b/docs/getting-started/install/linux.md index 6b5043e..62ba59c 100644 --- a/docs/getting-started/install/linux.md +++ b/docs/getting-started/install/linux.md @@ -1,10 +1,10 @@ --- title: 在 Linux 环境部署 -description: 在Linux上快速安装Halo +description: 在 Linux 上快速安装 Halo --- :::info -在继续操作之前，我们推荐您先阅读[《写在前面》](/getting-started/prepare)，这可以快速帮助你了解 Halo。 +在继续操作之前，我们推荐您先阅读[《写在前面》](../prepare)，这可以快速帮助你了解 Halo。 ::: ## 依赖检查 @@ -13,7 +13,7 @@ description: 在Linux上快速安装Halo 目前介绍两种 Linux 发行版的安装方式，均为 OpenJRE，不推荐 Oracle 版本。 -### CentOS +### CentOS ```bash sudo yum install java-11-openjdk -y @@ -33,7 +33,7 @@ OpenJDK Runtime Environment 18.9 (build 11.0.10+9-LTS) OpenJDK 64-Bit Server VM 18.9 (build 11.0.10+9-LTS, mixed mode, sharing) ``` -### Ubuntu +### Ubuntu ```bash sudo apt-get install openjdk-11-jre -y @@ -85,7 +85,7 @@ passwd halo su - halo ``` -2. 创建存放 [运行包](/getting-started/prepare#运行包) 的目录，这里以 `~/app` 为例 +2. 创建存放 [运行包](../prepare#运行包) 的目录，这里以 `~/app` 为例 ```bash mkdir ~/app && cd ~/app @@ -94,26 +94,26 @@ mkdir ~/app && cd ~/app 3. 下载运行包 ```bash -wget https://dl.halo.run/release/halo-1.5.0-alpha.1.jar -O halo.jar +wget https://dl.halo.run/release/halo-1.5.0.jar -O halo.jar ``` :::info -如果下载速度不理想，可以 [在这里](/getting-started/downloads) 选择其他下载地址。 +如果下载速度不理想，可以 [在这里](../downloads) 选择其他下载地址。 ::: -4. 创建 [工作目录](/getting-started/prepare#工作目录) +4. 创建 [工作目录](../prepare#工作目录) ```bash mkdir ~/.halo && cd ~/.halo ``` -5. 下载示例配置文件到 [工作目录](/getting-started/prepare#工作目录) +5. 下载示例配置文件到 [工作目录](../prepare#工作目录) ```bash wget https://dl.halo.run/config/application-template.yaml -O ./application.yaml ``` -6. 编辑配置文件，配置数据库或者端口等，如需配置请参考 [参考配置](/getting-started/config) +6. 编辑配置文件，配置数据库或者端口等，如需配置请参考 [配置参考](../config) ```bash vim application.yaml @@ -133,7 +133,7 @@ run.halo.app.listener.StartedListener : Halo admin started at http://127.0. run.halo.app.listener.StartedListener : Halo has started successfully! ``` -打开 `http://ip: 端口号` 即可看到安装引导界面。 +打开 `http://ip:端口号` 即可看到安装引导界面。 :::info 如测试启动正常，请继续看`作为服务运行`部分，第 8 步仅仅作为测试。当你关闭 ssh 连接之后，服务会停止。你可使用 CTRL+C 停止运行测试进程。 @@ -221,7 +221,7 @@ journalctl -n 20 -u halo ## 反向代理 -你可以在下面的反向代理软件中任选一项，我们假设你已经安装好了其中一项，并对其基本操作有一定了解。如果你对 Nginx 不熟悉，我们推荐使用 [OneinStack](/getting-started/install/other/oneinstack) 来管理 Nginx。 +你可以在下面的反向代理软件中任选一项，我们假设你已经安装好了其中一项，并对其基本操作有一定了解。如果你对 Nginx 不熟悉，我们推荐使用 [OneinStack](./other/oneinstack) 来管理 Nginx。 ### Nginx diff --git a/docs/getting-started/install/other/docker-mysql.md b/docs/getting-started/install/other/docker-mysql.md index 2597d55..6b10e13 100644 --- a/docs/getting-started/install/other/docker-mysql.md +++ b/docs/getting-started/install/other/docker-mysql.md @@ -122,7 +122,7 @@ spring: 8. 创建 Halo 容器实例 ```shell -docker run -it -d --name halo -p 8090:8090 -v ~/.halo:/root/.halo --net halo-net --restart=unless-stopped halohub/halo:1.5.0-alpha.1 +docker run -it -d --name halo -p 8090:8090 -v ~/.halo:/root/.halo --net halo-net --restart=unless-stopped halohub/halo:1.5.0 ``` 9. 打开 `http://ip:端口号` 即可看到安装引导界面。 @@ -176,7 +176,7 @@ spring: 6. 创建 `Halo` 容器实例,并使用 `--net` 指定网络为刚才创建的`halo-net` ```shell -docker run -it -d --name halo -p 8090:8090 -v ~/.halo:/root/.halo --net halo-net --restart=unless-stopped halohub/halo:1.5.0-alpha.1 +docker run -it -d --name halo -p 8090:8090 -v ~/.halo:/root/.halo --net halo-net --restart=unless-stopped halohub/halo:1.5.0 ``` ### MySQL 在宿主机如何通过 Docker 安装 Halo @@ -198,5 +198,5 @@ wget https://dl.halo.run/config/application-template.yaml -O ./application.yaml 3. 使用 `Docker` 启动 `Halo` 实例并指定网络模式为 `host` ```shell -docker run -it -d --name halo -p 8090:8090 -v ~/.halo:/root/.halo --net host --restart=unless-stopped halohub/halo:1.5.0-alpha.1 +docker run -it -d --name halo -p 8090:8090 -v ~/.halo:/root/.halo --net host --restart=unless-stopped halohub/halo:1.5.0 ``` diff --git a/docs/getting-started/upgrade.md b/docs/getting-started/upgrade.md index ad2dc4d..3c7bbde 100644 --- a/docs/getting-started/upgrade.md +++ b/docs/getting-started/upgrade.md @@ -3,20 +3,12 @@ title: 版本升级 description: 版本升级指南 --- -选择你部署的平台： +当前最新版本为：1.5.0。在更新之前建议先查阅变更日志： -## Linux - -> 我们假设您存放运行包的路径为 `~/app`，运行包的文件名为 `halo.jar`，如有不同，下列命令请按需修改。 - ---- - -:::tip -从 1.4.3 开始，Halo 最低支持的 JRE 版本为 11，在升级前，请务必先升级 JRE。 -::: +## Linux :::info -如果当前您不方便升级到 11，我们推荐使用 [Docker](/getting-started/install/docker) 运行新版 Halo，从 Jar 包的方式迁移到 Docker 运行非常方便，按照[指南](/getting-started/install/docker)在创建容器的时候将容器内的 `/root/.halo` 目录映射到当前 Halo 的工作目录即可。 +我们假设你存放运行包的路径为 `~/app`，运行包的文件名为 `halo.jar`，且使用了 systemd 进行进程管理，如有不同，下列命令请按需修改。 ::: 1. 停止正在运行的服务 @@ -25,20 +17,22 @@ description: 版本升级指南 service halo stop ``` -2. 备份数据以及旧的运行包（重要） +2. 备份数据以及旧的运行包（**重要**） ```bash -cp -r ~/.halo ~/.halo.1.4 +cp -r ~/.halo ~/.halo.archive ``` ```bash -cd ~/app && mv halo.jar halo.jar.1.4 +mv ~/app/halo.jar ~/app/halo.jar.archive ``` +> 需要注意的是，`.halo.archive` 和 `halo.jar.archive` 文件名不一定要根据此文档命名，这里仅仅是个示例。 + 3. 下载最新版本的运行包 ```bash -cd ~/app && wget https://dl.halo.run/release/halo-1.5.0-alpha.1.jar -O halo.jar +cd ~/app && wget https://dl.halo.run/release/halo-1.5.0.jar -O halo.jar ``` :::info @@ -61,9 +55,11 @@ java -jar halo.jar service halo start ``` -## Docker +## Docker -> 我们假设您的容器是按照 [使用 Docker 部署 Halo](/getting-started/install/docker) 中的命令构建的。如有不同，请根据实际情况修改。 +:::info +我们假设您的容器是按照 [使用 Docker 部署 Halo](/getting-started/install/docker) 中的命令构建的。如有不同，请根据实际情况修改。 +::: 1. 停止并删除当前运行中的容器 @@ -82,13 +78,15 @@ docker rm -f halo 2. 备份数据（重要） ```bash -cp -r ~/.halo ~/.halo.1.4 +cp -r ~/.halo ~/.halo.archive ``` -3. 拉取最新的 Halo 镜像 +> 需要注意的是，`.halo.archive` 文件名不一定要根据此文档命名，这里仅仅是个示例。 + +1. 拉取最新的 Halo 镜像 ```bash -docker pull halohub/halo:1.5.0-alpha.1 +docker pull halohub/halo:1.5.0 ``` :::info @@ -98,7 +96,7 @@ docker pull halohub/halo:1.5.0-alpha.1 4. 创建容器 ```bash -docker run -it -d --name halo -p 8090:8090 -v ~/.halo:/root/.halo --restart=unless-stopped halohub/halo:1.5.0-alpha.1 +docker run -it -d --name halo -p 8090:8090 -v ~/.halo:/root/.halo --restart=unless-stopped halohub/halo:1.5.0 ``` - **-it：** 开启输入功能并连接伪终端