mirror of
https://github.com/Ayymoss/Plutainer
synced 2026-08-24 14:32:06 -04:00
f9a7953652
Some checks failed
Build and Push Docker Image / build (amd64, Dockerfile, false, linux/amd64, ubuntu-latest) (push) Failing after 2s
Build and Push Docker Image / build (arm64, Dockerfile.arm64, true, linux/arm64, ubuntu-24.04-arm) (push) Has been cancelled
Build and Push Docker Image / merge (push) Has been cancelled
* feat: add 7 Days to Die server support
* refactor(scripts): two table-driven families behind one entry script each
Plutainer had five "families" that were really four Call of Duty engines
plus a platform, and a separate entry script per engine. Adding 7 Days to
Die made the mismatch obvious: a SteamCMD game shares nothing with a
Quake-derived one, while a Plutonium T6 and a CoD4x server differ far
less from each other than either does from a Steam install.
There are now two families, and they are platforms:
cod servers Plutainer installs and runs from game files you supply
steam servers SteamCMD installs
Engine (plutonium/iw4x/alterware/cod4x, unity/srcds) drops to a field in
that family's game table, where it belongs. Each family gets one entry
script driven by that table, so the four CoD entry scripts collapse into
games/codentry.sh at 92 lines, and adding a game is a table row rather
than a new script. entrypoint.sh has two branches and gains none per game.
Per-engine behaviour is expressed as hooks resolved most-specific-first:
cod_<hook>_<game> -> cod_<hook>_<base game> -> cod_<hook>_<engine>
so a game inherits its engine and overrides only what genuinely differs.
The same mechanism serves both families, which removed fifteen one-line
pass-through functions on the Steam side.
Hook names are strings, so plutainer_require_hooks verifies the mandatory
ones resolve at startup and prints what it tried. That is not theoretical:
during this refactor a comma-separated suffix list was passed where an
array was wanted, and every server died with no output whatsoever until
plutainer_hook was made to say what it could not find.
The library splits along the same line — core/fs/cod/steam — so a CoD
change never requires reading the Steam helpers. Audited: zero
cross-family calls in either direction. Anything both needed (the symlink
helpers) moved to fs.sh. Renamed from *-config.sh, which was inaccurate
once the files held install logic and launch arguments.
Verified on all ten CoD games (T4/T5/T6 MP+ZM, IW5, IW4x, T7x MP+ZM,
CoD4x): launch commands byte-identical to the originals, correct config
symlinks per engine, health and RCON working.
* feat(protocols): A2S, Source RCON and telnet, split by protocol
pyquake3.py was the only wire protocol Plutainer spoke, which was fine
while every game was Quake-derived. The SteamCMD games are not: 7DTD has
a telnet console and no RCON at all, Source games speak Valve's RCON over
TCP, and none of them answer getstatus.
Protocols now live in scripts/protocols/, split by protocol rather than
by game, because the mapping is many-to-many — Quake3 covers seven CoD
titles, A2S covers four Steam games across three engines, and querying is
a different concern from administering.
healthcheck.sh picks its probe from the family table (STEAM_QUERY) rather
than a hardcoded branch, and keeps the same bar for every game: the server
must name a map it is running. A2S reports one, so "healthy" does not
degrade to "a TCP connect succeeded" for the new family.
rcon-cli keeps its name because that is what people search for, but is now
one small class per protocol behind a dispatch table. It also distinguishes
"this game has no remote console" from "it has one and you have it switched
off", and tells you which setting to change in the second case.
Both try loopback and then the container's own address. Source 1 servers
answer only on the latter: an identical A2S query times out on 127.0.0.1
and replies immediately on the container IP, with the server healthy
throughout. Rather than encode which engines behave which way, try both.
pyquake3.py moves to protocols/quake3.py with its GPL attribution intact.
* fix(logs): let a family opt out of rotation, and skip huge install trees
Rotation is copy-truncate, which is only valid against a writer that
opened its log with O_APPEND — true of every CoD engine, and the reason
the existing implementation is safe. A Unity dedicated server's -logfile
writer keeps its own offset instead, so truncating would leave a sparse
hole and the file's apparent size would snap straight back over the limit,
re-triggering rotation on every poll.
That has not been measured against a running 7DTD, so PLUTAINER_LOG_ROTATE
lets the SteamCMD family turn rotation off. Not rotating is the safe
failure — an unbounded log, which is what the game does unmanaged — rather
than a rotation loop copying gigabytes every two seconds.
PLUTAINER_LOG_PRUNE_DIRS keeps the poller out of a SteamCMD install, which
is tens of thousands of files that would otherwise be walked every two
seconds for one log that does not live there.
* build: add SteamCMD, keep STOPSIGNAL SIGKILL
SteamCMD is fetched but deliberately not bootstrapped at build time.
Running `steamcmd.sh +quit` in the image pulls a few hundred MB of Steam
client into $HOME that every Call of Duty user would then carry forever,
and 340 MB of Xvfb was removed for exactly that reason. It also does not
reliably prevent the first-contact failure it appears to fix, which is
handled with a retry instead.
Placed after everything the CoD families need, so adding or bumping it
never invalidates their layers.
STOPSIGNAL stays SIGKILL. A game with world state to flush cannot be
served by a signal that cannot be trapped, but changing the image default
would alter shutdown for seven servers already running in production to
benefit one new family. Those games ask for SIGTERM per service instead:
stop_signal: SIGTERM
stop_grace_period: 90s
Measured: 7DTD forwards the signal, saves, and exits 0 in 3.5s; the same
image with no stop_signal stops in 254ms as before. The hang case needs no
code — Docker sends SIGKILL itself when the grace period expires.
chmod now covers every *.sh by find rather than a hand-maintained list
that silently rots as scripts move between directories.
* feat(steam): add CS2, L4D2 and Half-Life 2: Deathmatch
Three more games through the SteamCMD family, chosen to stress the table
in different directions rather than to pad the list. Each needed a table
row and, at most, one hook.
HL2:DM is the plain srcds case. L4D2 shares its hooks entirely. CS2 shares
seed, configure, stage and admin with them and overrides only its launch
arguments, because Source 2 has no srcds_run wrapper.
L4D2 needs a two-phase install and it is not optional. Valve restricted
anonymous Linux installation of app 222860: every depot including the
9.5 GB content one is flagged windows, so a plain app_update on Linux
fails with "Invalid platform". This is an open upstream issue
(ValveSoftware/steam-for-linux#11522) that takes LinuxGSM down with it, so
"this used to work" is true and not a local fault. Pulling the content as
Windows and re-running as Linux overlays the native binaries depot on top.
STEAM_INSTALL_PLATFORMS expresses that generically. The result is a genuine
native server — srcds_linux, no Wine, reports "os: Linux Dedicated".
CS2 exposed a real bug in the config handling. link_configs refuses to
replace a real file at the engine path, because for the CoD families that
file is the strongest signal of user intent. Inside a SteamCMD install the
same signal means the opposite: the directory is Steam's, so a real file is
a depot default that the next update restores anyway. CS2 ships a 33-byte
game/csgo/cfg/server.cfg reading "// Defaults in server_default.cfg", so
the fan-out skipped it with a warning and the server ran on stock settings
while app/configs/server.cfg sat there looking correct. Measured before
and after: hostname went from "Counter-Strike 2" to the configured name,
and the name a server browser shows changed with it.
SteamCMD's first contact in a fresh container is also unreliable — it
downloads its own client, re-execs, and an app_update issued before that
settles fails with "Missing configuration". Measured on both 7DTD and
HL2:DM, with the next attempt succeeding, so installs are retried.
Seed configs are hand-written rather than vendored: Valve ships no
server.cfg for any of these. All three ship empty rcon_password and
sv_password, like every other seed here.
* docs: rewrite for two families and eleven games
The docs described five families and a script-per-game layout that no
longer exists, and the 7DTD material from the original PR assumed it was
a one-off rather than the first member of a family.
Reworked around the two-platform model, with per-game specifics where a
reader looks for them: disk footprints (CS2 is 67 GB and will exceed the
health grace period on first start), the GSLT and masterserver-token
equivalence, why clean shutdown is opt-in per service, and what the
depot-config takeover does.
Audited rather than assumed: all fourteen game tags now appear in the
README table, the games reference, the configuration reference and a
working compose example; every environment variable the code reads is in
the reference table; every script is described in CLAUDE.md; no stale
references to the deleted entry scripts remain; all internal doc links
resolve. That audit found two undocumented variables, now added.
* chore: remove the EXAMPLE-docker-compose.yml signpost
The file had already been reduced to a stub pointing at examples/, kept on
the theory that older guides and forum posts link to it. Nothing in the
repo references it any more: every doc that shows a compose file points at
examples/ directly, so the stub was carrying its own rationale and nothing
else.
Also drops the two places that still named it — its .dockerignore entry
(examples/ and *.md already cover everything it excluded) and its
paths-ignore entry in the publish workflow, which was suppressing builds
for a file that no longer exists.
---------
Co-authored-by: Keyboard Sped <93077330+CoreyUK@users.noreply.github.com>
5.8 KiB
5.8 KiB
Configuration
Every setting is an environment variable. Only two are required.
Required
| Variable | Description |
|---|---|
PLUTAINER_GAME |
Which game — t4mp, t4sp, t5mp, t5sp, t6mp, t6zm, iw5mp, iw4x, t7x, cod4x, 7dtd, cs2, l4d2, hl2dm |
PLUTAINER_CONFIG_FILE |
Which config to run, e.g. dedicated_zm.cfg. Must exist in app/configs/ — Plutainer seeds one on first start (names per game). Optional for the SteamCMD games, which default to their own config name |
Plutonium games (t4*, t5*, t6*, iw5mp) also require PLUTO_SERVER_KEY.
Common
| Variable | Description | Default |
|---|---|---|
PLUTAINER_PORT |
Network port | per game |
PLUTAINER_RCON_PASSWORD |
Sets rcon_password in your config at startup. Opt-in — unset leaves your config untouched |
unset |
PLUTAINER_SERVER_NAME |
Name shown in Plutainer's startup logs. On the SteamCMD games it also sets the real server name (7DTD's XML ServerName, Source's hostname); CoD engines still use sv_hostname in their cfg |
per family |
PLUTAINER_MOD |
Mod folder name. On T7x, a Steam Workshop ID instead | unset |
PLUTAINER_MAP_ROTATE |
false drops the automatic +map_rotate (+start_map_rotate on IW5), leaving map choice to your cfg or playlist. N/A on T7x |
true |
PLUTAINER_EXTRA_ARGS |
Extra arguments appended to the launch command | unset |
PLUTAINER_AUTO_UPDATE |
false skips update checks at startup |
true |
PLUTAINER_HEALTHCHECK |
false disables the healthcheck |
true |
PLUTAINER_SKIP_SEED |
true skips seeding default configs |
false |
PLUTAINER_USE_RAW_CONFIGS |
true puts cfg files directly at the engine path instead of app/configs/ — see Volumes & configs |
false |
PLUTAINER_LOG_SYMLINKS |
false disables the app/logs/ symlink watcher |
true |
PLUTAINER_LOG_POLL_INTERVAL |
Seconds between log watcher polls | 2 |
PLUTAINER_LOG_MAX_SIZE |
Rotate a game log once it reaches this size. Accepts 64M, 1G, or plain bytes. 0 disables rotation |
64M |
PLUTAINER_LOG_KEEP |
How many rotated copies to keep. 0 truncates without keeping one |
1 |
PLUTAINER_LOG_ROTATE |
false turns rotation off entirely. The SteamCMD games set this themselves, because copy-truncate is only safe against a writer that opens its log in append mode (why) |
true, false on SteamCMD games |
Don't set
rcon_passwordthroughPLUTAINER_EXTRA_ARGS. Plutainer can't read it back from there, sorcon-cliand IW4MAdmin won't find it. UsePLUTAINER_RCON_PASSWORDor the config file.
Game-specific
These only apply to one engine family.
| Variable | Description | Applies to |
|---|---|---|
PLUTO_SERVER_KEY |
Required. Key from https://platform.plutonium.pw/serverkeys | Plutonium |
PLUTO_MAX_CLIENTS |
Maximum players (other games set this in the cfg) | Plutonium T5 |
IW4X_NET_LOG_IP |
IP:port for remote netlogging (g_log_add) |
IW4x |
PLUTAINER_COD4X_AUTH_TOKEN |
Masterserver token, 32 characters, from http://cod4master.cod4x.ovh. Without one the server runs but is never listed in the server browser | CoD4x |
PLUTAINER_COD4X_AUTHORIZE_MODE |
sv_authorizemode used when no token is set (default -1) |
CoD4x |
PLUTAINER_DEDICATED |
dedicated value: 2 public, 1 LAN (default 2) |
CoD4x |
PLUTAINER_RCON_WHITELIST |
Extra addresses allowed to send RCON, comma separated. See IW4MAdmin | T5, T6 |
PLUTAINER_RCON_WHITELIST_GATEWAY |
false stops auto-whitelisting the Docker gateway (default true) |
T5, T6 |
PLUTAINER_STEAM_BETA |
Steam branch to install instead of the default, e.g. latest_experimental |
SteamCMD games |
PLUTAINER_STEAM_BETA_PASSWORD |
Password for a private Steam branch | SteamCMD games |
PLUTAINER_STEAM_VALIDATE |
true adds validate to the SteamCMD update, re-checking every file. Slow; use after a corrupted install |
SteamCMD games |
PLUTAINER_STEAM_ATTEMPTS |
How many times to retry a failed SteamCMD install. Its first contact in a fresh container is unreliable, so more than one is the norm | SteamCMD games (default 3) |
PLUTAINER_STEAM_APP_ID |
Override the Steam app ID. Escape hatch for testing; the built-in value is normally right | SteamCMD games |
PLUTAINER_MAX_CLIENTS |
Player slots | Source games |
PLUTAINER_START_MAP |
Map to boot into | Source games |
PLUTAINER_CS2_GSLT |
Game Server Login Token, from https://steamcommunity.com/dev/managegameservers. Without it the server runs but never appears in the browser | CS2 |
PLUTAINER_CS2_GAME_ALIAS |
Game mode alias, e.g. competitive, casual, deathmatch (default competitive) |
CS2 |
PLUTAINER_CS2_LAN |
1 restricts the server to LAN (default 0) |
CS2 |
Ports
| Game | Default |
|---|---|
| t4, t5, iw4x, cod4x | 28960 |
| t6 | 4976 |
| iw5 | 27016 |
| t7x | 27017 |
| 7dtd | 26900 |
| cs2 | 27015 |
| l4d2 | 27015 |
| hl2dm | 27015 |
Publish as UDP. IW4x additionally wants TCP published if you host mods, for modlist metadata:
ports:
- "28960:28960/udp"
- "28960:28960/tcp" # IW4x mod hosting only
7DTD uses TCP and UDP on its base port plus the next three UDP ports. With the default:
ports:
- "26900:26900/tcp"
- "26900-26903:26900-26903/udp"
Legacy variables
The PLUTO_* / IW4X_* / ALTER_* names from the v1 image are not accepted and are silently ignored. Three survive because they only ever applied to one family: PLUTO_SERVER_KEY, PLUTO_MAX_CLIENTS, IW4X_NET_LOG_IP.
Upgrading from v1? See MIGRATION.md. Plutainer detects a v1 volume or v1 variables and refuses to start with instructions rather than silently doing the wrong thing.