Description
While setting up a local Chainlink node using the Docker Compose configuration in deployment/docker/, a few critical environment variables are not clearly documented.
New contributors may run into DATABASE_URL and ETH_URL missing errors even after following the provided instructions.
Steps to Reproduce
- Clone the repository and navigate to
deployment/docker/
- Copy
.env.example → .env
- Run
docker-compose up
- Observe missing variable or connection errors in logs
Expected Behavior
The README should:
- Clearly indicate which variables are mandatory
- Provide example values for a local setup (e.g. Ganache/Hardhat)
- Include a minimal working
.env snippet
Actual Behavior
The instructions imply .env.example is self-sufficient, but it isn’t.
Suggested Fix
Add a “Quick Start (Local Development)” section in deployment/docker/README.md showing a verified minimal configuration and linking to official environment variable references.
Environment
- OS: Ubuntu 24.04 / macOS Sonoma
- Docker: 27.x
- Branch:
develop
Description
While setting up a local Chainlink node using the Docker Compose configuration in
deployment/docker/, a few critical environment variables are not clearly documented.New contributors may run into
DATABASE_URLandETH_URLmissing errors even after following the provided instructions.Steps to Reproduce
deployment/docker/.env.example→.envdocker-compose upExpected Behavior
The README should:
.envsnippetActual Behavior
The instructions imply
.env.exampleis self-sufficient, but it isn’t.Suggested Fix
Add a “Quick Start (Local Development)” section in
deployment/docker/README.mdshowing a verified minimal configuration and linking to official environment variable references.Environment
develop