From 0074d76b4ca1746881457dea34c68c9181ef11b8 Mon Sep 17 00:00:00 2001 From: Ryan Wang Date: Thu, 24 Oct 2024 15:31:49 +0800 Subject: [PATCH] docs: add JVM_OPTS environment documentation (#442) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 为 Docker 部署添加 JVM_OPTS 环境变量的说明。 Fixes #17 /kind documentation ```release-note None ``` --- .../getting-started/install/docker-compose.md | 22 ++++++++++++++----- docs/getting-started/install/docker.md | 2 +- .../getting-started/install/docker-compose.md | 22 ++++++++++++++----- .../getting-started/install/docker.md | 2 +- 4 files changed, 36 insertions(+), 12 deletions(-) diff --git a/docs/getting-started/install/docker-compose.md b/docs/getting-started/install/docker-compose.md index 930322cd..7b78639e 100644 --- a/docs/getting-started/install/docker-compose.md +++ b/docs/getting-started/install/docker-compose.md @@ -47,7 +47,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" - ```yaml {23-29,43} title="~/halo/docker-compose.yaml" + ```yaml {26-32,46} title="~/halo/docker-compose.yaml" version: "3" services: @@ -69,6 +69,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" timeout: 5s retries: 5 start_period: 30s + environment: + # JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数 + - JVM_OPTS=-Xmx256m -Xms256m command: - --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo - --spring.r2dbc.username=halo @@ -103,7 +106,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" ::: - ```yaml {23-29,51} title="~/halo/docker-compose.yaml" + ```yaml {26-32,54} title="~/halo/docker-compose.yaml" version: "3" services: @@ -125,6 +128,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" timeout: 5s retries: 5 start_period: 30s + environment: + # JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数 + - JVM_OPTS=-Xmx256m -Xms256m command: - --spring.r2dbc.url=r2dbc:pool:mysql://halodb:3306/halo - --spring.r2dbc.username=root @@ -170,7 +176,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" 不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。 ::: - ```yaml {19-24} title="~/halo/docker-compose.yaml" + ```yaml {22} title="~/halo/docker-compose.yaml" version: "3" services: @@ -186,14 +192,17 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" interval: 30s timeout: 5s retries: 5 - start_period: 30s + start_period: 30s + environment: + # JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数 + - JVM_OPTS=-Xmx256m -Xms256m command: # 外部访问地址，请根据实际需要修改 - --halo.external-url=http://localhost:8090/ ``` - ```yaml {7,12-20} title="~/halo/docker-compose.yaml" + ```yaml {7,15-22} title="~/halo/docker-compose.yaml" version: "3" services: @@ -203,6 +212,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" network_mode: "host" volumes: - ./halo2:/root/.halo2 + environment: + # JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数 + - JVM_OPTS=-Xmx256m -Xms256m command: # 修改为自己已有的 MySQL 配置 - --spring.r2dbc.url=r2dbc:pool:mysql://localhost:3306/halo diff --git a/docs/getting-started/install/docker.md b/docs/getting-started/install/docker.md index b07157ae..92d446d7 100644 --- a/docs/getting-started/install/docker.md +++ b/docs/getting-started/install/docker.md @@ -31,7 +31,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" 1. 创建容器 ```bash - docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.20 + 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 ``` :::info diff --git a/versioned_docs/version-2.20/getting-started/install/docker-compose.md b/versioned_docs/version-2.20/getting-started/install/docker-compose.md index 930322cd..7b78639e 100644 --- a/versioned_docs/version-2.20/getting-started/install/docker-compose.md +++ b/versioned_docs/version-2.20/getting-started/install/docker-compose.md @@ -47,7 +47,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" - ```yaml {23-29,43} title="~/halo/docker-compose.yaml" + ```yaml {26-32,46} title="~/halo/docker-compose.yaml" version: "3" services: @@ -69,6 +69,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" timeout: 5s retries: 5 start_period: 30s + environment: + # JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数 + - JVM_OPTS=-Xmx256m -Xms256m command: - --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo - --spring.r2dbc.username=halo @@ -103,7 +106,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" ::: - ```yaml {23-29,51} title="~/halo/docker-compose.yaml" + ```yaml {26-32,54} title="~/halo/docker-compose.yaml" version: "3" services: @@ -125,6 +128,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" timeout: 5s retries: 5 start_period: 30s + environment: + # JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数 + - JVM_OPTS=-Xmx256m -Xms256m command: - --spring.r2dbc.url=r2dbc:pool:mysql://halodb:3306/halo - --spring.r2dbc.username=root @@ -170,7 +176,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" 不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。 ::: - ```yaml {19-24} title="~/halo/docker-compose.yaml" + ```yaml {22} title="~/halo/docker-compose.yaml" version: "3" services: @@ -186,14 +192,17 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" interval: 30s timeout: 5s retries: 5 - start_period: 30s + start_period: 30s + environment: + # JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数 + - JVM_OPTS=-Xmx256m -Xms256m command: # 外部访问地址，请根据实际需要修改 - --halo.external-url=http://localhost:8090/ ``` - ```yaml {7,12-20} title="~/halo/docker-compose.yaml" + ```yaml {7,15-22} title="~/halo/docker-compose.yaml" version: "3" services: @@ -203,6 +212,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" network_mode: "host" volumes: - ./halo2:/root/.halo2 + environment: + # JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数 + - JVM_OPTS=-Xmx256m -Xms256m command: # 修改为自己已有的 MySQL 配置 - --spring.r2dbc.url=r2dbc:pool:mysql://localhost:3306/halo diff --git a/versioned_docs/version-2.20/getting-started/install/docker.md b/versioned_docs/version-2.20/getting-started/install/docker.md index b07157ae..92d446d7 100644 --- a/versioned_docs/version-2.20/getting-started/install/docker.md +++ b/versioned_docs/version-2.20/getting-started/install/docker.md @@ -31,7 +31,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md" 1. 创建容器 ```bash - docker run -it -d --name halo -p 8090:8090 -v ~/.halo2:/root/.halo2 registry.fit2cloud.com/halo/halo:2.20 + 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 ``` :::info