Skip to content

docs: explain initial electrs indexing and compaction behavior - #692

Open
milah-247 wants to merge 1 commit into
Blockstream:masterfrom
milah-247:docs/initial-sync-guidance
Open

milah-247 wants to merge 1 commit into
Blockstream:masterfrom
milah-247:docs/initial-sync-guidance

Conversation

@milah-247

@milah-247 milah-247 commented Oct 12, 2026 •

Copy link
Copy Markdown

Related to #600.

This PR updates the README to explain why electrs may appear stuck for several days during its initial Bitcoin mainnet indexing and compaction.

It clarifies that seeing the process in D state, using 0% CPU, and showing no new logs can be normal during this phase. It also adds guidance on storage requirements, enabling more detailed logs to track progress, and increasing Docker's shutdown timeout to prevent the container from stopping too early.

This is a documentation-only change, with no code changes.

Document what to expect during the initial Bitcoin mainnet sync: the
multi-day indexing and compaction phase, electrs sitting in D state with
no new log lines, storage recommendations, how to get progress output
(DEBUG=verbose / ELECTRS_ARGS=-vvvv), and using a longer Docker stop
timeout so the container can shut electrs and bitcoind down cleanly.

Also document the ELECTRS_ARGS passthrough.

Closes Blockstream#600

Co-Authored-By: milah-247 <198606151+milah-247@users.noreply.github.com>
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.

1 participant