From 20a486bac248313675e5bfafe6c246c3bd3293ab Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Sun, 28 Jan 2024 11:19:25 -0500 Subject: [PATCH] Reverted to pure markdown. --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3a5ec95..3bb677c 100644 --- a/README.md +++ b/README.md @@ -120,11 +120,11 @@ It is highly recommended you set the following environment values before startin | 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) | -| PLAYERS1 | Max amount of players that are able to join the server | 16 | 1-32 | -| PORT1 | UDP port that the server will expose | 8211 | 1024-65535 | -| PUID1 | The uid of the user the server should run as | 1000 | !0 | -| PGID1 | The gid of the group the server should run as | 1000 | !0 | -| MULTITHREADING2 | 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 | +| 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 | @@ -132,14 +132,16 @@ It is highly recommended you set the following environment values before startin | 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_BOOT2 | 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_ENABLED3 | 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_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 | -1 highly recommended to set -2 Make sure you know what you are doing when running this option enabled -3 Required for docker stop to save and gracefully close the server +*highly recommended to set + +** Make sure you know what you are doing when running this option enabled + +*** Required for docker stop to save and gracefully close the server > [!IMPORTANT] > Boolean values used in environment variables are case sensitive because they are used in the shell script.