Merge pull request #34 from thijsvanloef/move-port-and-players

make port and players optional

Dockerfile

@@ -7,10 +7,10 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
-ENV PORT=8211 \
+ENV PORT= \
     PUID=1000 \
     PGID=1000 \
-    PLAYERS=16 \
+    PLAYERS= \
     MULTITHREADING=false \
     COMMUNITY=false \
     PUBLIC_IP= \

README.md

@@ -29,25 +29,25 @@ This repository includes an example [docker-compose.yml](example/docker-compose.
 ```yml
 services:
    palworld:
-      image: thijsvanloef/palworld-server-docker
+      image: thijsvanloef/palworld-server-docker:latest
       restart: unless-stopped
       container_name: palworld-server
       ports:
         - 8211:8211/udp
         - 27015:27015/udp
       environment:
-         - PORT=8211
          - PUID=1000
          - PGID=1000
-         - PLAYERS=16
+         - PORT=8211 # Optional but recommended
-         - MULTITHREADING=FALSE
+         - PLAYERS=16 # Optional but recommended
+         - MULTITHREADING=false
          - 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="worldofpals"
          # - SERVER_NAME="World of Pals"
          # - ADMIN_PASSWORD="someAdminPassword"
       volumes:
-         - /path/to/your/palworld/folder:/palworld/
+         - ./palworld:/palworld/
 ```
 
 ### Docker Run
@@ -77,7 +77,6 @@ It is highly recommended you set the following environment values before startin
 
 * PLAYERS
 * PORT
-* MULTITHREADING
 
 | Variable         | Info                                                                                                                                                                                               | Default Values | Allowed Values |
 | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | -------------- |
@@ -94,7 +93,6 @@ It is highly recommended you set the following environment values before startin
 | 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     |
 
-
 *highly recommended to set
 
 ** Make sure you know what you are doing when running this this option enabled

docker-compose.yml

@@ -7,12 +7,11 @@ services:
         - 8211:8211/udp
         - 27015:27015/udp
       environment:
-         - PORT=8211
          - PUID=1000
          - PGID=1000
-         - PLAYERS=16
+         - PORT=8211 # Optional but recommended
+         - PLAYERS=16 # Optional but recommended
          - MULTITHREADING=false
-         - UPDATE_ON_BOOT=true
          - 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="worldofpals"

scripts/start.sh

@@ -1,6 +1,14 @@
 #!/bin/bash
 
-STARTCOMMAND="./PalServer.sh -port=${PORT} -players=${PLAYERS}"
+STARTCOMMAND="./PalServer.sh"
+
+if [ -n "${PORT}" ]; then
+    STARTCOMMAND="${STARTCOMMAND} -port=${PORT}"
+fi
+
+if [ -n "${PLAYERS}" ]; then
+    STARTCOMMAND="${STARTCOMMAND} -players=${PLAYERS}"
+fi
 
 if [ "${COMMUNITY}" = true ]; then
     STARTCOMMAND="${STARTCOMMAND} EpicApp=PalServer"