Refactor docker compose, .env file doc #80
Merged
Conversation
This file contains 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
Pascal-Delange
force-pushed
the
pascal/improve-deployment-doc
branch
2 times, most recently
from
c2e9e4e to
61a80f1
Compare
Pascal-Delange
changed the title
Pascal-Delange
force-pushed
the
pascal/improve-deployment-doc
branch
from
61a80f1 to
ffc23a3
Compare
Pascal-Delange
commented
Mar 3, 2025
apognu
approved these changes
Mar 3, 2025
ChibiBlasphem
approved these changes
Mar 4, 2025
carere
approved these changes
Mar 4, 2025
Pascal-Delange
force-pushed
the
pascal/improve-deployment-doc
branch
from
b9e35e5 to
1d77ddc
Compare
technical deployment documentation
reshuffle files improvement of doc files continued continued more info on migrations last fixes rename files update .env example remove comment on postgres 15 depreciation for now
Pascal-Delange
force-pushed
the
pascal/improve-deployment-doc
branch
from
1d77ddc to
0aadf1d
Compare
|
@checkmarble/devs FYI I put the version bump for the release inside this PR |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Prerequisites
Related PRs renaming/modifying env vars: checkmarble/marble-frontend#721, checkmarble/marble-backend#877
I made some changes to variable naming & expected format so that the backend and frontend use the same conventions, and variables have the name that matches their expected format.
Link
View the doc on the branch: https://github.com/checkmarble/marble/blob/pascal/improve-deployment-doc/installation/README.md
Content
I tried to make it as complete as possible, while minimizing the duplication of source of truth (which was not always easy).
I reached the point where I need to let it rest a bit and perhaps get a fresh look on it.
All the detailed explanation on configuring the environment variables on frontend & backend are in .env.example + docker-compose.yaml (single source of truth).
A really simplified setup for local testing is in docker-compose-dev.yaml + env.dev.example.
The more high level explanations on dependencies, quick start, how to configure, target architecture, version support policy & migrations is in the installation folder, with README.md as the entry point that links to some more detailed files.