Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add JVM_OPTS environment documentation #442

Merged
merged 1 commit into from
Oct 24, 2024
Merged

docs: add JVM_OPTS environment documentation #442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions docs/getting-started/install/docker-compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"

<Tabs queryString="current">
<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"

services:
Expand All @@ -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
Expand Down Expand Up @@ -103,7 +106,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
:::
</TabItem>
<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"

services:
Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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/
```
</TabItem>
<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"

services:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/install/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
22 changes: 17 additions & 5 deletions versioned_docs/version-2.20/getting-started/install/docker-compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"

<Tabs queryString="current">
<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"

services:
Expand All @@ -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
Expand Down Expand Up @@ -103,7 +106,7 @@ import DockerRegistryList from "./slots/_docker-registry-list.md"
:::
</TabItem>
<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"

services:
Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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/
```
</TabItem>
<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"

services:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-2.20/getting-started/install/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down