diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 3c96e73..4de9833 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,3 +1,4 @@ # These are supported funding model platforms +github: thijsvanloef ko_fi: thijsvanloef diff --git a/README.md b/README.md index c001920..3cde21b 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ This Docker container has been tested and will work on both Linux (Ubuntu/Debian |----------|---------|------------------------------------------| | CPU | 4 cores | 4+ cores | | RAM | 16GB | Recommend over 32GB for stable operation | -| Storage | 4GB | 10GB | +| Storage | 4GB | 12GB | ## How to use @@ -57,8 +57,7 @@ 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_NAME="World of Pals" volumes: - ./palworld:/palworld/ ``` @@ -84,6 +83,7 @@ docker run -d \ -e ADMIN_PASSWORD="adminPasswordHere" \ -e SERVER_PASSWORD="worldofpals" \ -e COMMUNITY=false \ + -e SERVER_NAME="World of Pals" \ --restart unless-stopped \ thijsvanloef/palworld-server-docker:latest @@ -112,15 +112,15 @@ 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) | -| PLAYERS* | Max amount of players that are able to join the server | 16 | 1-31 | +| 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 | -| SERVER_NAME | A name for your community 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 | @@ -180,6 +180,8 @@ docker exec palworld-server backup This will create a backup at `/palworld/backups/` +The server will run a save before the backup if rcon is enabled. + ## Editing Server Settings When the server starts, a `PalWorldSettings.ini` file will be created in the following location: `/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini` diff --git a/chart/values.yaml b/chart/values.yaml index 5d78652..3c53bf2 100644 --- a/chart/values.yaml +++ b/chart/values.yaml @@ -24,7 +24,7 @@ server: # -- Keeps helm from deleting the PVC. By default, helm does not delete pvcs. preventDelete: false # -- The size of the pvc storage. - size: 10Gi + size: 12Gi # -- The storage class name. storageClassName: "" # -- (dict) Define the parameters for the server image container @@ -133,5 +133,3 @@ server: password: "" # -- (string) If not provided, a random server name will be generated with the "palworld_" prefix. server_name: "" - - diff --git a/docker-compose.yml b/docker-compose.yml index 21aff67..a3b8e2d 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -5,7 +5,7 @@ services: container_name: palworld-server ports: - 8211:8211/udp - - 27015:27015/udp + - 27015:27015/udp # Required if you want your server to show up in the community servers tab environment: - PUID=1000 - PGID=1000 @@ -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_NAME="World of Pals" volumes: - ./palworld:/palworld/ diff --git a/k8s/configmap.yaml b/k8s/configmap.yaml index 266b340..be8d7aa 100644 --- a/k8s/configmap.yaml +++ b/k8s/configmap.yaml @@ -7,13 +7,13 @@ data: PGID: "1000" PORT: "8211" # Optional but recommended PLAYERS: "16" # Optional but recommended + SERVER_PASSWORD: "worldofpals" # Optional but recommended MULTITHREADING: "true" RCON_ENABLED: "true" 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: "Server_Name" # Note, it seems spaces are not supported, so use underlines. + SERVER_NAME: "World of Pals" --- apiVersion: v1 kind: ConfigMap diff --git a/k8s/pvc.yaml b/k8s/pvc.yaml index db0ce45..28e7d75 100644 --- a/k8s/pvc.yaml +++ b/k8s/pvc.yaml @@ -9,4 +9,4 @@ spec: - ReadWriteOnce resources: requests: - storage: 10Gi \ No newline at end of file + storage: 12Gi diff --git a/scripts/backup.sh b/scripts/backup.sh index 9cca792..82e75eb 100644 --- a/scripts/backup.sh +++ b/scripts/backup.sh @@ -1,5 +1,9 @@ #!/bin/bash +if [ "${RCON_ENABLED}" = true ]; then + rcon-cli save +fi + DATE=$(date +"%Y-%m-%d_%H-%M-%S") FILE_PATH="/palworld/backups/palworld-save-${DATE}.tar.gz" cd /palworld/Pal/ || exit