generated from sh-edraft.de/docker-garrysmod
92 lines
2.6 KiB
Markdown
92 lines
2.6 KiB
Markdown
# docker-unturned
|
|
|
|
A Docker image for running an [Unturned](https://unturned.smartlydressedgames.com/) dedicated server, using SteamCMD.
|
|
|
|
The image is automatically built and pushed to:
|
|
|
|
```text
|
|
git.sh-edraft.de/sh-edraft.de/unturned
|
|
```
|
|
|
|
## Table of Contents
|
|
|
|
- [Quick Start](#quick-start)
|
|
- [Server Identity](#server-identity)
|
|
- [Workshop Mods](#workshop-mods)
|
|
- [Persisting Data](#persisting-data)
|
|
- [Environment Variables](#environment-variables)
|
|
|
|
## Quick Start
|
|
|
|
Start a basic PEI server on the default port (`27015`):
|
|
|
|
```bash
|
|
docker run -it \
|
|
-p 27015:27015/tcp \
|
|
-p 27015:27015/udp \
|
|
-p 27016:27016/udp \
|
|
git.sh-edraft.de/sh-edraft.de/unturned
|
|
```
|
|
|
|
## Server Identity
|
|
|
|
Set a server name, instance id, password and owner SteamID64:
|
|
|
|
```bash
|
|
docker run -it \
|
|
-p 27015:27015/tcp \
|
|
-p 27015:27015/udp \
|
|
-p 27016:27016/udp \
|
|
-e "INSTANCEID=MyServer" \
|
|
-e "SERVERNAME=My Server" \
|
|
-e "SERVERPASSWORD=secret" \
|
|
-e "ADMINPASSWORD=adminsecret" \
|
|
-e "OWNER=76561198000000000" \
|
|
git.sh-edraft.de/sh-edraft.de/unturned
|
|
```
|
|
|
|
## Workshop Mods
|
|
|
|
Set a space-separated list of Workshop item/collection IDs to subscribe to on startup:
|
|
|
|
```bash
|
|
docker run -it \
|
|
-p 27015:27015/tcp \
|
|
-p 27015:27015/udp \
|
|
-p 27016:27016/udp \
|
|
-e "WORKSHOP=123456789 987654321" \
|
|
git.sh-edraft.de/sh-edraft.de/unturned
|
|
```
|
|
|
|
## Persisting Data
|
|
|
|
Mount the `Servers` directory to persist save data, configs and workshop mods across container restarts:
|
|
|
|
```bash
|
|
docker run -it \
|
|
-p 27015:27015/tcp \
|
|
-p 27015:27015/udp \
|
|
-p 27016:27016/udp \
|
|
-v ./servers:/home/steam/unturned/Servers \
|
|
git.sh-edraft.de/sh-edraft.de/unturned
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
| Variable | Description | Default |
|
|
| --- | --- | --- |
|
|
| `INSTANCEID` | Server instance id, used as the directory name under `Servers/` | `Server1` |
|
|
| `SERVERNAME` | Name shown in the server browser | `Unturned Server` |
|
|
| `SERVERPASSWORD` | Password required to join the server | _(empty)_ |
|
|
| `ADMINPASSWORD` | Password required for admin access | _(empty)_ |
|
|
| `OWNER` | SteamID64 of the server owner | `0` |
|
|
| `MAP` | Map to load on server start | `PEI` |
|
|
| `MAXPLAYERS` | Maximum number of players | `8` |
|
|
| `PERSPECTIVE` | Allowed perspectives (`Both`, `First`, `Third`) | `Both` |
|
|
| `PVP` | Enable player-vs-player damage | `true` |
|
|
| `PORT` | Game port | `27015` |
|
|
| `VAC` | Enable Valve Anti-Cheat | `true` |
|
|
| `EASYANTICHEAT` | Enable Easy Anti-Cheat | `true` |
|
|
| `WORKSHOP` | Space-separated Workshop item/collection IDs to download | _(empty)_ |
|
|
| `CUSTOMPARAMETERS` | Additional raw command-line parameters appended to the server start command | _(empty)_ |
|