yuzu/palworld-server-docker
1
0
Fork 0
mirror of https://github.com/YuzuZensai/palworld-server-docker.git synced 2026-01-31 04:32:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating readme documentation with latest SERVER_DESCRIPTION environment variable

Browse Source
This commit is contained in:
Luigi Guevara
2024-01-28 00:57:52 +01:00
parent 3802a87bf9
commit 9260eff107
1 changed files with 21 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@@ -64,6 +64,7 @@ services:
- ADMIN_PASSWORD="adminPasswordHere" - ADMIN_PASSWORD="adminPasswordHere"
- COMMUNITY=false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD! - COMMUNITY=false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD!
- SERVER_NAME="World of Pals" - SERVER_NAME="World of Pals"
- SERVER_DESCRIPTION="Awesome World of Pal"
volumes: volumes:
- ./palworld:/palworld/ - ./palworld:/palworld/
``` ```
@@ -90,6 +91,7 @@ docker run -d \
-e SERVER_PASSWORD="worldofpals" \ -e SERVER_PASSWORD="worldofpals" \
-e COMMUNITY=false \ -e COMMUNITY=false \
-e SERVER_NAME="World of Pals" \ -e SERVER_NAME="World of Pals" \
-e SERVER_DESCRIPTION="Awesome World of Pal" \
--restart unless-stopped \ --restart unless-stopped \
thijsvanloef/palworld-server-docker:latest thijsvanloef/palworld-server-docker:latest
@@ -115,24 +117,25 @@ It is highly recommended you set the following environment values before startin
* PUID * PUID
* PGID * PGID
| Variable | Info | Default Values | Allowed Values | | 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) | | 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 | | 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 | | PORT* | UDP port that the server will expose | 8211 | 1024-65535 |
| PUID* | The uid of the user the server should run as | 1000 | !0 | | 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 | | 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 | | 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 | | 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_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 | | 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_NAME | A name for your server | | "string" |
| SERVER_PASSWORD | Secure your community server with a password | | "string" | | SERVER_DESCRIPTION | Your server Description | | "string" |
| ADMIN_PASSWORD | Secure administration access in the server with a password | | "string" | | SERVER_PASSWORD | Secure your community 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 | | ADMIN_PASSWORD | Secure administration access in the server with a password | | "string" |
| RCON_ENABLED*** | Enable RCON for the Palworld server | true | true/false | | 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_PORT | RCON port to connect to | 25575 | 1024-65535 | | RCON_ENABLED*** | Enable RCON for the Palworld server | true | true/false |
| QUERY_PORT | Query port used to communicate with Steam servers | 27015 | 1024-65535 | | RCON_PORT | RCON port to connect to | 25575 | 1024-65535 |
| QUERY_PORT | Query port used to communicate with Steam servers | 27015 | 1024-65535 |
*highly recommended to set *highly recommended to set