docs: enhance Docker configuration documentation and clarify environment variable usage#46
Merged
Conversation
…ent variable usag
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
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
Clarify Docker deployment configuration loading and override behavior.
This update documents that the Docker image runs from
/app, reads/app/config.yamlby default through the compose mount, and usesCONFIG_FILEwhen a custom container-side config path is needed. It also explains the effective priority order, howdocker-compose.full.ymlenvironment variables overrideconfig.yaml, and which settings are static infrastructure config versus runtime business settings managed from the admin console.Change type
Affected areas
Verification
git diff --checkScreenshots, API examples, or logs
Not included; documentation-only change.
Configuration, migration, and compatibility notes
Configuration changes: Documentation now clarifies Docker config loading from
/app/config.yaml, custom path usage throughCONFIG_FILE, and the priority orderenvironment variables > config.yaml > built-in defaults.API changes: None.
Database migrations: None.
Deployment changes: Documentation and compose comments now explain that
docker-compose.full.ymlsetsPOSTGRES_DSN,REDIS_ADDR, andREDIS_PASSWORDinenvironment, which override corresponding values inconfig.yaml.Backward compatibility: No runtime behavior changed.
Documentation
Security and privacy
Checklist
.pycfiles,.envfiles, and local storage data are not committed.