diff --git a/README.md b/README.md index 37b99cd4e..8cef6ee13 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,10 @@ Massive shoutout to the following sponsors! ShoeBoom  doomhound188  AshishT112203  pabumake  stoprx  KiKoS0  inspired-by-nudes  USA-RedDragon  PulsarFTW  

+## Official Documentation + +[![Documentation](https://github.com/thijsvanloef/palworld-server-docker/assets/58031337/b92d76d1-5efb-438d-9ffd-5385544a831b)](https://palworld-server-docker.loef.dev/) + ## Server Requirements | Resource | Minimum | Recommended | diff --git a/docs/kr/README.md b/docs/kr/README.md index 93a9ec01a..6c7946a25 100644 --- a/docs/kr/README.md +++ b/docs/kr/README.md @@ -34,6 +34,10 @@ ShoeBoom  doomhound188  AshishT112203  pabumake  

+## Official Documentation + +[![Documentation](https://github.com/thijsvanloef/palworld-server-docker/assets/58031337/b92d76d1-5efb-438d-9ffd-5385544a831b)](https://palworld-server-docker.loef.dev/ko/) + ## 서버 요구 사양 | 리소스 | 최소 | 추천 | diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 4467909ad..d46299e71 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -40,6 +40,10 @@ ShoeBoom  doomhound188  AshishT112203  pabumake  

+## Official Documentation + +[![Documentation](https://github.com/thijsvanloef/palworld-server-docker/assets/58031337/b92d76d1-5efb-438d-9ffd-5385544a831b)](https://palworld-server-docker.loef.dev/zh/) + ## 服务器配置需求 | 资源 | 最小 | 推荐 | diff --git a/docusaurus/docs/getting-started/configuration/game-settings.md b/docusaurus/docs/getting-started/configuration/game-settings.md index 82411de3e..2af0efa2c 100644 --- a/docusaurus/docs/getting-started/configuration/game-settings.md +++ b/docusaurus/docs/getting-started/configuration/game-settings.md @@ -4,6 +4,8 @@ sidebar_position: 2 # Game Settings +Changing Game Settings with Environment variables. + ## With Environment Variables :::warning diff --git a/docusaurus/docs/getting-started/configuration/server-settings.md b/docusaurus/docs/getting-started/configuration/server-settings.md index ef469e04e..fecd11dfc 100644 --- a/docusaurus/docs/getting-started/configuration/server-settings.md +++ b/docusaurus/docs/getting-started/configuration/server-settings.md @@ -4,7 +4,7 @@ sidebar_position: 1 # Server Settings -This part will explain how to configure the server. +Changing Server Settings using environment variables. ## Environment variables diff --git a/docusaurus/docs/getting-started/quick-setup.md b/docusaurus/docs/getting-started/quick-setup.md index d4219dcbc..0528cf2d9 100644 --- a/docusaurus/docs/getting-started/quick-setup.md +++ b/docusaurus/docs/getting-started/quick-setup.md @@ -13,6 +13,11 @@ At the moment, Xbox Gamepass/Xbox Console players will not be able to join a ded They will need to join players using the invite code and are limited to sessions of 4 players max. ::: +## Prerequisites + +* Virtualization enabled in the BIOS/UEFI +* Must have [Docker](https://docs.docker.com/engine/install/) installed + ## Server Requirements | Resource | Minimum | Recommended | @@ -55,9 +60,12 @@ services: - ./palworld:/palworld/ ``` -As an alternative, you can copy the [.env.example](https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example) file to a new file called **.env** file. -Modify it to your needs, check out the [environment variables](https://palworld-server-docker.loef.dev/getting-started/configuration/server-settings#environment-variables) section to check the correct -values. Modify your [docker-compose.yml](https://github.com/thijsvanloef/palworld-server-docker/blob/main/docker-compose.yml) to this: +As an alternative, you can copy the [.env.example](https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example) file to a new file called **.env** file. + +Modify it to your needs, check out the [environment variables](https://palworld-server-docker.loef.dev/getting-started/configuration/server-settings#environment-variables) section to check the correct +values. + +Modify your [docker-compose.yml](https://github.com/thijsvanloef/palworld-server-docker/blob/main/docker-compose.yml) to this: ```yml services: @@ -75,7 +83,18 @@ services: - ./palworld:/palworld/ ``` -### Docker Run +### Starting the server + +Use `docker compose up -d` in the same folder as the `docker-compose.yml` to start the server in the background + +### Stopping the server + +Use `docker compose stop` in the same folder as the `docker-compose.yml` to stop the server + +Use `docker compose down --rmi all` in the same folder as the `docker-compose.yml` +to stop and remove the server and remove the docker image from your computer + +## Docker Run ```bash docker run -d \ @@ -101,9 +120,12 @@ docker run -d \ thijsvanloef/palworld-server-docker:latest # Use the latest-arm64 tag for arm64 hosts ``` -As an alternative, you can copy the [.env.example](https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example) file to a new file called **.env** file. +As an alternative, you can copy the [.env.example](https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example) file to a new file called **.env** file. + Modify it to your needs, check out the [environment variables](https://palworld-server-docker.loef.dev/getting-started/configuration/server-settings#environment-variables) section to check the -correct values. Change your docker run command to this: +correct values. + +Change your docker run command to this: ```bash docker run -d \ @@ -116,13 +138,3 @@ docker run -d \ --stop-timeout 30 \ thijsvanloef/palworld-server-docker:latest # Use the latest-arm64 tag for arm64 hosts ``` - -## Starting the server - -Use `docker compose up -d` to start the server in the background - -## Stopping the server - -Use `docker compose stop` to stop the server - -Use `docker compose down --rmi all` to stop and remove the server and remove the docker image from your computer diff --git a/docusaurus/docs/guides/automatic-reboots.md b/docusaurus/docs/guides/automatic-reboots.md index dea79de0d..6ab44a4b9 100644 --- a/docusaurus/docs/guides/automatic-reboots.md +++ b/docusaurus/docs/guides/automatic-reboots.md @@ -6,7 +6,9 @@ sidebar_position: 4 ## Configuring Automatic Reboots with Cron -To be able to use automatic reboots with this server `RCON_ENABLED` enabled. +To be able to use automatic reboots with this Server the following environment variables **have** to be set to `true`: + +* `RCON_ENABLED` :::warning @@ -17,9 +19,12 @@ The example docker run command and docker compose file in [the Quicksetup](https already use the needed policy ::: -Set `AUTO_REBOOT_ENABLED` to `true` or `false` to enable or disable automatic reboots (Default is disabled) - -`AUTO_REBOOT_CRON_EXPRESSION` is a cron expression, in a Cron-Expression you define an interval for when to run jobs. +| Variable | Info | Default Values | Allowed Values | +|------------------------------------|------------------------------------------------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------| +| AUTO_REBOOT_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-reboots-with-cron) | +| 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 | :::tip This image uses Supercronic for crons diff --git a/docusaurus/docs/guides/automatic-updates.md b/docusaurus/docs/guides/automatic-updates.md index c4ce2e48d..f85aee382 100644 --- a/docusaurus/docs/guides/automatic-updates.md +++ b/docusaurus/docs/guides/automatic-updates.md @@ -19,10 +19,11 @@ The example docker run command and docker compose file in [the Quicksetup](https already use the needed policy ::: -Set `AUTO_UPDATE_ENABLED` enable or disable automatic updates (Default is disabled) - -`AUTO_UPDATE_CRON_EXPRESSION` is a cron expression, in a Cron-Expression you define an interval for when to run jobs. - +| Variable | Info | Default Values | Allowed Values | +|-----------------------------|----------------------------------------------------------------------------------------------------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| AUTO_UPDATE_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 \* \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](https://palworld-server-docker.loef.dev/guides/backup/automated-backup) | +| 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 | !0 | :::tip This image uses Supercronic for crons see [supercronic](https://github.com/aptible/supercronic#crontab-format) diff --git a/docusaurus/docs/known-issues/known-issues.md b/docusaurus/docs/known-issues/known-issues.md index 36c7213db..deacf113b 100644 --- a/docusaurus/docs/known-issues/known-issues.md +++ b/docusaurus/docs/known-issues/known-issues.md @@ -4,6 +4,8 @@ sidebar_position: 5 # Known Issues +Known issues of using this Docker image. + ## Broadcast command can only send 1 word When using Broadcast among RCON's functions, only one word is transmitted.