Skip to content

Clarify Compose deployment and safe settings provisioning - #625

Merged
fank merged 2 commits into
masterfrom
codex/improve-compose-and-configuration-docs
Nov 2, 2026
Merged

fank merged 2 commits into
masterfrom
codex/improve-compose-and-configuration-docs

Conversation

@fank

@fank fank commented Nov 2, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Make the published-image root Compose example the documented installation path; distinguish source-build checksums and show pull/recreate upgrades.
  • Document PUID/PGID and rootless ownership, safer RCON exposure, first-start settings and mod-updater credentials.
  • Replace raw envsubst JSON interpolation with an executable jq provisioning example that preserves unset fields and safely encodes supplied strings.
  • Document the reported Podman slirp4netns workaround with upstream limitations.
  • Deprecate scenario2map in the guide, retaining the script and explaining the supported scenario/start/save alternative.

Closes #552.
Closes #541.
Closes #560.
Closes #456.
Closes #352.
Closes #197.
Closes #439.
Closes #378.

Validation

  • Documentation-parsing Python tests were removed following maintainer feedback.
  • docker compose config validated both repository Compose files and the complete README provisioning example.
  • The documented jq command was validated locally with: quotes, backslashes, newlines, Unicode, unset and empty variables, and malformed templates preserving existing settings.
  • Podman networking limitations checked against its official documentation; no claim of reproducing a user-specific NAT setup.

@fank
fank marked this pull request as ready for review November 2, 2026 18:27
@fank
fank merged commit 34c198b into master Nov 2, 2026
4 checks passed
@fank
fank deleted the codex/improve-compose-and-configuration-docs branch November 2, 2026 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant