Skip to content

Commit

Permalink
docs: update default docker registry (#370)
Browse files Browse the repository at this point in the history
更新部署文档,添加我们的自建 Docker 仓库,并设置为首选。

```release-note
None
```
  • Loading branch information
ruibaby committed Jun 7, 2024
1 parent 92ef105 commit 3a69e51
Show file tree
Hide file tree
Showing 14 changed files with 72 additions and 188 deletions.
27 changes: 8 additions & 19 deletions docs/getting-started/install/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 使用 Docker Compose 部署
---

import DockerArgs from "./slots/_docker-args.md"
import DockerRegistryList from "./slots/_docker-registry-list.md"

:::info
在继续操作之前,我们推荐您先阅读[《写在前面》](../prepare.md),这可以快速帮助你了解 Halo。
Expand All @@ -20,19 +21,7 @@ import DockerArgs from "./slots/_docker-args.md"

## 创建容器组

可用的 Halo 2.16 的 Docker 镜像:

- [halohub/halo](https://hub.docker.com/r/halohub/halo)
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)

:::info 注意
目前 Halo 2 并未更新 Docker 的 latest 标签镜像,主要因为 Halo 2 不兼容 1.x 版本,防止使用者误操作。我们推荐使用固定版本的标签,比如 `halohub/halo:2.16` 或者 `halohub/halo:2.16.0`

- `halohub/halo:2.16`:表示最新的 2.16.x 版本,即每次发布 patch 版本都会同时更新 `halohub/halo:2.16` 镜像。
- `halohub/halo:2.16.0`:表示一个具体的版本。

后续文档以 `halohub/halo:2.16` 为例。
:::
<DockerRegistryList />

1. 在系统任意位置创建一个文件夹,此文档以 `~/halo` 为例。

Expand All @@ -59,7 +48,7 @@ import DockerArgs from "./slots/_docker-args.md"
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
restart: on-failure:3
depends_on:
halodb:
Expand Down Expand Up @@ -117,7 +106,7 @@ import DockerArgs from "./slots/_docker-args.md"
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
restart: on-failure:3
depends_on:
halodb:
Expand Down Expand Up @@ -185,7 +174,7 @@ import DockerArgs from "./slots/_docker-args.md"
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
restart: on-failure:3
volumes:
- ./halo2:/root/.halo2
Expand All @@ -209,7 +198,7 @@ import DockerArgs from "./slots/_docker-args.md"
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
restart: on-failure:3
network_mode: "host"
volumes:
Expand Down Expand Up @@ -258,7 +247,7 @@ import DockerArgs from "./slots/_docker-args.md"
```yaml {3}
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
```

```bash
Expand Down Expand Up @@ -322,7 +311,7 @@ networks:
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
restart: on-failure:3
volumes:
- ./halo2:/root/.halo2
Expand Down
21 changes: 5 additions & 16 deletions docs/getting-started/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 使用 Docker 部署
---

import DockerArgs from "./slots/_docker-args.md"
import DockerRegistryList from "./slots/_docker-registry-list.md"

:::info
在继续操作之前,我们推荐您先阅读[《写在前面》](../prepare),这可以快速帮助你了解 Halo。
Expand All @@ -25,24 +26,12 @@ import DockerArgs from "./slots/_docker-args.md"

## 使用 Docker 镜像

可用的 Halo 2.16 的 Docker 镜像:

- [halohub/halo](https://hub.docker.com/r/halohub/halo)
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)

:::info 注意
目前 Halo 2 并未更新 Docker 的 latest 标签镜像,主要因为 Halo 2 不兼容 1.x 版本,防止使用者误操作。我们推荐使用固定版本的标签,比如 `halohub/halo:2.16` 或者 `halohub/halo:2.16.0`

- `halohub/halo:2.16`:表示最新的 2.16.x 版本,即每次发布 patch 版本都会同时更新 `halohub/halo:2.16` 镜像。
- `halohub/halo:2.16.0`:表示一个具体的版本。

后续文档以 `halohub/halo:2.16` 为例。
:::
<DockerRegistryList />

1. 创建容器

```bash
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.16
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.16
```

:::info
Expand Down Expand Up @@ -71,7 +60,7 @@ import DockerArgs from "./slots/_docker-args.md"
2. 拉取新版本镜像

```bash
docker pull halohub/halo:2.16
docker pull registry.fit2cloud.com/halo/halo:2.16
```

3. 停止运行中的容器
Expand All @@ -86,5 +75,5 @@ import DockerArgs from "./slots/_docker-args.md"
修改版本号后,按照最初安装的方式,重新创建容器即可。

```bash
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.16
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.16
```
40 changes: 0 additions & 40 deletions docs/getting-started/install/jar-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,6 @@ journalctl -n 20 -u halo
你可以在下面的反向代理软件中任选一项,我们假设你已经安装好了其中一项,并对其的基本操作有一定了解。 如果你对它们没有任何了解,可以参考我们更为详细的反向代理文档:

1. 使用 [Nginx Proxy Manager](../install/other/nginxproxymanager.md)
2. 使用 [Traefik](../install/other/traefik.md)

### Nginx

Expand Down Expand Up @@ -290,42 +289,3 @@ encode gzip
reverse_proxy 127.0.0.1:8090
```

### Traefik

更新 halo 容器组的配置

1. `networks` 中引入已存在的网络 `traefik`(此网络需要 [提前创建](../install/other/traefik.md#创建-traefik))
2. `services.halo.networks` 中添加网络 `traefik`
3. 修改外部地址为你的域名
4. 声明路由规则、开启 TLS

```yaml {4-5,16,20,25-31}
version: "3.8"
networks:
traefik:
external: true
halo:
services:
halo:
image: halohub/halo:2.16
container_name: halo
restart: on-failure:3
volumes:
- ./halo2:/root/.halo2
networks:
- traefik
- halo
command:
# 外部访问地址,请根据实际需要修改
- --halo.external-url=https://yourdomain.com
labels:
traefik.enable: "true"
traefik.docker.network: traefik
traefik.http.routers.halo.rule: Host(`yourdomain.com`)
traefik.http.routers.halo.tls: "true"
traefik.http.routers.halo.tls.certresolver: myresolver
traefik.http.services.halo.loadbalancer.server.port: 8090
```
2 changes: 1 addition & 1 deletion docs/getting-started/install/other/traefik.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ networks:
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
container_name: halo
restart: on-failure:3
volumes:
Expand Down
21 changes: 5 additions & 16 deletions docs/getting-started/install/podman.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 使用 Podman 部署
---

import DockerArgs from "./slots/_docker-args.md"
import DockerRegistryList from "./slots/_docker-registry-list.md"

## 前言

Expand Down Expand Up @@ -50,25 +51,13 @@ Podman 采用无守护进程的包容性架构,因此可以更安全、更简
通过[前言](#前言)我们已经了解了 Podman ,其中提到 ***Podman 与 Docker 高度兼容*** ,正是因为 Podman 完全是为了替代 Docker 而诞生,所以原本的 Docker 生态中的镜像我们可以无需更改直接使用。
:::

可用的 Halo 2.16 的 Docker 镜像:

- [halohub/halo](https://hub.docker.com/r/halohub/halo)
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)

:::info 注意
目前 Halo 2 并未更新 Docker 的 latest 标签镜像,主要因为 Halo 2 不兼容 1.x 版本,防止使用者误操作。我们推荐使用固定版本的标签,比如 `halohub/halo:2.16` 或者 `halohub/halo:2.16.0`

- `halohub/halo:2.16`:表示最新的 2.16.x 版本,即每次发布 patch 版本都会同时更新 `halohub/halo:2.16` 镜像。
- `halohub/halo:2.16.0`:表示一个具体的版本。

后续文档以 `halohub/halo:2.16` 为例。
:::
<DockerRegistryList />

1. 创建容器

```bash
mkdir -p ~/.halo2
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.16
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.16
```

:::info
Expand Down Expand Up @@ -97,7 +86,7 @@ Podman 采用无守护进程的包容性架构,因此可以更安全、更简
2. 拉取新版本镜像

```bash
podman pull halohub/halo:2.16
podman pull registry.fit2cloud.com/halo/halo:2.16
```

3. 停止运行中的容器
Expand All @@ -112,7 +101,7 @@ Podman 采用无守护进程的包容性架构,因此可以更安全、更简
修改版本号后,按照最初安装的方式,重新创建容器即可。

```bash
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 halohub/halo:2.16
podman run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.16
```

## 使用 [Podman Quadlet](https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html)
Expand Down
15 changes: 15 additions & 0 deletions docs/getting-started/install/slots/_docker-registry-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
目前 Halo 官方维护的 Docker 镜像仓库,可以根据自己的需求选择合适的镜像源:

- registry.fit2cloud.com/halo/halo
- [halohub/halo](https://hub.docker.com/r/halohub/halo)
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)

:::info 注意
目前 Halo 2 并未更新 Docker 的 latest 标签镜像,主要因为 Halo 2 不兼容 1.x 版本,防止使用者误操作。我们推荐使用固定版本的标签,比如 `2.16` 或者 `2.16.0`

- `registry.fit2cloud.com/halo/halo:2`:表示最新的 2.x 版本,即每次发布新版本都会更新此镜像。
- `registry.fit2cloud.com/halo/halo:2.16`:表示最新的 2.16.x 版本,即每次发布 patch 版本都会同时更新此镜像。
- `registry.fit2cloud.com/halo/halo:2.16.0`:表示一个具体的版本。

后续文档以 `registry.fit2cloud.com/halo/halo:2.16` 为例。
:::
4 changes: 2 additions & 2 deletions docs/user-guide/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,15 +93,15 @@ server {
--name halo-1 \
-p 8090:8090 \
-v ~/.halo2:/root/.halo2 \
halohub/halo:2.16 \
registry.fit2cloud.com/halo/halo:2.16 \
# 第二个 Halo 容器
docker run \
-it -d \
--name halo-2 \
-p 8091:8090 \
-v ~/.halo2_2:/root/.halo2 \
halohub/halo:2.16 \
registry.fit2cloud.com/halo/halo:2.16 \
```

更多 Docker 相关的教程请参考:[使用 Docker 部署 Halo](../getting-started/install/docker.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 使用 Docker Compose 部署
---

import DockerArgs from "./slots/_docker-args.md"
import DockerRegistryList from "./slots/_docker-registry-list.md"

:::info
在继续操作之前,我们推荐您先阅读[《写在前面》](../prepare.md),这可以快速帮助你了解 Halo。
Expand All @@ -20,19 +21,7 @@ import DockerArgs from "./slots/_docker-args.md"

## 创建容器组

可用的 Halo 2.16 的 Docker 镜像:

- [halohub/halo](https://hub.docker.com/r/halohub/halo)
- [ghcr.io/halo-dev/halo](https://github.com/halo-dev/halo/pkgs/container/halo)

:::info 注意
目前 Halo 2 并未更新 Docker 的 latest 标签镜像,主要因为 Halo 2 不兼容 1.x 版本,防止使用者误操作。我们推荐使用固定版本的标签,比如 `halohub/halo:2.16` 或者 `halohub/halo:2.16.0`

- `halohub/halo:2.16`:表示最新的 2.16.x 版本,即每次发布 patch 版本都会同时更新 `halohub/halo:2.16` 镜像。
- `halohub/halo:2.16.0`:表示一个具体的版本。

后续文档以 `halohub/halo:2.16` 为例。
:::
<DockerRegistryList />

1. 在系统任意位置创建一个文件夹,此文档以 `~/halo` 为例。

Expand All @@ -59,7 +48,7 @@ import DockerArgs from "./slots/_docker-args.md"
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
restart: on-failure:3
depends_on:
halodb:
Expand Down Expand Up @@ -117,7 +106,7 @@ import DockerArgs from "./slots/_docker-args.md"
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
restart: on-failure:3
depends_on:
halodb:
Expand Down Expand Up @@ -185,7 +174,7 @@ import DockerArgs from "./slots/_docker-args.md"
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
restart: on-failure:3
volumes:
- ./halo2:/root/.halo2
Expand All @@ -209,7 +198,7 @@ import DockerArgs from "./slots/_docker-args.md"
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
restart: on-failure:3
network_mode: "host"
volumes:
Expand Down Expand Up @@ -258,7 +247,7 @@ import DockerArgs from "./slots/_docker-args.md"
```yaml {3}
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
```

```bash
Expand Down Expand Up @@ -322,7 +311,7 @@ networks:
services:
halo:
image: halohub/halo:2.16
image: registry.fit2cloud.com/halo/halo:2.16
restart: on-failure:3
volumes:
- ./halo2:/root/.halo2
Expand Down
Loading

0 comments on commit 3a69e51

Please sign in to comment.