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.

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

update zh docusaurus #438

Merged
merged 1 commit into from
Feb 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,16 @@ services:
- ./palworld:/palworld/
```

## 启动服务器

使用 `docker compose up -d` 在后台启动服务器

## 停止服务器

使用 `docker compose stop` 停止服务器

使用 `docker compose down --rmi all` 停止并删除服务器,并从计算机中删除 Docker 镜像。

### Docker Run

```bash
Expand Down Expand Up @@ -118,13 +128,3 @@ docker run -d \
--stop-timeout 30 \
thijsvanloef/palworld-server-docker:latest # Use the latest-arm64 tag for arm64 hosts
```

## 启动服务器

使用 `docker compose up -d` 在后台启动服务器

## 停止服务器

使用 `docker compose stop` 停止服务器

使用 `docker compose down --rmi all` 停止并删除服务器,并从计算机中删除 Docker 镜像。
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,26 @@ sidebar_position: 4

# 自动重启

## 使用 Cron 执行自动重启
## 使用 Cron 配置自动重启

为了能够使用该服务器的自动重启功能,需要启用 `RCON_ENABLED` 。
要使用此服务器的自动重启功能,必须将以下环境变量设置为 `true`:

* `RCON_ENABLED`

:::warning

如果 Docker 重启策略不是设为 `always` 或 `unless-stopped`,那麽伺服器将会关闭,需要手动重新启动。
如果 docker 重启未设置为策略 `always` 或 `unless-stopped`,
则服务器将关闭并需要手动重新启动。

在 [开始使用](https://palworld-server-docker.loef.dev/zh/) 中的示例 Docker run 命令和 Docker Compose 文件已經使用了所需的策略
[快速设置](https://palworld-server-docker.loef.dev/zh/)中的示例 docker run 命令和 docker-compose 文件已使用所需的策略
:::

设置 `AUTO_REBOOT_ENABLED` 以启用或禁用自动备份(默认为禁用)。

`AUTO_REBOOT_CRON_EXPRESSION` 是一个cron表达式,在Cron表达式中,需要定义了运行作业的间隔。
| 变量 | 信息 | 默认值 | 允许的值 |
|-----------------------------------|----------------------------------------------------------------------------|----------------|-----------------------------------------------------------------------------------------------------------------------|
| AUTO_REBOOT_CRON_EXPRESSION | 设置影响自动更新的频率。 | 0 0 \* \* \* | 需要 Cron 表达式 - 请参见 [使用 Cron 配置自动备份](https://palworld-server-docker.loef.dev/zh/guides/backup/automated-backup/) |
| AUTO_REBOOT_ENABLED | 启用自动重启 | false | true/false |
| AUTO_REBOOT_WARN_MINUTES | 在通知玩家后等待多长时间重启服务器 | 5 | !0 |
| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | 即使有玩家在线,也重新启动服务器 | false | true/false |

:::tip
该镜像使用 Supercronic 进行 cron 作业。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,15 @@ sidebar_position: 5
在 [开始使用](https://palworld-server-docker.loef.dev/zh/) 中的示例 Docker run 命令和 Docker Compose 文件已經使用了所需的策略。
:::

设置 `AUTO_UPDATE_ENABLED` 以启用或禁用自动更新(默认为禁用)。

`AUTO_UPDATE_CRON_EXPRESSION` 是一个cron表达式,在Cron表达式中,需要定义了运行作业的间隔。

> [!TIP]
> 这个镜像使用 Supercronic 来执行 cron 任务。
> 查阅 [supercronic](https://github.com/aptible/supercronic#crontab-format)
> 或者
> [Crontab Generat](https://crontab-generator.org).
| 变量 | 信息 | 默认值 | 允许的值 |
|-----------------------------|----------------------------------------------------------------------------------------------------------------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| AUTO_UPDATE_CRON_EXPRESSION | 设置影响自动更新的频率。 | 0 \* \* \* \* | 需要 Cron 表达式 - 请参见[使用 Cron 配置自动备份](https://palworld-server-docker.loef.dev/zh/guides/backup/automated-backup/) |
| AUTO_UPDATE_ENABLED | 启用自动更新 | false | true/false |
| AUTO_UPDATE_WARN_MINUTES | 在通知玩家后等待多长时间更新服务器(如果没有玩家连接,将忽略此设置) | 30 | !0 |
:::tip
这个镜像使用 Supercronic 来执行 cron 任务。
查阅 [supercronic](https://github.com/aptible/supercronic#crontab-format)
或者 [Crontab Generat](https://crontab-generator.org).
:::

設置 `AUTO_UPDATE_CRON_EXPRESSION` 以更改默認时程。
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_position: 7
---

# 固定游戏版本

:::warning
降级到较低的游戏版本是可能的,但目前无法确定这将对现有存档产生什么影响。

**请自行承担风险!**
:::

如果设置了 **TARGET_MANIFEST_ID** 环境变量,将会锁定服务器版本到特定的清单(manifest)。
清单对应发布日期/更新版本。可以使用 SteamCMD 或类似 [SteamDB](https://steamdb.info/depot/2394012/manifests/) 的网站找到清单。

## 版本与清单 ID 对照表

| 版本 | 清单 ID |
|---------|------------------------|
| 1.3.0 | 1354752814336157338 |
| 1.4.0 | 4190579964382773830 |
| 1.4.1 | 6370735655629434989 |
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
sidebar_position: 6
---

# 无需使用 root 用户运行

这仅适用于高级用户

可以运行此容器并[覆盖默认用户](https://docs.docker.com/engine/reference/run/#user),默认用户是此镜像中的 root 用户。

由于您正在指定用户和组,`PUID` 和 `PGID` 将被忽略。

如果要查找您的 UID:`id -u`
如果要查找您的 GID:`id -g`

您必须将用户设置为 `NUMBERICAL_UID:NUMBERICAL_GID`

以下假设您的 UID 为 1000,GID 为 1001

* 在 docker run 中添加 `--user 1000:1001 \` 到最后一行上方。
* 在 docker-compose 中添加 `user: 1000:1001` 到端口上方。

如果希望使用与您自己不同的 UID/GID 运行它,您需要更改正在绑定的目录的所有权:`chown UID:GID palworld/`
或通过更改所有其他用户的权限:`chmod o=rwx palworld/`
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_position: 4
---

# 版本

此页面展示了 Docker 镜像标签的版本规则。

## 版本结构

所有镜像都按照 [Semver](https://semver.org/) 进行标记,除了 `latest` 和 `dev` 镜像。

* `latest`: 始终是最新发布版本
* `dev`: 最新进行中的版本(仅用于测试)
* `vX`: 最新的主版本
* `vX.X`: 最新的次版本
* `vX.X.X`: 具体版本
Loading