halo/docs
1
0
Fork 0
mirror of https://github.com/halo-dev/docs.git synced 2025-10-20 09:38:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add JVM_OPTS environment documentation (#442)

Browse Source 
为 Docker 部署添加 JVM_OPTS 环境变量的说明。

Fixes #17 

/kind documentation

```release-note
None
```
This commit is contained in:
Ryan Wang
2024-10-24 15:31:49 +08:00
committed by GitHub
parent bb4ade60ec
commit 0074d76b4c
4 changed files with 36 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/getting-started/install/docker-compose.md
View File

@@ -47,7 +47,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
<Tabs queryString="current"> <Tabs queryString="current">
<TabItem value="halo-postgresql" label="Halo + PostgreSQL" default> <TabItem value="halo-postgresql" label="Halo + PostgreSQL" default>
```yaml {23-29,43} title="~/halo/docker-compose.yaml" ```yaml {26-32,46} title="~/halo/docker-compose.yaml"
version: "3" version: "3"
services: services:
@@ -69,6 +69,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
timeout: 5s timeout: 5s
retries: 5 retries: 5
start_period: 30s start_period: 30s
environment:
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
- JVM_OPTS=-Xmx256m -Xms256m
command: command:
- --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo - --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo
- --spring.r2dbc.username=halo - --spring.r2dbc.username=halo
@@ -103,7 +106,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
::: :::
</TabItem> </TabItem>
<TabItem value="halo-mysql" label="Halo + MySQL"> <TabItem value="halo-mysql" label="Halo + MySQL">
```yaml {23-29,51} title="~/halo/docker-compose.yaml" ```yaml {26-32,54} title="~/halo/docker-compose.yaml"
version: "3" version: "3"
services: services:
@@ -125,6 +128,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
timeout: 5s timeout: 5s
retries: 5 retries: 5
start_period: 30s start_period: 30s
environment:
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
- JVM_OPTS=-Xmx256m -Xms256m
command: command:
- --spring.r2dbc.url=r2dbc:pool:mysql://halodb:3306/halo - --spring.r2dbc.url=r2dbc:pool:mysql://halodb:3306/halo
- --spring.r2dbc.username=root - --spring.r2dbc.username=root
@@ -170,7 +176,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。 不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。
::: :::
```yaml {19-24} title="~/halo/docker-compose.yaml" ```yaml {22} title="~/halo/docker-compose.yaml"
version: "3" version: "3"
services: services:
@@ -186,14 +192,17 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
interval: 30s interval: 30s
timeout: 5s timeout: 5s
retries: 5 retries: 5
start_period: 30s start_period: 30s
environment:
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
- JVM_OPTS=-Xmx256m -Xms256m
command: command:
# 外部访问地址，请根据实际需要修改 # 外部访问地址，请根据实际需要修改
- --halo.external-url=http://localhost:8090/ - --halo.external-url=http://localhost:8090/
``` ```
</TabItem> </TabItem>
<TabItem value="external-db" label="使用外部数据库"> <TabItem value="external-db" label="使用外部数据库">
```yaml {7,12-20} title="~/halo/docker-compose.yaml" ```yaml {7,15-22} title="~/halo/docker-compose.yaml"
version: "3" version: "3"
services: services:
@@ -203,6 +212,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
network_mode: "host" network_mode: "host"
volumes: volumes:
- ./halo2:/root/.halo2 - ./halo2:/root/.halo2
environment:
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
- JVM_OPTS=-Xmx256m -Xms256m
command: command:
# 修改为自己已有的 MySQL 配置 # 修改为自己已有的 MySQL 配置
- --spring.r2dbc.url=r2dbc:pool:mysql://localhost:3306/halo - --spring.r2dbc.url=r2dbc:pool:mysql://localhost:3306/halo

2
docs/getting-started/install/docker.md
View File

@@ -31,7 +31,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
1. 创建容器 1. 创建容器
```bash ```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 :::info

22
versioned_docs/version-2.20/getting-started/install/docker-compose.md
View File

@@ -47,7 +47,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
<Tabs queryString="current"> <Tabs queryString="current">
<TabItem value="halo-postgresql" label="Halo + PostgreSQL" default> <TabItem value="halo-postgresql" label="Halo + PostgreSQL" default>
```yaml {23-29,43} title="~/halo/docker-compose.yaml" ```yaml {26-32,46} title="~/halo/docker-compose.yaml"
version: "3" version: "3"
services: services:
@@ -69,6 +69,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
timeout: 5s timeout: 5s
retries: 5 retries: 5
start_period: 30s start_period: 30s
environment:
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
- JVM_OPTS=-Xmx256m -Xms256m
command: command:
- --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo - --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo
- --spring.r2dbc.username=halo - --spring.r2dbc.username=halo
@@ -103,7 +106,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
::: :::
</TabItem> </TabItem>
<TabItem value="halo-mysql" label="Halo + MySQL"> <TabItem value="halo-mysql" label="Halo + MySQL">
```yaml {23-29,51} title="~/halo/docker-compose.yaml" ```yaml {26-32,54} title="~/halo/docker-compose.yaml"
version: "3" version: "3"
services: services:
@@ -125,6 +128,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
timeout: 5s timeout: 5s
retries: 5 retries: 5
start_period: 30s start_period: 30s
environment:
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
- JVM_OPTS=-Xmx256m -Xms256m
command: command:
- --spring.r2dbc.url=r2dbc:pool:mysql://halodb:3306/halo - --spring.r2dbc.url=r2dbc:pool:mysql://halodb:3306/halo
- --spring.r2dbc.username=root - --spring.r2dbc.username=root
@@ -170,7 +176,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。 不推荐在生产环境使用默认的 H2 数据库，这可能因为操作不当导致数据文件损坏。如果因为某些原因（如内存不足以运行独立数据库）必须要使用，建议按时[备份数据](../../user-guide/backup.md)。
::: :::
```yaml {19-24} title="~/halo/docker-compose.yaml" ```yaml {22} title="~/halo/docker-compose.yaml"
version: "3" version: "3"
services: services:
@@ -186,14 +192,17 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
interval: 30s interval: 30s
timeout: 5s timeout: 5s
retries: 5 retries: 5
start_period: 30s start_period: 30s
environment:
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
- JVM_OPTS=-Xmx256m -Xms256m
command: command:
# 外部访问地址，请根据实际需要修改 # 外部访问地址，请根据实际需要修改
- --halo.external-url=http://localhost:8090/ - --halo.external-url=http://localhost:8090/
``` ```
</TabItem> </TabItem>
<TabItem value="external-db" label="使用外部数据库"> <TabItem value="external-db" label="使用外部数据库">
```yaml {7,12-20} title="~/halo/docker-compose.yaml" ```yaml {7,15-22} title="~/halo/docker-compose.yaml"
version: "3" version: "3"
services: services:
@@ -203,6 +212,9 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
network_mode: "host" network_mode: "host"
volumes: volumes:
- ./halo2:/root/.halo2 - ./halo2:/root/.halo2
environment:
# JVM 参数，默认为 -Xmx256m -Xms256m，可以根据实际情况做调整，置空表示不添加 JVM 参数
- JVM_OPTS=-Xmx256m -Xms256m
command: command:
# 修改为自己已有的 MySQL 配置 # 修改为自己已有的 MySQL 配置
- --spring.r2dbc.url=r2dbc:pool:mysql://localhost:3306/halo - --spring.r2dbc.url=r2dbc:pool:mysql://localhost:3306/halo

2
versioned_docs/version-2.20/getting-started/install/docker.md
View File

@@ -31,7 +31,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
1. 创建容器 1. 创建容器
```bash ```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 :::info