Multiplayer: Mornedhel Docker server (Proton): Difference between revisions
More actions
Bonsaibauer (talk | contribs) Create English multiplayer setup guide |
Bonsaibauer (talk | contribs) Marked this version for translation |
||
| Line 10: | Line 10: | ||
<translate> | <translate> | ||
<!--T:1--> | |||
This guide covers the Mornedhel Enshrouded Dedicated Server Docker image running with Proton. For the Wine image, see [[Multiplayer: Mornedhel Docker server (Wine)|the Wine guide]]. The image tags and container options are maintained in the [https://github.com/mornedhels/enshrouded-server Mornedhel server repository]. | This guide covers the Mornedhel Enshrouded Dedicated Server Docker image running with Proton. For the Wine image, see [[Multiplayer: Mornedhel Docker server (Wine)|the Wine guide]]. The image tags and container options are maintained in the [https://github.com/mornedhels/enshrouded-server Mornedhel server repository]. | ||
== Back up and inspect the current container == | == Back up and inspect the current container == <!--T:2--> | ||
<!--T:3--> | |||
Stop the server and back up the mounted game files. Find the existing container on the Linux host: | Stop the server and back up the mounted game files. Find the existing container on the Linux host: | ||
<!--T:4--> | |||
<pre> | <pre> | ||
docker ps -a | docker ps -a | ||
</pre> | </pre> | ||
<!--T:5--> | |||
Set <code>NAME</code> to the container name shown in the list. Record its image tag, port mappings, mounts, restart policy, and environment values so you can recreate the same service. The inspection output can contain passwords or other private values. Keep it private and do not post it publicly. | Set <code>NAME</code> to the container name shown in the list. Record its image tag, port mappings, mounts, restart policy, and environment values so you can recreate the same service. The inspection output can contain passwords or other private values. Keep it private and do not post it publicly. | ||
<!--T:6--> | |||
<pre> | <pre> | ||
NAME=YOUR_CONTAINER_NAME | NAME=YOUR_CONTAINER_NAME | ||
| Line 27: | Line 32: | ||
</pre> | </pre> | ||
<!--T:7--> | |||
Find the mount whose destination is <code>/opt/enshrouded</code>. Its <code>Source</code> is the game folder on the Linux host. Confirm the server executable path: | Find the mount whose destination is <code>/opt/enshrouded</code>. Its <code>Source</code> is the game folder on the Linux host. Confirm the server executable path: | ||
<!--T:8--> | |||
<pre> | <pre> | ||
docker exec "$NAME" find /opt/enshrouded -name enshrouded_server.exe -print | docker exec "$NAME" find /opt/enshrouded -name enshrouded_server.exe -print | ||
</pre> | </pre> | ||
== Install the ShroudForge files == | == Install the ShroudForge files == <!--T:9--> | ||
<!--T:10--> | |||
Follow [[Multiplayer: Install server files|the shared server-file setup]]. Copy the complete ShroudForge release and the mod package into the host folder mounted into the server container. Do not copy the files into the container's temporary writable layer. | Follow [[Multiplayer: Install server files|the shared server-file setup]]. Copy the complete ShroudForge release and the mod package into the host folder mounted into the server container. Do not copy the files into the container's temporary writable layer. | ||
== Add the Proton DLL override == | == Add the Proton DLL override == <!--T:11--> | ||
<!--T:12--> | |||
ShroudForge's [https://github.com/bonsaibauer/shroudforge/blob/main/README.md server instructions] require this environment value for the Proton Docker image so Proton loads ShroudForge's native DLLs: | ShroudForge's [https://github.com/bonsaibauer/shroudforge/blob/main/README.md server instructions] require this environment value for the Proton Docker image so Proton loads ShroudForge's native DLLs: | ||
<!--T:13--> | |||
<pre> | <pre> | ||
WINEDLLOVERRIDES=dbghelp=native,builtin;winmm=native,builtin | WINEDLLOVERRIDES=dbghelp=native,builtin;winmm=native,builtin | ||
</pre> | </pre> | ||
<!--T:14--> | |||
The environment of an existing Docker container cannot be changed in place. Recreate it with the same image, ports, mount, restart policy, and every environment value it already uses, plus the override above. | The environment of an existing Docker container cannot be changed in place. Recreate it with the same image, ports, mount, restart policy, and every environment value it already uses, plus the override above. | ||
=== Existing docker run container === | === Existing docker run container === <!--T:15--> | ||
<!--T:16--> | |||
Use the values recorded from <code>docker inspect</code>. Replace the example name, host path, image, ports, and other options with the existing service's values. Keep every existing environment variable. | Use the values recorded from <code>docker inspect</code>. Replace the example name, host path, image, ports, and other options with the existing service's values. Keep every existing environment variable. | ||
<!--T:17--> | |||
<pre> | <pre> | ||
NAME=YOUR_CONTAINER_NAME | NAME=YOUR_CONTAINER_NAME | ||
| Line 63: | Line 76: | ||
</pre> | </pre> | ||
<!--T:18--> | |||
In a port mapping, the value before the colon is the host port and the value after it is the container port. Preserve your existing mapping if it differs. | In a port mapping, the value before the colon is the host port and the value after it is the container port. Preserve your existing mapping if it differs. | ||
=== Docker Compose service === | === Docker Compose service === <!--T:19--> | ||
<!--T:20--> | |||
Add the override to the existing service's <code>environment</code> section. Keep the image, ports, volumes, restart policy, and other environment settings already used by the server. | Add the override to the existing service's <code>environment</code> section. Keep the image, ports, volumes, restart policy, and other environment settings already used by the server. | ||
<!--T:21--> | |||
<pre> | <pre> | ||
services: | services: | ||
| Line 84: | Line 100: | ||
</pre> | </pre> | ||
<!--T:22--> | |||
Recreate the service using its Compose service name: | Recreate the service using its Compose service name: | ||
<!--T:23--> | |||
<pre> | <pre> | ||
docker compose up -d --force-recreate enshrouded | docker compose up -d --force-recreate enshrouded | ||
</pre> | </pre> | ||
== Check the result == | == Check the result == <!--T:24--> | ||
<!--T:25--> | |||
After the server starts, check <code>shroudforge/logs/shroudforge-server.log</code> in the mounted host folder. Confirm that ShroudForge started and that the intended mod loaded. If the log reports a missing DLL or a startup error, stop the container and compare the image, mount, and environment with the settings recorded before the change. | After the server starts, check <code>shroudforge/logs/shroudforge-server.log</code> in the mounted host folder. Confirm that ShroudForge started and that the intended mod loaded. If the log reports a missing DLL or a startup error, stop the container and compare the image, mount, and environment with the settings recorded before the change. | ||
Latest revision as of 11:54, 18 November 2026
This guide covers the Mornedhel Enshrouded Dedicated Server Docker image running with Proton. For the Wine image, see the Wine guide. The image tags and container options are maintained in the Mornedhel server repository.
Back up and inspect the current container
Stop the server and back up the mounted game files. Find the existing container on the Linux host:
docker ps -a
Set NAME to the container name shown in the list. Record its image tag, port mappings, mounts, restart policy, and environment values so you can recreate the same service. The inspection output can contain passwords or other private values. Keep it private and do not post it publicly.
NAME=YOUR_CONTAINER_NAME
docker inspect "$NAME" --format 'Image={{.Config.Image}} Ports={{json .HostConfig.PortBindings}} Mounts={{json .Mounts}} Environment={{json .Config.Env}} Restart={{.HostConfig.RestartPolicy.Name}}'
Find the mount whose destination is /opt/enshrouded. Its Source is the game folder on the Linux host. Confirm the server executable path:
docker exec "$NAME" find /opt/enshrouded -name enshrouded_server.exe -print
Install the ShroudForge files
Follow the shared server-file setup. Copy the complete ShroudForge release and the mod package into the host folder mounted into the server container. Do not copy the files into the container's temporary writable layer.
Add the Proton DLL override
ShroudForge's server instructions require this environment value for the Proton Docker image so Proton loads ShroudForge's native DLLs:
WINEDLLOVERRIDES=dbghelp=native,builtin;winmm=native,builtin
The environment of an existing Docker container cannot be changed in place. Recreate it with the same image, ports, mount, restart policy, and every environment value it already uses, plus the override above.
Existing docker run container
Use the values recorded from docker inspect. Replace the example name, host path, image, ports, and other options with the existing service's values. Keep every existing environment variable.
NAME=YOUR_CONTAINER_NAME docker stop "$NAME" docker rm "$NAME" docker run -d --name "$NAME" --restart unless-stopped \ -p 15637:15637/udp \ -v /YOUR/HOST/GAMEFILES:/opt/enshrouded \ -e 'WINEDLLOVERRIDES=dbghelp=native,builtin;winmm=native,builtin' \ -e 'SERVER_QUERYPORT=15637' \ YOUR_EXISTING_IMAGE
In a port mapping, the value before the colon is the host port and the value after it is the container port. Preserve your existing mapping if it differs.
Docker Compose service
Add the override to the existing service's environment section. Keep the image, ports, volumes, restart policy, and other environment settings already used by the server.
services:
enshrouded:
image: mornedhels/enshrouded-server:stable-proton
container_name: enshrouded
restart: unless-stopped
ports:
- "15637:15637/udp"
volumes:
- /YOUR/HOST/GAMEFILES:/opt/enshrouded
environment:
WINEDLLOVERRIDES: "dbghelp=native,builtin;winmm=native,builtin"
SERVER_QUERYPORT: "15637"
Recreate the service using its Compose service name:
docker compose up -d --force-recreate enshrouded
Check the result
After the server starts, check shroudforge/logs/shroudforge-server.log in the mounted host folder. Confirm that ShroudForge started and that the intended mod loaded. If the log reports a missing DLL or a startup error, stop the container and compare the image, mount, and environment with the settings recorded before the change.