Document interaction of environment variables from docker-compose.yml with .env
Open
Nobody has claimed this yet.
A-newcomer-roadblock
E-easy
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 232
- Avg merge
- 11h 35m
- Merged PRs (30d)
- 60
Description
Currently we have both environment and env_file. Since we have reasonable defaults in .env.sample , there's no need to have the explicit variables and they seem to be overriding the env file:
environment:
CRATESFYI_RUSTWIDE_WORKSPACE: /opt/docsrs/rustwide
CRATESFYI_DATABASE_URL: postgresql://cratesfyi:password@db
S3_ENDPOINT: http://s3:9000
AWS_ACCESS_KEY_ID: cratesfyi
AWS_SECRET_ACCESS_KEY: secret_key
env_file:
- .env
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review docker-compose.yml alongside .env.sample and the .env file, focusing on the interaction between the environment and env_file entries. Document the intended precedence and clarify whether the explicit variables should remain; done means the configuration behavior and expected setup are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker-compose
- Domain
- devops
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100