mirror of
https://github.com/Ayymoss/Plutainer
synced 2026-08-24 14:32:06 -04:00
df24be7446
The README had grown to 388 lines of reference material and was reported as too difficult to follow. It is now a 72-line landing page - a working compose block, the game table, and an index - with the detail moved to whichever page owns it: docs/quickstart.md first server, start to finish docs/games.md per game: files, keys, config names, quirks docs/configuration.md environment variable reference docs/volumes-and-configs.md volume layout, config symlinks, logs docs/rcon.md passwords, rcon-cli, who may send RCON docs/iw4madmin.md sidecar setup, parsers, the whitelist trap docs/healthcheck.md what healthy means, restarts, autoheal docs/troubleshooting.md symptom-first FAQ Nothing was dropped; the length came out of duplication. The troubleshooting page is deliberately symptom-first, and every entry is a failure that actually happened - the T5 key that presents as a broken server, the CoD4x RCON password silently refused for being under 8 characters, the IW4MAdmin whitelist. Examples are split by scenario under examples/, replacing the single 228-line file: single-server, per-game (a block for all seven), multi-server, with-iw4madmin, and env.example for secrets. EXAMPLE-docker-compose.yml stays as a signpost because forum posts link to it. The IW4MAdmin example and docs now mount the log FILE rather than the app directory. Pointing IW4MAdmin at Plutainer's logs/ symlink means it silently ingests nothing: it decides whether to read by comparing the file's size, and .NET reports a symlink's size as the length of the link text, so the log never appears to grow. Mounting the file makes Docker resolve the symlink at mount time. Verified across all eleven servers. docs/ and examples/ are excluded from the build context.
29 lines
714 B
Text
29 lines
714 B
Text
# Copy to .env next to your docker-compose.yml. Never commit it.
|
|
#
|
|
# cp examples/env.example .env
|
|
#
|
|
# docker compose reads .env automatically and substitutes ${NAME} in the
|
|
# compose file.
|
|
|
|
# Plutonium server keys — one per server, from
|
|
# https://platform.plutonium.pw/serverkeys
|
|
# Required for t4/t5/t6/iw5. T5 in particular will not load a map without a
|
|
# valid one.
|
|
T4MP_KEY=
|
|
T4ZM_KEY=
|
|
T5MP_KEY=
|
|
T5ZM_KEY=
|
|
T6MP_KEY=
|
|
T6ZM_KEY=
|
|
IW5MP_KEY=
|
|
|
|
# RCON passwords. Optional, but RCON (and IW4MAdmin) stay disabled without
|
|
# them. Use a different one per server.
|
|
T6MP_RCON=
|
|
T6ZM_RCON=
|
|
IW4X_RCON=
|
|
COD4X_RCON=
|
|
|
|
# CoD4x masterserver token — optional. Without it the server runs fine but
|
|
# stays unlisted.
|
|
COD4X_TOKEN=
|