docs: document HOST_DATA_DIR and add default to env files#1047
Open
mehmetkr-31 wants to merge 1 commit intobase:mainfrom
Open
docs: document HOST_DATA_DIR and add default to env files#1047mehmetkr-31 wants to merge 1 commit intobase:mainfrom
mehmetkr-31 wants to merge 1 commit intobase:mainfrom
Conversation
HOST_DATA_DIR is referenced in docker-compose.yml but is not mentioned in the README and has no default in the bundled .env files. This causes two problems: 1. New operators may not realize they need to set it, leading to chain data being written to an anonymous Docker volume that is hard to locate. 2. If the variable is unset, Docker Compose may mount an empty path. Add HOST_DATA_DIR=./data to both .env.mainnet and .env.sepolia, and add a dedicated step in the Quick Start guide explaining its purpose.
Collaborator
🟡 Heimdall Review Status
|
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
2 participants
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
Documents the
HOST_DATA_DIRenvironment variable and adds a sensible default (./data) to both.env.mainnetand.env.sepolia.Problem
docker-compose.ymlmounts chain data using${HOST_DATA_DIR}:/data, but:HOST_DATA_DIRis never mentioned in the README Quick Start guide..env.mainnetnor.env.sepoliadefines it, so operators who follow the docs may end up with an anonymous Docker volume that is hard to locate or accidentally pruned.Solution
HOST_DATA_DIR=./data(with an explanatory comment) to.env.mainnetand.env.sepolia.HOST_DATA_DIRdoes and why it should be set.Impact
Checklist
./data) is safe and widely used.