Skip to content

Commit 0074d76

Browse files
ruibabyruibaby
authoredOct 24, 2024··
docs: add JVM_OPTS environment documentation (#442)
为 Docker 部署添加 JVM_OPTS 环境变量的说明。 Fixes #17 /kind documentation ```release-note None ```
1 parent bb4ade6 commit 0074d76

File tree

4 files changed

+36
-12
lines changed

4 files changed

+36
-12
lines changed
 

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

+17-5
Original file line numberDiff line numberDiff line change
@@ -47,7 +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"
50+
```yaml {26-32,46} title="~/halo/docker-compose.yaml"
5151
version: "3"
5252

5353
services:
@@ -69,6 +69,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
6969
timeout: 5s
7070
retries: 5
7171
start_period: 30s
72+
environment:
73+
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
74+
- JVM_OPTS=-Xmx256m -Xms256m
7275
command:
7376
- --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo
7477
- --spring.r2dbc.username=halo
@@ -103,7 +106,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
103106
:::
104107
</TabItem>
105108
<TabItem value="halo-mysql" label="Halo + MySQL">
106-
```yaml {23-29,51} title="~/halo/docker-compose.yaml"
109+
```yaml {26-32,54} title="~/halo/docker-compose.yaml"
107110
version: "3"
108111

109112
services:
@@ -125,6 +128,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
125128
timeout: 5s
126129
retries: 5
127130
start_period: 30s
131+
environment:
132+
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
133+
- JVM_OPTS=-Xmx256m -Xms256m
128134
command:
129135
- --spring.r2dbc.url=r2dbc:pool:mysql://halodb:3306/halo
130136
- --spring.r2dbc.username=root
@@ -170,7 +176,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
170176
不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。
171177
:::
172178

173-
```yaml {19-24} title="~/halo/docker-compose.yaml"
179+
```yaml {22} title="~/halo/docker-compose.yaml"
174180
version: "3"
175181

176182
services:
@@ -186,14 +192,17 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
186192
interval: 30s
187193
timeout: 5s
188194
retries: 5
189-
start_period: 30s
195+
start_period: 30s
196+
environment:
197+
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
198+
- JVM_OPTS=-Xmx256m -Xms256m
190199
command:
191200
# 外部访问地址，请根据实际需要修改
192201
- --halo.external-url=http://localhost:8090/
193202
```
194203
</TabItem>
195204
<TabItem value="external-db" label="使用外部数据库">
196-
```yaml {7,12-20} title="~/halo/docker-compose.yaml"
205+
```yaml {7,15-22} title="~/halo/docker-compose.yaml"
197206
version: "3"
198207

199208
services:
@@ -203,6 +212,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
203212
network_mode: "host"
204213
volumes:
205214
- ./halo2:/root/.halo2
215+
environment:
216+
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
217+
- JVM_OPTS=-Xmx256m -Xms256m
206218
command:
207219
# 修改为自己已有的 MySQL 配置
208220
- --spring.r2dbc.url=r2dbc:pool:mysql://localhost:3306/halo

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
3131
1. 创建容器
3232

3333
```bash
34-
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.20
34+
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 -e JVM_OPTS="-Xmx256m -Xms256m" registry.fit2cloud.com/halo/halo:2.20
3535
```
3636

3737
:::info

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

+17-5
Original file line numberDiff line numberDiff line change
@@ -47,7 +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"
50+
```yaml {26-32,46} title="~/halo/docker-compose.yaml"
5151
version: "3"
5252

5353
services:
@@ -69,6 +69,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
6969
timeout: 5s
7070
retries: 5
7171
start_period: 30s
72+
environment:
73+
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
74+
- JVM_OPTS=-Xmx256m -Xms256m
7275
command:
7376
- --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo
7477
- --spring.r2dbc.username=halo
@@ -103,7 +106,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
103106
:::
104107
</TabItem>
105108
<TabItem value="halo-mysql" label="Halo + MySQL">
106-
```yaml {23-29,51} title="~/halo/docker-compose.yaml"
109+
```yaml {26-32,54} title="~/halo/docker-compose.yaml"
107110
version: "3"
108111

109112
services:
@@ -125,6 +128,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
125128
timeout: 5s
126129
retries: 5
127130
start_period: 30s
131+
environment:
132+
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
133+
- JVM_OPTS=-Xmx256m -Xms256m
128134
command:
129135
- --spring.r2dbc.url=r2dbc:pool:mysql://halodb:3306/halo
130136
- --spring.r2dbc.username=root
@@ -170,7 +176,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
170176
不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。
171177
:::
172178

173-
```yaml {19-24} title="~/halo/docker-compose.yaml"
179+
```yaml {22} title="~/halo/docker-compose.yaml"
174180
version: "3"
175181

176182
services:
@@ -186,14 +192,17 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
186192
interval: 30s
187193
timeout: 5s
188194
retries: 5
189-
start_period: 30s
195+
start_period: 30s
196+
environment:
197+
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
198+
- JVM_OPTS=-Xmx256m -Xms256m
190199
command:
191200
# 外部访问地址，请根据实际需要修改
192201
- --halo.external-url=http://localhost:8090/
193202
```
194203
</TabItem>
195204
<TabItem value="external-db" label="使用外部数据库">
196-
```yaml {7,12-20} title="~/halo/docker-compose.yaml"
205+
```yaml {7,15-22} title="~/halo/docker-compose.yaml"
197206
version: "3"
198207

199208
services:
@@ -203,6 +212,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
203212
network_mode: "host"
204213
volumes:
205214
- ./halo2:/root/.halo2
215+
environment:
216+
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
217+
- JVM_OPTS=-Xmx256m -Xms256m
206218
command:
207219
# 修改为自己已有的 MySQL 配置
208220
- --spring.r2dbc.url=r2dbc:pool:mysql://localhost:3306/halo

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
3131
1. 创建容器
3232

3333
```bash
34-
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.20
34+
docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 -e JVM_OPTS="-Xmx256m -Xms256m" registry.fit2cloud.com/halo/halo:2.20
3535
```
3636

3737
:::info

0 commit comments

Comments
 (0)