Skip to content

Commit 7a5ca0a

Browse files
ruibabyruibaby
authored
Remove obsolete version field from docker-compose.yaml examples (#588)
Docker Compose 2.0+ ignores the version field and emits a warning: `version is obsolete`. This removes the field from all examples and updates the code-highlight line numbers accordingly. Fixes #505
1 parent bfc5797 commit 7a5ca0a

8 files changed

Lines changed: 40 additions & 120 deletions

File tree

‎docs/getting-started/install/docker-compose.md‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
4343

4444
<Tabs queryString="current">
4545
<TabItem value="halo-postgresql" label="Halo + PostgreSQL（推荐）" default>
46-
```yaml {26-32,46} title="~/halo/docker-compose.yaml"
47-
version: "3"
48-
46+
```yaml {24-30,44} title="~/halo/docker-compose.yaml"
4947
services:
5048
halo:
5149
image: registry.fit2cloud.com/halo/halo-pro:2.24
@@ -102,9 +100,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
102100
:::
103101
</TabItem>
104102
<TabItem value="halo-mysql" label="Halo + MySQL">
105-
```yaml {26-32,54} title="~/halo/docker-compose.yaml"
106-
version: "3"
107-
103+
```yaml {24-30,52} title="~/halo/docker-compose.yaml"
108104
services:
109105
halo:
110106
image: registry.fit2cloud.com/halo/halo-pro:2.24
@@ -172,9 +168,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
172168
不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。
173169
:::
174170

175-
```yaml {22} title="~/halo/docker-compose.yaml"
176-
version: "3"
177-
171+
```yaml {20} title="~/halo/docker-compose.yaml"
178172
services:
179173
halo:
180174
image: registry.fit2cloud.com/halo/halo-pro:2.24
@@ -198,9 +192,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
198192
```
199193
</TabItem>
200194
<TabItem value="external-db" label="使用外部数据库">
201-
```yaml {7,15-22} title="~/halo/docker-compose.yaml"
202-
version: "3"
203-
195+
```yaml {5,13-20} title="~/halo/docker-compose.yaml"
204196
services:
205197
halo:
206198
image: registry.fit2cloud.com/halo/halo-pro:2.24
@@ -325,9 +317,7 @@ reverse_proxy 127.0.0.1:8090
325317
3. 修改外部地址为你的域名
326318
4. 声明路由规则、开启 TLS
327319

328-
```yaml {4-5,16,20,25-31}
329-
version: "3.8"
330-
320+
```yaml {2-3,14,18,23-29}
331321
networks:
332322
traefik:
333323
external: true

‎versioned_docs/version-2.18/getting-started/install/docker-compose.md‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
4747

4848
<Tabs queryString="current">
4949
<TabItem value="halo-postgresql" label="Halo + PostgreSQL" default>
50-
```yaml {23-29,43} title="~/halo/docker-compose.yaml"
51-
version: "3"
52-
50+
```yaml {21-27,41} title="~/halo/docker-compose.yaml"
5351
services:
5452
halo:
5553
image: registry.fit2cloud.com/halo/halo:2.18
@@ -103,9 +101,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
103101
:::
104102
</TabItem>
105103
<TabItem value="halo-mysql" label="Halo + MySQL">
106-
```yaml {23-29,51} title="~/halo/docker-compose.yaml"
107-
version: "3"
108-
104+
```yaml {21-27,49} title="~/halo/docker-compose.yaml"
109105
services:
110106
halo:
111107
image: registry.fit2cloud.com/halo/halo:2.18
@@ -170,9 +166,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
170166
不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。
171167
:::
172168

173-
```yaml {19-24} title="~/halo/docker-compose.yaml"
174-
version: "3"
175-
169+
```yaml {17-22} title="~/halo/docker-compose.yaml"
176170
services:
177171
halo:
178172
image: registry.fit2cloud.com/halo/halo:2.18
@@ -193,9 +187,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
193187
```
194188
</TabItem>
195189
<TabItem value="external-db" label="使用外部数据库">
196-
```yaml {7,12-20} title="~/halo/docker-compose.yaml"
197-
version: "3"
198-
190+
```yaml {5,10-18} title="~/halo/docker-compose.yaml"
199191
services:
200192
halo:
201193
image: registry.fit2cloud.com/halo/halo:2.18
@@ -303,9 +295,7 @@ reverse_proxy 127.0.0.1:8090
303295
3. 修改外部地址为你的域名
304296
4. 声明路由规则、开启 TLS
305297

306-
```yaml {4-5,16,20,25-31}
307-
version: "3.8"
308-
298+
```yaml {2-3,14,18,23-29}
309299
networks:
310300
traefik:
311301
external: true

‎versioned_docs/version-2.19/getting-started/install/docker-compose.md‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
4747

4848
<Tabs queryString="current">
4949
<TabItem value="halo-postgresql" label="Halo + PostgreSQL" default>
50-
```yaml {23-29,43} title="~/halo/docker-compose.yaml"
51-
version: "3"
52-
50+
```yaml {21-27,41} title="~/halo/docker-compose.yaml"
5351
services:
5452
halo:
5553
image: registry.fit2cloud.com/halo/halo:2.19
@@ -103,9 +101,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
103101
:::
104102
</TabItem>
105103
<TabItem value="halo-mysql" label="Halo + MySQL">
106-
```yaml {23-29,51} title="~/halo/docker-compose.yaml"
107-
version: "3"
108-
104+
```yaml {21-27,49} title="~/halo/docker-compose.yaml"
109105
services:
110106
halo:
111107
image: registry.fit2cloud.com/halo/halo:2.19
@@ -170,9 +166,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
170166
不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。
171167
:::
172168

173-
```yaml {19-24} title="~/halo/docker-compose.yaml"
174-
version: "3"
175-
169+
```yaml {17-22} title="~/halo/docker-compose.yaml"
176170
services:
177171
halo:
178172
image: registry.fit2cloud.com/halo/halo:2.19
@@ -193,9 +187,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
193187
```
194188
</TabItem>
195189
<TabItem value="external-db" label="使用外部数据库">
196-
```yaml {7,12-20} title="~/halo/docker-compose.yaml"
197-
version: "3"
198-
190+
```yaml {5,10-18} title="~/halo/docker-compose.yaml"
199191
services:
200192
halo:
201193
image: registry.fit2cloud.com/halo/halo:2.19
@@ -303,9 +295,7 @@ reverse_proxy 127.0.0.1:8090
303295
3. 修改外部地址为你的域名
304296
4. 声明路由规则、开启 TLS
305297

306-
```yaml {4-5,16,20,25-31}
307-
version: "3.8"
308-
298+
```yaml {2-3,14,18,23-29}
309299
networks:
310300
traefik:
311301
external: true

‎versioned_docs/version-2.20/getting-started/install/docker-compose.md‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
4747

4848
<Tabs queryString="current">
4949
<TabItem value="halo-postgresql" label="Halo + PostgreSQL" default>
50-
```yaml {26-32,46} title="~/halo/docker-compose.yaml"
51-
version: "3"
52-
50+
```yaml {24-30,44} title="~/halo/docker-compose.yaml"
5351
services:
5452
halo:
5553
image: registry.fit2cloud.com/halo/halo:2.20
@@ -106,9 +104,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
106104
:::
107105
</TabItem>
108106
<TabItem value="halo-mysql" label="Halo + MySQL">
109-
```yaml {26-32,54} title="~/halo/docker-compose.yaml"
110-
version: "3"
111-
107+
```yaml {24-30,52} title="~/halo/docker-compose.yaml"
112108
services:
113109
halo:
114110
image: registry.fit2cloud.com/halo/halo:2.20
@@ -176,9 +172,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
176172
不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。
177173
:::
178174

179-
```yaml {22} title="~/halo/docker-compose.yaml"
180-
version: "3"
181-
175+
```yaml {20} title="~/halo/docker-compose.yaml"
182176
services:
183177
halo:
184178
image: registry.fit2cloud.com/halo/halo:2.20
@@ -202,9 +196,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
202196
```
203197
</TabItem>
204198
<TabItem value="external-db" label="使用外部数据库">
205-
```yaml {7,15-22} title="~/halo/docker-compose.yaml"
206-
version: "3"
207-
199+
```yaml {5,13-20} title="~/halo/docker-compose.yaml"
208200
services:
209201
halo:
210202
image: registry.fit2cloud.com/halo/halo:2.20
@@ -327,9 +319,7 @@ reverse_proxy 127.0.0.1:8090
327319
3. 修改外部地址为你的域名
328320
4. 声明路由规则、开启 TLS
329321

330-
```yaml {4-5,16,20,25-31}
331-
version: "3.8"
332-
322+
```yaml {2-3,14,18,23-29}
333323
networks:
334324
traefik:
335325
external: true

‎versioned_docs/version-2.21/getting-started/install/docker-compose.md‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
4747

4848
<Tabs queryString="current">
4949
<TabItem value="halo-postgresql" label="Halo + PostgreSQL（推荐）" default>
50-
```yaml {26-32,46} title="~/halo/docker-compose.yaml"
51-
version: "3"
52-
50+
```yaml {24-30,44} title="~/halo/docker-compose.yaml"
5351
services:
5452
halo:
5553
image: registry.fit2cloud.com/halo/halo:2.21
@@ -106,9 +104,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
106104
:::
107105
</TabItem>
108106
<TabItem value="halo-mysql" label="Halo + MySQL">
109-
```yaml {26-32,54} title="~/halo/docker-compose.yaml"
110-
version: "3"
111-
107+
```yaml {24-30,52} title="~/halo/docker-compose.yaml"
112108
services:
113109
halo:
114110
image: registry.fit2cloud.com/halo/halo:2.21
@@ -176,9 +172,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
176172
不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。
177173
:::
178174

179-
```yaml {22} title="~/halo/docker-compose.yaml"
180-
version: "3"
181-
175+
```yaml {20} title="~/halo/docker-compose.yaml"
182176
services:
183177
halo:
184178
image: registry.fit2cloud.com/halo/halo:2.21
@@ -202,9 +196,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
202196
```
203197
</TabItem>
204198
<TabItem value="external-db" label="使用外部数据库">
205-
```yaml {7,15-22} title="~/halo/docker-compose.yaml"
206-
version: "3"
207-
199+
```yaml {5,13-20} title="~/halo/docker-compose.yaml"
208200
services:
209201
halo:
210202
image: registry.fit2cloud.com/halo/halo:2.21
@@ -327,9 +319,7 @@ reverse_proxy 127.0.0.1:8090
327319
3. 修改外部地址为你的域名
328320
4. 声明路由规则、开启 TLS
329321

330-
```yaml {4-5,16,20,25-31}
331-
version: "3.8"
332-
322+
```yaml {2-3,14,18,23-29}
333323
networks:
334324
traefik:
335325
external: true

‎versioned_docs/version-2.22/getting-started/install/docker-compose.md‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
4343

4444
<Tabs queryString="current">
4545
<TabItem value="halo-postgresql" label="Halo + PostgreSQL（推荐）" default>
46-
```yaml {26-32,46} title="~/halo/docker-compose.yaml"
47-
version: "3"
48-
46+
```yaml {24-30,44} title="~/halo/docker-compose.yaml"
4947
services:
5048
halo:
5149
image: registry.fit2cloud.com/halo/halo-pro:2.22
@@ -102,9 +100,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
102100
:::
103101
</TabItem>
104102
<TabItem value="halo-mysql" label="Halo + MySQL">
105-
```yaml {26-32,54} title="~/halo/docker-compose.yaml"
106-
version: "3"
107-
103+
```yaml {24-30,52} title="~/halo/docker-compose.yaml"
108104
services:
109105
halo:
110106
image: registry.fit2cloud.com/halo/halo-pro:2.22
@@ -172,9 +168,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
172168
不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。
173169
:::
174170

175-
```yaml {22} title="~/halo/docker-compose.yaml"
176-
version: "3"
177-
171+
```yaml {20} title="~/halo/docker-compose.yaml"
178172
services:
179173
halo:
180174
image: registry.fit2cloud.com/halo/halo-pro:2.22
@@ -198,9 +192,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
198192
```
199193
</TabItem>
200194
<TabItem value="external-db" label="使用外部数据库">
201-
```yaml {7,15-22} title="~/halo/docker-compose.yaml"
202-
version: "3"
203-
195+
```yaml {5,13-20} title="~/halo/docker-compose.yaml"
204196
services:
205197
halo:
206198
image: registry.fit2cloud.com/halo/halo-pro:2.22
@@ -325,9 +317,7 @@ reverse_proxy 127.0.0.1:8090
325317
3. 修改外部地址为你的域名
326318
4. 声明路由规则、开启 TLS
327319

328-
```yaml {4-5,16,20,25-31}
329-
version: "3.8"
330-
320+
```yaml {2-3,14,18,23-29}
331321
networks:
332322
traefik:
333323
external: true

‎versioned_docs/version-2.23/getting-started/install/docker-compose.md‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
4343

4444
<Tabs queryString="current">
4545
<TabItem value="halo-postgresql" label="Halo + PostgreSQL（推荐）" default>
46-
```yaml {26-32,46} title="~/halo/docker-compose.yaml"
47-
version: "3"
48-
46+
```yaml {24-30,44} title="~/halo/docker-compose.yaml"
4947
services:
5048
halo:
5149
image: registry.fit2cloud.com/halo/halo-pro:2.23
@@ -102,9 +100,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
102100
:::
103101
</TabItem>
104102
<TabItem value="halo-mysql" label="Halo + MySQL">
105-
```yaml {26-32,54} title="~/halo/docker-compose.yaml"
106-
version: "3"
107-
103+
```yaml {24-30,52} title="~/halo/docker-compose.yaml"
108104
services:
109105
halo:
110106
image: registry.fit2cloud.com/halo/halo-pro:2.23
@@ -172,9 +168,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
172168
不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。
173169
:::
174170

175-
```yaml {22} title="~/halo/docker-compose.yaml"
176-
version: "3"
177-
171+
```yaml {20} title="~/halo/docker-compose.yaml"
178172
services:
179173
halo:
180174
image: registry.fit2cloud.com/halo/halo-pro:2.23
@@ -198,9 +192,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
198192
```
199193
</TabItem>
200194
<TabItem value="external-db" label="使用外部数据库">
201-
```yaml {7,15-22} title="~/halo/docker-compose.yaml"
202-
version: "3"
203-
195+
```yaml {5,13-20} title="~/halo/docker-compose.yaml"
204196
services:
205197
halo:
206198
image: registry.fit2cloud.com/halo/halo-pro:2.23
@@ -325,9 +317,7 @@ reverse_proxy 127.0.0.1:8090
325317
3. 修改外部地址为你的域名
326318
4. 声明路由规则、开启 TLS
327319

328-
```yaml {4-5,16,20,25-31}
329-
version: "3.8"
330-
320+
```yaml {2-3,14,18,23-29}
331321
networks:
332322
traefik:
333323
external: true

0 commit comments

Comments
 (0)