From a3c1dd006919ddb5c7bf4b18518b8ed87ffae59d Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Thu, 25 Jan 2024 21:45:05 -0500 Subject: [PATCH] Added description for server --- Dockerfile | 3 ++- README.md | 1 + docker-compose.yml | 1 + k8s/configmap.yaml | 1 + scripts/start.sh | 4 ++++ 5 files changed, 9 insertions(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 69b72e612..e210f6b6e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -26,7 +26,8 @@ ENV PORT= \ RCON_ENABLED=true \ RCON_PORT=25575 \ QUERY_PORT=27015 \ - TZ=UTC + TZ=UTC \ + SERVER_DESCRIPTION= COPY ./scripts/* /home/steam/server/ RUN chmod +x /home/steam/server/init.sh /home/steam/server/start.sh /home/steam/server/backup.sh diff --git a/README.md b/README.md index 2af76b156..6fc39ffbc 100644 --- a/README.md +++ b/README.md @@ -121,6 +121,7 @@ It is highly recommended you set the following environment values before startin | 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 community server | | "string" | +| SERVER_DESCRIPTION | A description for your server | | "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 | diff --git a/docker-compose.yml b/docker-compose.yml index 21aff674f..fd6c0d1d8 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -20,5 +20,6 @@ services: - COMMUNITY=false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD! # Enable the environment variables below if you have COMMUNITY=true # - SERVER_NAME="World of Pals" + - SERVER_DESCRIPTION="Hello World" volumes: - ./palworld:/palworld/ diff --git a/k8s/configmap.yaml b/k8s/configmap.yaml index 266b3402d..dd34b8cb9 100644 --- a/k8s/configmap.yaml +++ b/k8s/configmap.yaml @@ -14,6 +14,7 @@ data: # Enable the environment variables below if you have COMMUNITY=true # SERVER_PASSWORD: "yourServerPassword" SERVER_NAME: "Server_Name" # Note, it seems spaces are not supported, so use underlines. + SERVER_DESCRIPTION: "" --- apiVersion: v1 kind: ConfigMap diff --git a/scripts/start.sh b/scripts/start.sh index 91590765e..01abae6d5 100644 --- a/scripts/start.sh +++ b/scripts/start.sh @@ -26,6 +26,10 @@ if [ -n "${SERVER_NAME}" ]; then STARTCOMMAND="${STARTCOMMAND} -servername=${SERVER_NAME}" fi +if [ -n "${SERVER_DESCRIPTION}" ]; then + STARTCOMMAND="${STARTCOMMAND} -serverdescription=${SERVER_DESCRIPTION}" +fi + if [ -n "${SERVER_PASSWORD}" ]; then STARTCOMMAND="${STARTCOMMAND} -serverpassword=${SERVER_PASSWORD}" fi