From 0b50b7a8eb1d35490f80a37c2320509497cbaf0e Mon Sep 17 00:00:00 2001 From: Thijs van Loef Date: Sun, 25 Feb 2024 22:07:19 +0100 Subject: [PATCH 1/3] adding/fixing docs --- README.md | 2 +- .../configuration/server-settings.md | 80 ++++++++++--------- docusaurus/docs/known-issues/known-issues.md | 13 +++ 3 files changed, 56 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 5be90dccc..63ec1019f 100644 --- a/README.md +++ b/README.md @@ -547,4 +547,4 @@ Issues/Feature requests can be submitted by using [this link](https://github.com ### Known Issues -Known issues are listed in the [wiki](https://github.com/thijsvanloef/palworld-server-docker/wiki/Known-Issues) +Known issues are listed in the [documentation](https://palworld-server-docker.loef.dev/known-issues/) diff --git a/docusaurus/docs/getting-started/configuration/server-settings.md b/docusaurus/docs/getting-started/configuration/server-settings.md index c8089a0ab..fa8596d6d 100644 --- a/docusaurus/docs/getting-started/configuration/server-settings.md +++ b/docusaurus/docs/getting-started/configuration/server-settings.md @@ -16,44 +16,48 @@ It is highly recommended you set the following environment values before startin * PUID * PGID -| Variable | Info | Default Values | Allowed Values | -|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|---------------------------------------------------------------------------------------| -| TZ | Timezone used for time stamping backup server | UTC | See [TZ Identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations) | -| PLAYERS* | Max amount of players that are able to join the server | 16 | 1-32 | -| PORT* | UDP port that the server will expose | 8211 | 1024-65535 | -| PUID* | The uid of the user the server should run as | 1000 | !0 | -| PGID* | The gid of the group the server should run as | 1000 | !0 | -| MULTITHREADING** | Improves performance in multi-threaded CPU environments. It is effective up to a maximum of about 4 threads, and allocating more than this number of threads does not make much sense. | false | true/false | -| COMMUNITY | Whether or not the server shows up in the community server browser (USE WITH SERVER_PASSWORD) | false | true/false | -| PUBLIC_IP | You can manually specify the global IP address of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. | | x.x.x.x | -| PUBLIC_PORT | You can manually specify the port number of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. | | 1024-65535 | -| SERVER_NAME | A name for your server | | "string" | -| SERVER_DESCRIPTION | Your server Description | | "string" | -| SERVER_PASSWORD | Secure your community server with a password | | "string" | -| ADMIN_PASSWORD | Secure administration access in the server with a password | | "string" | -| UPDATE_ON_BOOT** | Update/Install the server when the docker container starts (THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER) | true | true/false | -| RCON_ENABLED*** | Enable RCON for the Palworld server | true | true/false | -| RCON_PORT | RCON port to connect to | 25575 | 1024-65535 | -| QUERY_PORT | Query port used to communicate with Steam servers | 27015 | 1024-65535 | -| BACKUP_CRON_EXPRESSION | Setting affects frequency of automatic backups. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](https://palworld-server-docker.loef.dev/guides/backup/automated-backup) | -| BACKUP_ENABLED | Enables automatic backups | true | true/false | -| DELETE_OLD_BACKUPS | Delete backups after a certain number of days | false | true/false | -| OLD_BACKUP_DAYS | How many days to keep backups | 30 | any positive integer | -| AUTO_UPDATE_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 \* \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Updates with Cron](https://palworld-server-docker.loef.dev/guides/automatic-updates) | -| AUTO_UPDATE_ENABLED | Enables automatic updates | false | true/false | -| AUTO_UPDATE_WARN_MINUTES | How long to wait to update the server, after the player were informed. | 30 | !0 | -| AUTO_REBOOT_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Reboots with Cron](https://palworld-server-docker.loef.dev/guides/automatic-reboots) | -| AUTO_REBOOT_ENABLED | Enables automatic reboots | false | true/false | -| AUTO_REBOOT_WARN_MINUTES | How long to wait to reboot the server, after the player were informed. | 5 | !0 | -| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Restart the Server even if there are players online. | false | true/false | -| DISCORD_WEBHOOK_URL | Discord webhook url found after creating a webhook on a discord server | | `https://discord.com/api/webhooks/` | -| DISCORD_CONNECT_TIMEOUT | Discord command initial connection timeout | 30 | !0 | -| DISCORD_MAX_TIMEOUT | Discord total hook timeout | 30 | !0 | -| DISCORD_PRE_UPDATE_BOOT_MESSAGE | Discord message sent when server begins updating | Server is updating... | "string" | -| DISCORD_POST_UPDATE_BOOT_MESSAGE | Discord message sent when server completes updating | Server update complete! | "string" | -| DISCORD_PRE_START_MESSAGE | Discord message sent when server begins to start | Server is started! | "string" | -| DISCORD_PRE_SHUTDOWN_MESSAGE | Discord message sent when server begins to shutdown | Server is shutting down... | "string" | -| DISCORD_POST_SHUTDOWN_MESSAGE | Discord message sent when server has stopped | Server is stopped! | "string" | +| Variable | Info | Default Values | Allowed Values | +|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|-------------------------------------------------------------------------------------------------------------------| +| TZ | Timezone used for time stamping backup server | UTC | See [TZ Identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations) | +| PLAYERS* | Max amount of players that are able to join the server | 16 | 1-32 | +| PORT* | UDP port that the server will expose | 8211 | 1024-65535 | +| PUID* | The uid of the user the server should run as | 1000 | !0 | +| PGID* | The gid of the group the server should run as | 1000 | !0 | +| MULTITHREADING** | Improves performance in multi-threaded CPU environments. It is effective up to a maximum of about 4 threads, and allocating more than this number of threads does not make much sense. | false | true/false | +| COMMUNITY | Whether or not the server shows up in the community server browser (USE WITH SERVER_PASSWORD) | false | true/false | +| PUBLIC_IP | You can manually specify the global IP address of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. | | x.x.x.x | +| PUBLIC_PORT | You can manually specify the port number of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. | | 1024-65535 | +| SERVER_NAME | A name for your server | | "string" | +| SERVER_DESCRIPTION | Your server Description | | "string" | +| SERVER_PASSWORD | Secure your community server with a password | | "string" | +| ADMIN_PASSWORD | Secure administration access in the server with a password | | "string" | +| UPDATE_ON_BOOT** | Update/Install the server when the docker container starts (THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER) | true | true/false | +| RCON_ENABLED*** | Enable RCON for the Palworld server | true | true/false | +| RCON_PORT | RCON port to connect to | 25575 | 1024-65535 | +| QUERY_PORT | Query port used to communicate with Steam servers | 27015 | 1024-65535 | +| BACKUP_CRON_EXPRESSION | Setting affects frequency of automatic backups. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](https://palworld-server-docker.loef.dev/guides/backup/automated-backup) | +| BACKUP_ENABLED | Enables automatic backups | true | true/false | +| DELETE_OLD_BACKUPS | Delete backups after a certain number of days | false | true/false | +| OLD_BACKUP_DAYS | How many days to keep backups | 30 | any positive integer | +| AUTO_UPDATE_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 \* \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Updates with Cron](https://palworld-server-docker.loef.dev/guides/automatic-updates) | +| AUTO_UPDATE_ENABLED | Enables automatic updates | false | true/false | +| AUTO_UPDATE_WARN_MINUTES | How long to wait to update the server, after the player were informed. (This will be ignored, if no Players are connected) | 30 | Integer | +| AUTO_REBOOT_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Reboots with Cron](https://palworld-server-docker.loef.dev/guides/automatic-reboots) | +| AUTO_REBOOT_ENABLED | Enables automatic reboots | false | true/false | +| AUTO_REBOOT_WARN_MINUTES | How long to wait to reboot the server, after the player were informed. | 5 | Integer | +| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Restart the Server even if there are players online. | false | true/false | +| TARGET_MANIFEST_ID | Locks game version to corespond with Manfiest ID from Steam Download Depot. | | See [Manifest ID Table](https://palworld-server-docker.loef.dev/guides/pinning-game-version#version-to-manifest-id-table) | +| DISCORD_WEBHOOK_URL | Discord webhook url found after creating a webhook on a discord server | | `https://discord.com/api/webhooks/` | +| DISCORD_CONNECT_TIMEOUT | Discord command initial connection timeout | 30 | !0 | +| DISCORD_MAX_TIMEOUT | Discord total hook timeout | 30 | !0 | +| DISCORD_PRE_UPDATE_BOOT_MESSAGE | Discord message sent when server begins updating | Server is updating... | "string" | +| DISCORD_POST_UPDATE_BOOT_MESSAGE | Discord message sent when server completes updating | Server update complete! | "string" | +| DISCORD_PRE_START_MESSAGE | Discord message sent when server begins to start | Server is started! | "string" | +| DISCORD_PRE_SHUTDOWN_MESSAGE | Discord message sent when server begins to shutdown | Server is shutting down... | "string" | +| DISCORD_POST_SHUTDOWN_MESSAGE | Discord message sent when server has stopped | Server is stopped! | "string" | +| DISABLE_GENERATE_SETTINGS | Whether to automatically generate the PalWorldSettings.ini | false | true/false | +| ENABLE_PLAYER_LOGGING | Enables Logging and announcing when players join and leave | true | true/false | +| PLAYER_LOGGING_POLL_PERIOD | Polling period (in seconds) to check for players who have joined or left | 5 | !0 | *highly recommended to set diff --git a/docusaurus/docs/known-issues/known-issues.md b/docusaurus/docs/known-issues/known-issues.md index deacf113b..0fc3e3765 100644 --- a/docusaurus/docs/known-issues/known-issues.md +++ b/docusaurus/docs/known-issues/known-issues.md @@ -6,6 +6,19 @@ sidebar_position: 5 Known issues of using this Docker image. +## PalWorldSettings.ini keeps resetting + +If the `PalworldSettings.ini` keeps resettings after you have changed the file and rebooted the server. +Please make sure you have `DISABLE_GENERATE_SETTINGS` set to `true`. + +If this is not the case, your setting will be overwritten by the settings set via [the environment variables](https://palworld-server-docker.loef.dev/getting-started/configuration/game-settings). + +:::tip +It is recommended you use the environment variables to set your game settings, instead of manually changing the `PalWorldSettings.ini` + +If you do want to change the file manually, please make sure the server is off when you make the changes. +::: + ## Broadcast command can only send 1 word When using Broadcast among RCON's functions, only one word is transmitted. From a7861e32cd919a4a4138af1599b7204bcb657c5d Mon Sep 17 00:00:00 2001 From: Thijs van Loef Date: Sun, 25 Feb 2024 22:18:06 +0100 Subject: [PATCH 2/3] fix broken anchors --- .../current/getting-started/quick-setup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-setup.md b/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-setup.md index d51a7f07f..f7461fa26 100644 --- a/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-setup.md +++ b/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-setup.md @@ -57,7 +57,7 @@ services: ``` 或者，可以将 [.env.example](https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example) 文件复制到一个名为 **.env** 的新文件中。 -根据需要进行修改，并查看 [环境变量](#/zh/入门/配置/服务器设置#环境变量) 部分以检查正确的 +根据需要进行修改，并查看 [环境变量](https://palworld-server-docker.loef.dev/zh/getting-started/configuration/server-settings#环境变量) 部分以检查正确的 值。将 [docker-compose.yml](https://github.com/thijsvanloef/palworld-server-docker/blob/main/docker-compose.yml) 修改为以下内容： ```yml @@ -114,7 +114,7 @@ docker run -d \ ``` 或者，可以将 [.env.example](https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example) 文件复制到一个名为 **.env** 的新文件中。 -根据需要进行修改，并查看 [环境变量](#/zh/入门/配置/服务器设置#环境变量) 部分以检查正确的值。 +根据需要进行修改，并查看 [环境变量]([#/zh/入门/配置/服务器设置#环境变量](https://palworld-server-docker.loef.dev/zh/getting-started/configuration/server-settings#环境变量)) 部分以检查正确的值。 将 docker run 命令修改为以下内容： ```bash From d0cb7626ffcddbb59272de5bb80366a845fff5dd Mon Sep 17 00:00:00 2001 From: Thijs van Loef Date: Sun, 25 Feb 2024 22:20:17 +0100 Subject: [PATCH 3/3] revert --- .../current/getting-started/quick-setup.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-setup.md b/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-setup.md index f7461fa26..d51a7f07f 100644 --- a/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-setup.md +++ b/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-setup.md @@ -57,7 +57,7 @@ services: ``` 或者，可以将 [.env.example](https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example) 文件复制到一个名为 **.env** 的新文件中。 -根据需要进行修改，并查看 [环境变量](https://palworld-server-docker.loef.dev/zh/getting-started/configuration/server-settings#环境变量) 部分以检查正确的 +根据需要进行修改，并查看 [环境变量](#/zh/入门/配置/服务器设置#环境变量) 部分以检查正确的 值。将 [docker-compose.yml](https://github.com/thijsvanloef/palworld-server-docker/blob/main/docker-compose.yml) 修改为以下内容： ```yml @@ -114,7 +114,7 @@ docker run -d \ ``` 或者，可以将 [.env.example](https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example) 文件复制到一个名为 **.env** 的新文件中。 -根据需要进行修改，并查看 [环境变量]([#/zh/入门/配置/服务器设置#环境变量](https://palworld-server-docker.loef.dev/zh/getting-started/configuration/server-settings#环境变量)) 部分以检查正确的值。 +根据需要进行修改，并查看 [环境变量](#/zh/入门/配置/服务器设置#环境变量) 部分以检查正确的值。 将 docker run 命令修改为以下内容： ```bash