Switch deployment flow from git clone to compose.yaml download#379
Open
ivenos wants to merge 2 commits into
Open
Switch deployment flow from git clone to compose.yaml download#379ivenos wants to merge 2 commits into
ivenos wants to merge 2 commits into
Conversation
Aligns the project with the current Compose Specification, which designates compose.yaml as the canonical filename and treats the docker-compose.yml name as a legacy fallback. The top-level version field is also removed: it is declared informational and obsolete by the Compose Spec, and modern Docker engines emit a warning when it is present. All documentation references are updated accordingly. Functional behavior is unchanged — docker compose discovers either filename, so existing deployments are not affected by the rename. Reference: https://docs.docker.com/compose/intro/compose-application-model/
The Open Archiver image is self-contained: backend, frontend, types, migrations, and the entrypoint are all baked in at build time. Nothing from the source tree is read at runtime, so cloning the repository just to start the application is unnecessary. This change updates the README and the installation/upgrade guides to download compose.yaml and .env.example directly. The update flow drops the git pull step accordingly; re-downloading compose.yaml is only needed when a release explicitly changes it.
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
1 participant
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.
Depends on #378 (which renames
docker-compose.ymltocompose.yaml). The diff below assumes that rename has landed.The Open Archiver image is self-contained: backend, frontend, types, migrations, and the entrypoint are all baked in at build time. Nothing from the source tree is read at runtime, so cloning the repository just to start the application is unnecessary.
Changes
compose.yamland.env.exampledirectly, instead of cloning the repo.git pullstep.docker compose pull+docker compose up -dis enough; re-downloadingcompose.yamlis only needed when a release explicitly changes it..env.example.docker(file does not exist in the repo).Impact on existing users
None. Existing clones keep working with the unchanged
docker composecommands. The new flow is only what new users see in the docs.