Merge pull request #129 from Plarpoon/develop

removing portainer section, adding FAQ for Portainer
jammsen · Jan 29, 2024 · fa808dc · fa808dc
2 parents 280e9cb + ad60002
commit fa808dc
Showing 1 changed file with 7 additions and 112 deletions.
diff --git a/README.md b/README.md
@@ -26,8 +26,8 @@ ___
     - [Gameserver with RCON-CLI-Tool](#gameserver-with-rcon-cli-tool)
       - [What do the parameters in the entrypoint for RCON mean](#what-do-the-parameters-in-the-entrypoint-for-rcon-mean)
       - [Run RCON commands](#run-rcon-commands)
-    - [Gameserver with Portainer](#gameserver-with-portainer)
   - [FAQ](#faq)
+    - [How can I use the interactive console in Portainer with this image?](#how-can-i-use-the-interactive-console-in-portainer-with-this-image)
     - [How can i look into the config of my Palworld container?](#how-can-i-look-into-the-config-of-my-palworld-container)
     - [Im seeing S\_API errors in my logs when i start the container](#im-seeing-s_api-errors-in-my-logs-when-i-start-the-container)
   - [Planned features in the future](#planned-features-in-the-future)
@@ -280,125 +280,20 @@ Complete Save
 **Important:**
 - All RCON-Commands can be research here: https://tech.palworldgame.com/server-commands
 
-### Gameserver with Portainer
-
-For Portainer it is recommended to use the Stacks feature, which allows you to deploy a stack from a docker-compose.yml file. The following configuration will allow you to use the one-click console access feature.
-
-```yaml
-version: "3.9"
-services:
-  palworld-dedicated-server:
-    #build: .
-    container_name: palworld-dedicated-server
-    image: jammsen/palworld-dedicated-server:latest
-    restart: unless-stopped
-    ports:
-      - target: 8211 # Gamerserver port inside of the container
-        published: 8211 # Gamerserver port on your host
-        protocol: udp
-        mode: host
-      - target: 25575 # RCON port inside of the container
-        published: 25575 # RCON port on your host
-        protocol: tcp
-        mode: host
-    environment:
-      - TZ=Europe/Berlin # Change this for logging and backup, see "Environment-Variables" 
-      - ALWAYS_UPDATE_ON_START=true
-      - MULTITHREAD_ENABLED=true
-      - COMMUNITY_SERVER=true
-      - BACKUP_ENABLED=true
-      - BACKUP_CRON_EXPRESSION=0 * * * *
-      - STEAMCMD_VALIDATE_FILES=true
-      - SERVER_SETTINGS_MODE=auto
-      - NETSERVERMAXTICKRATE=120
-      - DIFFICULTY=None
-      - DAYTIME_SPEEDRATE=1.000000
-      - NIGHTTIME_SPEEDRATE=1.000000
-      - EXP_RATE=1.000000
-      - PAL_CAPTURE_RATE=1.000000
-      - PAL_SPAWN_NUM_RATE=1.000000
-      - PAL_DAMAGE_RATE_ATTACK=1.000000
-      - PAL_DAMAGE_RATE_DEFENSE=1.000000
-      - PLAYER_DAMAGE_RATE_ATTACK=1.000000
-      - PLAYER_DAMAGE_RATE_DEFENSE=1.000000
-      - PLAYER_STOMACH_DECREASE_RATE=1.000000
-      - PLAYER_STAMINA_DECREACE_RATE=1.000000
-      - PLAYER_AUTO_HP_REGENE_RATE=1.000000
-      - PLAYER_AUTO_HP_REGENE_RATE_IN_SLEEP=1.000000
-      - PAL_STOMACH_DECREACE_RATE=1.000000
-      - PAL_STAMINA_DECREACE_RATE=1.000000
-      - PAL_AUTO_HP_REGENE_RATE=1.000000
-      - PAL_AUTO_HP_REGENE_RATE_IN_SLEEP=1.000000
-      - BUILD_OBJECT_DAMAGE_RATE=1.000000
-      - BUILD_OBJECT_DETERIORATION_DAMAGE_RATE=1.000000
-      - COLLECTION_DROP_RATE=1.000000
-      - COLLECTION_OBJECT_HP_RATE=1.000000
-      - COLLECTION_OBJECT_RESPAWN_SPEED_RATE=1.000000
-      - ENEMY_DROP_ITEM_RATE=1.000000
-      - DEATH_PENALTY=All
-      - ENABLE_PLAYER_TO_PLAYER_DAMAGE=false
-      - ENABLE_FRIENDLY_FIRE=false
-      - ENABLE_INVADER_ENEMY=true
-      - ACTIVE_UNKO=false
-      - ENABLE_AIM_ASSIST_PAD=true
-      - ENABLE_AIM_ASSIST_KEYBOARD=false
-      - DROP_ITEM_MAX_NUM=3000
-      - DROP_ITEM_MAX_NUM_UNKO=100
-      - BASE_CAMP_MAX_NUM=128
-      - BASE_CAMP_WORKER_MAXNUM=15
-      - DROP_ITEM_ALIVE_MAX_HOURS=1.000000 
-      - AUTO_RESET_GUILD_NO_ONLINE_PLAYERS=false
-      - AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS=72.000000
-      - GUILD_PLAYER_MAX_NUM=20
-      - PAL_EGG_DEFAULT_HATCHING_TIME=72.000000
-      - WORK_SPEED_RATE=1.000000 
-      - IS_MULTIPLAY=false
-      - IS_PVP=false
-      - CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP=false
-      - ENABLE_NON_LOGIN_PENALTY=true
-      - ENABLE_FAST_TRAVEL=true
-      - IS_START_LOCATION_SELECT_BY_MAP=true
-      - EXIST_PLAYER_AFTER_LOGOUT=false
-      - ENABLE_DEFENSE_OTHER_GUILD_PLAYER=false
-      - COOP_PLAYER_MAX_NUM=4
-      - MAX_PLAYERS=32
-      - SERVER_NAME=jammsen-docker-generated-###RANDOM###
-      - SERVER_DESCRIPTION=Palworld-Dedicated-Server running in Docker by jammsen
-      - ADMIN_PASSWORD=adminPasswordHere
-      - SERVER_PASSWORD=serverPasswordHere
-      - PUBLIC_PORT=8211
-      - PUBLIC_IP=
-      - RCON_ENABLED=true
-      - RCON_PORT=25575
-      - REGION=
-      - USEAUTH=true
-      - BAN_LIST_URL=https://api.palworldgame.com/api/banlist.txt
-    volumes:
-      - /path/to/your/game/directory:/palworld
-
-  rcon:
-    image: outdead/rcon:latest
-    container_name: palworld-rcon
-    restart: unless-stopped
-    entrypoint: ["/rcon", "-a", "RCON_ADDRESS:RCON_PORT", "-p", "RCON_PASSWORD"]
-    tty: true
-    stdin_open: true
-    depends_on:
-      - palworld-dedicated-server
-```
 Questions? See [What do the parameters in the entrypoint for RCON mean](#what-do-the-parameters-in-the-entrypoint-for-rcon-mean)
 
-
-
 ## FAQ
 
-### How can i look into the config of my Palworld container?
+### How can I use the interactive console in Portainer with this image?
+You can run this `docker exec -ti palworld-dedicated-server bash' or you could navigate to the **"Stacks"** tab in Portainer, select your stack, and click on the container name. Then click on the **"Exec console"** button.
+
+### How can I look into the config of my Palworld container?
 You can run this `docker exec -ti palworld-dedicated-server cat /palworld/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini` and it will show you the config inside the container.
 
-### Im seeing S_API errors in my logs when i start the container
+### Im seeing S_API errors in my logs when I start the container
 Errors like `[S_API FAIL] Tried to access Steam interface SteamUser021 before SteamAPI_Init succeeded.` are safe to ignore.
 
-### Im using Apple XYZ/MX, can i run this?
+### Im using Apple XYZ/MX, can I run this?
 You can try to insert in your docker-compose file this parameter `platform: linux/amd64` at the palworld service. This isnt a special fix for Apple silicon, but to run on other than x86 hosts. The support for arm exists only by enforcing x86 emulation, if that isnt to host already. Rosetta is doing the translation/emulation.
 
 ## Planned features in the future