Skip to content

docs: clarify environment variable and .env configuration strategy#42

Open
Aaravanand00 wants to merge 3 commits intoOSeMOSYS:masterfrom
Aaravanand00:fix/env-config-documentation
Open

docs: clarify environment variable and .env configuration strategy#42
Aaravanand00 wants to merge 3 commits intoOSeMOSYS:masterfrom
Aaravanand00:fix/env-config-documentation

Conversation

@Aaravanand00
Copy link

Fixes #39

Summary

This PR clarifies the configuration strategy for environment variables and .env usage in the MUIO backend.

Changes

  • Enabled python-dotenv loading for local development
  • Updated Config.py to read configuration values from environment variables
  • Added .env.template for developer reference
  • Documented configuration variables and precedence in README

Configuration Precedence

Environment variables are resolved using the following order:

  1. Shell environment variables
  2. .env file (local development)
  3. Built-in defaults in the application

Variables Documented

  • PORT
  • S3_BUCKET
  • S3_KEY
  • S3_SECRET
  • AWS_SYNC
  • HEROKU_DEPLOY

This ensures a clearer configuration strategy for both local development and production deployments.

@Aaravanand00
Copy link
Author

@VedranKapor Would appreciate a quick review whenever you have time. This PR addresses issue #39 and documents the configuration strategy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify environment variable and .env configuration strategy

1 participant