From a3c1dd006919ddb5c7bf4b18518b8ed87ffae59d Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Thu, 25 Jan 2024 21:45:05 -0500 Subject: [PATCH 01/13] 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 69b72e6..e210f6b 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 2af76b1..6fc39ff 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 21aff67..fd6c0d1 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 266b340..dd34b8c 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 9159076..01abae6 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 From b58dee572c23b39d7f5632c4860d48013605ae35 Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Thu, 25 Jan 2024 21:52:22 -0500 Subject: [PATCH 02/13] Added ending pipe --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6fc39ff..752f263 100644 --- a/README.md +++ b/README.md @@ -121,7 +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_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 | From 5d028c8746752381bbe639ccc28060b72b7de328 Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Fri, 26 Jan 2024 08:31:57 -0500 Subject: [PATCH 03/13] Fixed changed from merge --- README.md | 2 +- k8s/configmap.yaml | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 3dd9b7a..2b66ee0 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ It is highly recommended you set the following environment values before startin | 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_NAME | A name 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/k8s/configmap.yaml b/k8s/configmap.yaml index 8b0b6d2..13eb262 100644 --- a/k8s/configmap.yaml +++ b/k8s/configmap.yaml @@ -13,8 +13,6 @@ data: RCON_PORT: "25575" TZ: UTC 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_PASSWORD: "yourServerPassword" SERVER_NAME: "World of Pals" SERVER_DESCRIPTION: "" --- From c04114371c74bcb7d7b37b0d4671fc42457a6b75 Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Fri, 26 Jan 2024 08:33:19 -0500 Subject: [PATCH 04/13] Reverted to old spacing for server name description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2b66ee0..a03ff57 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ It is highly recommended you set the following environment values before startin | 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_NAME | A name 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 | From 08ec26b3f2f1bc05e47588e9615070d093168a75 Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Fri, 26 Jan 2024 08:36:09 -0500 Subject: [PATCH 05/13] Changed spacing to match current version --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a03ff57..8103b01 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ It is highly recommended you set the following environment values before startin | 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_NAME | A name 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 | From 3eef1253579e09175e8304f1d1e3e31250627292 Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Fri, 26 Jan 2024 12:26:11 -0500 Subject: [PATCH 06/13] Updated to array style command --- scripts/start.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/start.sh b/scripts/start.sh index 5cd149e..c9cb3da 100644 --- a/scripts/start.sh +++ b/scripts/start.sh @@ -27,7 +27,7 @@ if [ -n "${SERVER_NAME}" ]; then fi if [ -n "${SERVER_DESCRIPTION}" ]; then - STARTCOMMAND="${STARTCOMMAND} -serverdescription=${SERVER_DESCRIPTION}" + STARTCOMMAND+=("-serverdescription=${SERVER_DESCRIPTION}") fi if [ -n "${SERVER_PASSWORD}" ]; then From 8b34e13e8a4045066cc337374e9f63d9e801de31 Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Thu, 25 Jan 2024 21:45:05 -0500 Subject: [PATCH 07/13] Added description for server --- Dockerfile | 3 ++- README.md | 7 ++++--- docker-compose.yml | 2 ++ k8s/configmap.yaml | 1 + scripts/start.sh | 4 ++++ 5 files changed, 13 insertions(+), 4 deletions(-) diff --git a/Dockerfile b/Dockerfile index e3ac9a5..467d3db 100644 --- a/Dockerfile +++ b/Dockerfile @@ -27,7 +27,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 0ea32b6..41b9d7d 100644 --- a/README.md +++ b/README.md @@ -123,9 +123,10 @@ It is highly recommended you set the following environment values before startin | 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" | +| 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 a3b8e2d..92c1f19 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -18,6 +18,8 @@ services: - TZ=UTC - ADMIN_PASSWORD="adminPasswordHere" - 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="" volumes: - ./palworld:/palworld/ diff --git a/k8s/configmap.yaml b/k8s/configmap.yaml index be8d7aa..13eb262 100644 --- a/k8s/configmap.yaml +++ b/k8s/configmap.yaml @@ -14,6 +14,7 @@ data: TZ: UTC 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_DESCRIPTION: "" --- apiVersion: v1 kind: ConfigMap diff --git a/scripts/start.sh b/scripts/start.sh index 6b096f7..fe21462 100644 --- a/scripts/start.sh +++ b/scripts/start.sh @@ -26,6 +26,10 @@ if [ -n "${SERVER_NAME}" ]; then STARTCOMMAND+=("-servername=${SERVER_NAME}") fi +if [ -n "${SERVER_DESCRIPTION}" ]; then + STARTCOMMAND="${STARTCOMMAND} -serverdescription=${SERVER_DESCRIPTION}" +fi + if [ -n "${SERVER_PASSWORD}" ]; then STARTCOMMAND+=("-serverpassword=${SERVER_PASSWORD}") fi From 013bb36802d02baf35338a3a2d595f6d40bfdeb6 Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Thu, 25 Jan 2024 21:52:22 -0500 Subject: [PATCH 08/13] Added ending pipe --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 41b9d7d..7e52da9 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,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_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 | From b0e2917206bdcaa45e84808944f824f738ac65ae Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Fri, 26 Jan 2024 08:31:57 -0500 Subject: [PATCH 09/13] Fixed changed from merge --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7e52da9..0ffacec 100644 --- a/README.md +++ b/README.md @@ -123,10 +123,9 @@ It is highly recommended you set the following environment values before startin | 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 community server | | "string" | -| SERVER_DESCRIPTION | A description for your server | | "string" | +| 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_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 | From be0bdad55b7fb9b0b55a8ced27ac5b8d9cc5f3fd Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Fri, 26 Jan 2024 08:33:19 -0500 Subject: [PATCH 10/13] Reverted to old spacing for server name description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ffacec..b10740e 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ It is highly recommended you set the following environment values before startin | 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_NAME | A name 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 | From 24ccf396ff22ae021b668e6ef09798070eda9f9a Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Fri, 26 Jan 2024 08:36:09 -0500 Subject: [PATCH 11/13] Changed spacing to match current version --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b10740e..0ea32b6 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ It is highly recommended you set the following environment values before startin | 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_NAME | A name 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 | From e6c11cd3b643906de8163f2b7a05142431bab8db Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Fri, 26 Jan 2024 12:26:11 -0500 Subject: [PATCH 12/13] Updated to array style command --- scripts/start.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/start.sh b/scripts/start.sh index fe21462..4eac8f5 100644 --- a/scripts/start.sh +++ b/scripts/start.sh @@ -27,7 +27,7 @@ if [ -n "${SERVER_NAME}" ]; then fi if [ -n "${SERVER_DESCRIPTION}" ]; then - STARTCOMMAND="${STARTCOMMAND} -serverdescription=${SERVER_DESCRIPTION}" + STARTCOMMAND+=("-serverdescription=${SERVER_DESCRIPTION}") fi if [ -n "${SERVER_PASSWORD}" ]; then From 89eac14ae2d76c3c106a5ac95926aef9f0718534 Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Sat, 27 Jan 2024 04:50:11 -0500 Subject: [PATCH 13/13] Removed added comment --- docker-compose.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/docker-compose.yml b/docker-compose.yml index 92c1f19..592f520 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -18,7 +18,6 @@ services: - TZ=UTC - ADMIN_PASSWORD="adminPasswordHere" - 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="" volumes: