Skip to content

docs: document HOST_IP and HOST_DATA_DIR in env files#1060

Open
Kewe63 wants to merge 1 commit into
base:mainfrom
Kewe63:docs/host-data-dir-env-files-upstream
Open

docs: document HOST_IP and HOST_DATA_DIR in env files#1060
Kewe63 wants to merge 1 commit into
base:mainfrom
Kewe63:docs/host-data-dir-env-files-upstream

Conversation

@Kewe63
Copy link
Copy Markdown

@Kewe63 Kewe63 commented May 11, 2026

Summary

Adds documentation for networking and storage settings in environment files and fixes a HOST_IP clobbering bug in Geth.

Problem

  • Advanced settings like HOST_IP and HOST_DATA_DIR were undocumented, leading to confusion for operators behind NAT.
  • The Geth entrypoint was hardcoding HOST_IP="", which overrode any value set in environment files.
  • The relationship between docker-compose.yml and the network-specific .env files (like .env.mainnet) was not clear regarding interpolation.

Solution

  • Added documented examples to the root .env and network-specific .env files.
  • Fixed the Geth entrypoint to use HOST_IP="${HOST_IP:-}" to preserve environment overrides.
  • Added clarifying notes about where HOST_DATA_DIR must be set to take effect in docker-compose.

Verification

  • Verified that Geth now correctly picks up HOST_IP from the environment.
  • Read through the updated documentation for clarity.

Impact

Improves operator experience and discoverability of advanced configuration options.

@cb-heimdall
Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 1
Sum 2

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.

2 participants