chore: Document the 3.x operator-facing deployment contract#414
Merged
turegjorup merged 3 commits intoMay 28, 2026
Conversation
Add section 2.1 (Rename environment variables) covering the full APP_* -> unprefixed Symfony name rename list (56 variables across framework, JWT, Redis, HTTP client, OIDC, calendar feed, eventdb, admin, client) with task env:migrate referenced as the recommended automated path. Add section 2.2 (Adopt the new operator-facing image-deployment contract) covering the GHCR-published images, the image-bootstrap flow for .env.local, the env_file: compose pattern, and the nginx / PHP-FPM runtime-tuning surfaces (with pointers to the respective Dockerfile ENV blocks). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…r-mono-repo' into feature/5402-upgrade-md-operator-contract # Conflicts: # CHANGELOG.md
Base automatically changed from
feature/update-infrastructure-for-mono-repo
to
release/3.0.0
May 4, 2026 09:43
tuj
changed the title
…-upgrade-md-operator-contract # Conflicts: # CHANGELOG.md
tuj
approved these changes
May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation-only PR. Adds two sections to
UPGRADE.mdcovering the operator-facing changes that come with the 3.x image-based deployment contract.2.1 — Rename environment variables (extended)
The previous list of four renames is replaced with the full set: every
APP_*variable from a 2.x.env.docker.localis renamed to its unprefixed Symfony name, withAPP_ENVandAPP_SECRETas the only exceptions (Symfony-defined, keep their prefix).The list is grouped by area for readability — framework / JWT / Redis / HTTP client / OIDC internal / OIDC external / calendar feed / event DB / admin / client. 56 entries total.
The
os2display-docker-serverrepo providestask env:migrateto perform this rename automatically; the section points at it as the recommended path:task env:migrate task env:diff # review against the canonical example2.2 — Adopt the new operator-facing image-deployment contract
Covers the deployment mechanics independent of the rename:
ghcr.io/os2display/display-api-serviceand…-nginx..env.localfrom the image:docker run --rm <image> cat /var/www/html/.env > .env.local. The image ships an annotated, self-documenting.env(per PR 5402: Document and validate the operator-facing configuration surface #411) that operators use as the starting point..env.localfrom compose viaenv_file:with a yaml example.Out of scope
UPGRADE.md— out of scope for this repo. Section 2.2 references it for full operator migration steps.Test plan
UPGRADE.mdon GitHub and confirm the new sections render cleanly.task env:migrateproduces on a real 2.x.env.docker.local(sanity check by an operator with a 2.x deployment).🤖 Generated with Claude Code