Skip to content

docs: migrate v3.3 documentation from gitbook_docs_v3.3 to release/3.3#20263

Merged
bloxster merged 22 commits into
release/3.3from
gitbook_docs_v3.3
Apr 7, 2026
Merged

docs: migrate v3.3 documentation from gitbook_docs_v3.3 to release/3.3#20263
bloxster merged 22 commits into
release/3.3from
gitbook_docs_v3.3

Conversation

@bloxster

@bloxster bloxster commented Apr 1, 2026

Copy link
Copy Markdown
Collaborator

Summary

Migrates all documentation changes accumulated on gitbook_docs_v3.3 to the official release/3.3 branch, per the new convention that docs live on the release branch.

Commits included:

  • docs: March 2026 w13 — v3.3.10 update (#Options block, Lighthouse link)
  • docs: add Sync Times, Datadir Structure, Dev Chain pages
  • docs: document --rpc.blockrange.limit flag
  • docs(gitbook-help): fill gaps from README FAQ and community Q&A
  • docs(gitbook-help): fix stale known-issues entries
  • docs: Step 3 coverage audit fixes — v3.3.10 code↔docs gaps
  • docs: add overlay, parity, graphql namespace pages
  • docs: fix creating-a-dashboard page accuracy
  • docs: March 2026 w14 — v3.3.10 update

🤖 Generated with Claude Code

Andy (NanoClaw) and others added 10 commits March 27, 2026 15:18
- #Options section updated to verbatim erigon --help output from v3.3.10
  (includes new --rpc.blockrange.limit flag)
- Fixed broken Lighthouse link: mainnet-validator.html → validator_management.html

Co-Authored-By: Andy NanoClaw <noreply@nanoclaw.bot>
- hardware-requirements.md: add Sync Times section with table
  (Ethereum/Gnosis × Archive/Full/Minimal; Polygon noted as 3.1 only)
- new page: fundamentals/datadir-structure.md — directory layout with
  explanation of each folder + History on cheap disk symlink strategy
- new page: fundamentals/dev-chain.md — quick start, key flags, and
  link to full DEV_CHAIN.md tutorial
- SUMMARY.md: insert Datadir Structure after Optimizing Storage;
  insert Dev Chain at end of FUNDAMENTALS

Co-Authored-By: Andy NanoClaw <noreply@nanoclaw.bot>
- FAQs: add items 21 (pruned history / no earlier blocks) and 22 (RPi / ARM)
- Best practices: add Public RPC hardening row to Security table;
  add new section 6 "Advanced Performance Tricks" with shell commands
  for sync.loop.block.limit, vmtouch, SNAPSHOT_MADV_RND, db.pagesize
- Common errors: add items 8 (Docker UID/GID 1000 permission denied)
  and 9 (libsilkworm_capi.so missing shared library)
- Troubleshooting: add "Collecting Diagnostics" section (SIGUSR1 + pprof)
  and Hetzner firewall note for P2P ports
- Known issues: add db.pagesize section explaining the flag is set-once
  with link to integration README

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Drop deprecated DOCKER_BUILDKIT=1 and COMPOSE_DOCKER_CLI_BUILD=1 env
  vars from the docker-compose BuildKit workaround (BuildKit is default
  in Docker Engine 23.0+ and Compose V2)
- Label vmmap as macOS-only; add Linux equivalents (pmap -x PID and
  /proc/<PID>/smaps)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
DOCS→CODE (stale/wrong):
- security.md: remove --txpool.nolocals (flag does not exist in Erigon)
- default-ports.md: remove --diagnostics.endpoint.port 6062 (flag not in binary)

Port fixes (default-ports.md):
- 30304: correct label from eth/67 to eth/69
- 8545: remove WebSocket from row; add separate 8546 row for WebSocket

Inaccuracies:
- logs.md: fix --verbosity default from 2 to 3/info
- configuring-erigon.md: --prune.include-commitment-history is the primary
  flag name; the experimental.* variants are aliases

CODE→DOCS gaps — new flag documentation:
- security.md: add --ws.origins CORS note, --ipcdisable/ipcpath
- logs.md: add --vmodule per-module verbosity flag
- caplin.md: add Beacon API configuration section (addr, cors, timeouts, groups)
- dev-chain.md: add --miner.etherbase, --miner.gaslimit, --miner.extradata
- layer-2-networks.md: add --polygon.wit-protocol note
- configuring-erigon.md: Network (+5 flags), RPC (+14 flags), DB (+etl.bufferSize),
  Sync (+fcu.timeout/prune/snap/experimental), GPO (+maxprice), Logging (+vmodule),
  new Silkworm section (10 flags), new Miscellaneous section

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- overlay.md: full page written from source — two methods
  (overlay_getLogs with state override, overlay_callConstructor),
  archive node requirement, timeout flags, curl examples
- parity.md: minimal stub — only parity_listStorageKeys implemented,
  link to OpenEthereum archived spec, full parameter table
- graphql.md: minimal stub — --graphql flag, /graphql and /graphql/ui
  endpoints, link to Geth docs (EIP-1767 reference)
- interacting-with-erigon/README.md: add all three to namespace index
- SUMMARY.md: add all three pages

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add --metrics.port flag (default 6060); remove vague "default port varies"
- Fix erigon.json panel sections: replace fictional Storage/Network/State
  sections with actual Blockchain, Block consume delay, RPC, Private api
- Add warning that erigon_internals.json is Erigon's internal Grafana Cloud
  dashboard (requires pre-release Grafana, not for end users)
- Add missing ERIGON_GRAFANA_DASHBOARD env var to config table
- Strip all broken LaTeX $$ $\text{...}$ $$ formatting throughout
- Fix readme.md -> Readme.md casing; fix dashboards path reference

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Fix broken link: execution-apis/api-documentation/ → execution-apis/ (404) in interacting-with-erigon/README.md and two .gitbook includes
- Fix broken internal link to non-existent help-center/common-errors-and-solutions.md in configuring-erigon.md
- Update stale erigon.gitbook.io URLs to docs.erigon.tech (supported-networks, jwt)
- Fix URL typo in how-to-run-a-polygon-node.md (technologyspecifies → technology)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@yperbasis yperbasis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issues

  1. Metrics port is 6061, not 6060 (bug)

creating-a-dashboard.md says:
▎ Verify Prometheus can reach your Erigon metrics endpoint (default port: 6060).

The actual default is 6061 (diagnostics/metrics/config.go:16, node/debug/flags.go:76). Port 6060 is pprof. The PR's own --help dump in configuring-erigon.md correctly shows (default: 6061) — so the same PR
contradicts itself.

  1. db.pagesize default is 16KB, not 4KB (bug)

known-issues.md says:
▎ The default page size is 4kb.

The actual default is 16KB (node/ethconfig/config.go:121: DefaultChainDBPageSize = 16 * datasize.KB). Again the PR's own --help dump shows (default: "16KB").

  1. --beacon.api.ide.timeout description (minor)

The caplin.md table describes this as "Idle connection timeout" but the --help text says "write time out" (likely a copy-paste from --beacon.api.write.timeout in the Erigon source). The docs interpretation
"idle" is probably what the flag actually does given its name, but worth confirming with the Caplin team.


Nits / Observations

  • The --metrics.port flag in configuring-erigon.md is documented under the correct default via the --help dump, so the conflict is only in the dashboard page's prose.
  • The existing known-issues.md reference to ERIGON_SNAPSHOT_MADV_RND predates this PR, so that's not a new regression — but if this PR is touching the file anyway, it's a good opportunity to fix it.
  • The configuring-erigon.md changes are a bulk paste of erigon --help output at the bottom. This is fine as a reference, but the --help flag description for db.pagesize says "Default: equal to OperationSystem's
    pageSize" which is inaccurate (the Go default is hardcoded to 16KB). That's a source-code issue, not a docs issue.
  • Sync times table says "Nov 2024" for disk usage figures — might want to note the Erigon version these were measured on since this targets v3.3.

Verdict

Good docs improvement overall. The three factual bugs above should be fixed before merging — they'd send users to the wrong port and wrong page size default.

bloxster added 2 commits April 2, 2026 13:58
The erigon-lib/ directory was restructured to db/ and the referenced
README.md no longer exists. Remove the dead link.
Mention default pprof address and flags to override it, per review
feedback from yperbasis on PR #20267.

@yperbasis yperbasis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorrect default values (verify against source):

  • configuring-erigon.md documents --fcu.background.prune with default false, but the --help output in the same file shows default true. The human-readable docs section should match.
  • caplin.md says --beacon.api.ide.timeout — this appears to be a typo in the source flag name (ide vs idle). The --help output also says ide, so this is a pre-existing upstream issue, but worth noting in the
    docs that it means "idle".

Minor issues:

  • configuring-erigon.md line for --discovery.v5 says "Equivalent to --v5disc" — the --help output shows three aliases (--discovery.v5, --discv5, --v5disc). Mentioning all three or just noting "has aliases"
    would be more complete.

  • default-ports.md removes the --diagnostics.endpoint.port section entirely. The --help output in v3.3.10 still shows --diagnostics.disabled and --diagnostics.endpoint.addr/port flags — was this removal
    intentional? The flags may have been removed from the new --help output actually (they're absent from the new block). If so, fine.

  • Edit: I re-checked — the flags --diagnostics.disabled, --diagnostics.endpoint.addr, --diagnostics.endpoint.port, and --diagnostics.speedtest are indeed gone from the v3.3.10 --help output. The removal from
    default-ports.md is correct.

  • known-issues.md has a dead link reference removed (erigon-lib README) — good catch in the fixup commit.

  • The sync times table in hardware-requirements.md has no footnote about which hardware produced those numbers. Adding even a one-liner ("Measured on AMD Ryzen 9 / 64 GB / Gen4 NVMe" or similar) would prevent
    user confusion when their times differ significantly.

Observations (not blocking)

  • The --help block replacement is the largest single chunk (~500 lines removed, ~500 added). The new output was clearly captured from a v3.3.10 build, which is the right approach. The diff is noisy but correct
    — it's just reformatted with wider alignment.
  • New pages (overlay, parity, graphql, datadir-structure, dev-chain) are well-structured with flag tables, curl examples, and appropriate hints/warnings. The overlay page correctly notes the archive node
    requirement and the Otterscan dependency for callConstructor.
  • The Silkworm section is a good addition — the libsilkworm_capi.so warning box ties in well with the new common-error #9.

Verdict

This is a solid, well-organized documentation update. The one concrete issue worth fixing before merge is the --fcu.background.prune default mismatch (docs section says false, --help says true). Everything else
is clean.

@bloxster bloxster requested a review from yperbasis April 2, 2026 15:19
bloxster added 4 commits April 2, 2026 18:24
Port 6060 is --pprof.port; --metrics.port default is 6061
(diagnostics/metrics/config.go:16)
DefaultChainDBPageSize = 16 * datasize.KB
(node/ethconfig/config.go:121); the --help output also shows '16KB'
FcuBackgroundPrune defaults to true (node/ethconfig/config.go:121).
--discovery.v5 has aliases --discv5 and --v5disc per --help output.
Users need to know what hardware/version produced these numbers to
interpret their own results correctly.
@bloxster bloxster enabled auto-merge (squash) April 3, 2026 09:45
bloxster added 3 commits April 3, 2026 11:58
…tes)

Bring v3.3 branch in line with the full Help Center content
merged via PR #20267.
…updates)

Bring v3.3 branch in line with the full Help Center content
merged via PR #20267.
Bring v3.3 branch in line with the full Help Center content
merged via PR #20267.
AskAlexSharov pushed a commit that referenced this pull request Apr 3, 2026
## Summary

Ports the full Help Center content to `release/3.4`, mirroring what was
merged to `main` via PR #20267.

Changes per file:

- **best-practices.md**: added "Harden Public RPC Endpoints" row +
Section 6 (Advanced Performance Tricks with vmtouch,
ERIGON_SNAPSHOT_MADV_RND, db.pagesize)
- **common-errors-and-solutions.md**: added errors #8 (Docker UID/GID
mismatch) and #9 (libsilkworm_capi.so missing)
- **frequently-asked-questions-faqs.md**: added FAQ #21 (historical
block queries / pruning) and #22 (ARM/RPi feasibility)
- **known-issues.md**: improved vmmap/pmap section (macOS vs Linux),
removed DOCKER_BUILDKIT env vars, added `--db.pagesize` section (default
16KB)
- **troubleshooting.md**: added Diagnostics section (SIGUSR1 goroutine
dump, pprof CPU/heap capture) and Hetzner firewall note

All content is identical to `main` post-#20267, with yperbasis review
fixes already applied (broken erigon-lib link removed, pprof addr/port
flags documented).

## Test plan

- [ ] Verify all 5 files render correctly in GitBook preview
- [ ] No broken internal links
- [ ] Content consistent with release/3.3 (PR #20263) and main

🤖 Generated with [Claude Code](https://claude.com/claude-code)
sudeepdino008 pushed a commit that referenced this pull request Apr 3, 2026
## Summary

Ports the full Help Center content to `release/3.4`, mirroring what was
merged to `main` via PR #20267.

Changes per file:

- **best-practices.md**: added "Harden Public RPC Endpoints" row +
Section 6 (Advanced Performance Tricks with vmtouch,
ERIGON_SNAPSHOT_MADV_RND, db.pagesize)
- **common-errors-and-solutions.md**: added errors #8 (Docker UID/GID
mismatch) and #9 (libsilkworm_capi.so missing)
- **frequently-asked-questions-faqs.md**: added FAQ #21 (historical
block queries / pruning) and #22 (ARM/RPi feasibility)
- **known-issues.md**: improved vmmap/pmap section (macOS vs Linux),
removed DOCKER_BUILDKIT env vars, added `--db.pagesize` section (default
16KB)
- **troubleshooting.md**: added Diagnostics section (SIGUSR1 goroutine
dump, pprof CPU/heap capture) and Hetzner firewall note

All content is identical to `main` post-#20267, with yperbasis review
fixes already applied (broken erigon-lib link removed, pprof addr/port
flags documented).

## Test plan

- [ ] Verify all 5 files render correctly in GitBook preview
- [ ] No broken internal links
- [ ] Content consistent with release/3.3 (PR #20263) and main

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@AskAlexSharov AskAlexSharov requested a review from Copilot April 6, 2026 01:33

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Migrates the accumulated v3.3 GitBook documentation updates onto the release/3.3 branch, aligning with the convention that release docs live on the release branch.

Changes:

  • Adds several new documentation pages (e.g., datadir structure, dev chain, additional RPC namespaces).
  • Updates existing ops/docs guidance (ports, logging, security, Caplin/Beacon API, troubleshooting/known issues).
  • Refreshes links and flag documentation for v3.3.10-era behavior and references.

Reviewed changes

Copilot reviewed 25 out of 25 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
docs/gitbook/src/SUMMARY.md Adds new pages to the GitBook navigation (Datadir Structure, overlay/parity/graphql namespaces, Dev Chain).
docs/gitbook/src/get-started/hardware-requirements.md Adds a “Sync Times” section with rough benchmarks and a link to sync modes.
docs/gitbook/src/get-started/fundamentals/staking/external-consensus-client-as-validator.md Updates Lighthouse validator-client documentation link.
docs/gitbook/src/get-started/fundamentals/security.md Expands RPC security guidance (WS origins, IPC, insecure unlock).
docs/gitbook/src/get-started/fundamentals/logs.md Updates logging defaults and adds --vmodule documentation.
docs/gitbook/src/get-started/fundamentals/layer-2-networks.md Documents Polygon PoS WIT protocol flag behavior.
docs/gitbook/src/get-started/fundamentals/interacting-with-erigon/README.md Adds new namespace docs and updates external Execution APIs links.
docs/gitbook/src/get-started/fundamentals/interacting-with-erigon/parity.md New page describing Erigon’s limited parity_* compatibility method.
docs/gitbook/src/get-started/fundamentals/interacting-with-erigon/overlay.md New page documenting the Erigon-specific overlay_* analytics namespace.
docs/gitbook/src/get-started/fundamentals/interacting-with-erigon/graphql.md New page documenting GraphQL enablement/endpoints and example queries.
docs/gitbook/src/get-started/fundamentals/dev-chain.md New page describing how to run and connect local dev chains.
docs/gitbook/src/get-started/fundamentals/default-ports.md Updates default port table (eth/69, WS split-out) and trims option list.
docs/gitbook/src/get-started/fundamentals/datadir-structure.md New page explaining datadir layout, disk usage examples, and symlink strategy.
docs/gitbook/src/get-started/fundamentals/creating-a-dashboard.md Updates monitoring instructions/paths and clarifies dashboard details.
docs/gitbook/src/get-started/fundamentals/configuring-erigon.md Adds/updates many flag descriptions and refreshes the embedded --help excerpt/version string.
docs/gitbook/src/get-started/fundamentals/caplin.md Adds Beacon API configuration flags and defaults.
docs/gitbook/src/get-started/easy-nodes/how-to-run-a-polygon-node.md Fixes Polygon Heimdall endpoint URL typo.
docs/gitbook/src/get-started/easy-nodes/how-to-run-a-gnosis-chain-node/gnosis-with-an-external-cl.md Updates JWT secret doc link to new docs host.
docs/gitbook/src/.gitbook/includes/api-documentation-3.md Updates Execution APIs embed URL.
docs/gitbook/src/.gitbook/includes/api-documentation (1).md Updates Execution APIs embed URL.
docs/gitbook-help/troubleshooting.md Updates links and adds a diagnostics collection section (SIGUSR1 + pprof).
docs/gitbook-help/known-issues.md Improves memory-debugging guidance and adds --db.pagesize immutability note.
docs/gitbook-help/frequently-asked-questions-faqs.md Adds FAQ entries about pruning limitations and low-power devices.
docs/gitbook-help/common-errors-and-solutions.md Adds Docker permission mismatch + Silkworm shared-lib startup error entries.
docs/gitbook-help/best-practices.md Adds public RPC hardening guidance and advanced performance snippets.
Comments suppressed due to low confidence (1)

docs/gitbook/src/get-started/fundamentals/default-ports.md:70

  • The port/options list drops the diagnostics endpoint port flag, but --diagnostics.endpoint.port is still a supported knob (default 6062) and is referenced in other module docs. Consider adding it back under the shared ports/options section (or explicitly note that diagnostics is disabled by default and therefore omitted).
### BeaconAPI

* `--beacon.api.port [value]`: Sets the port to listen for beacon api requests (default: `5555`)

## Shutter Network Default Ports

The default peering port for Shutter is `23102` (TCP), to change it use `--shutter.p2p.listen.port <value>`.

Bootstrap nodes are used to help new nodes discover other nodes in the network. By default, the embedded configuration values are used, but these can be overridden with `--shutter.p2p.bootstrap.nodes <value>`.

### Shared ports

* `--pprof.port [value]`: pprof HTTP server listening port (default: `6060`)
* `--metrics.port [value]`: Metrics HTTP server listening port (default: `6061`)
* `--downloader.api.addr [value]`: Downloader address `<host>:<port>`

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

**Dedicated User**: Run Erigon as a dedicated system user rather than root to limit potential damage from security breaches.

**Transaction Pool Security**: Use `--txpool.nolocals=true` for public nodes to prevent local transaction injection.
**IPC Endpoint**: The IPC socket is enabled by default and accessible to any local process with filesystem access to the socket file. On production servers, disable it with `--ipcdisable` or restrict access via filesystem permissions. Use `--ipcpath` to set a custom socket path.

Copilot AI Apr 6, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The doc claims the IPC socket is enabled by default and can be disabled with --ipcdisable, but the erigon binary force-disables IPC by setting nodeConfig.IPCPath = "" (so there is no default IPC endpoint to secure/disable). This section should be updated to reflect the current behavior (or refer to rpcdaemon’s socket.* IPC server if that’s what’s intended).

Suggested change
**IPC Endpoint**: The IPC socket is enabled by default and accessible to any local process with filesystem access to the socket file. On production servers, disable it with `--ipcdisable` or restrict access via filesystem permissions. Use `--ipcpath` to set a custom socket path.
**IPC Endpoint**: The `erigon` binary currently disables its IPC socket by default, so there is no default local IPC endpoint to secure or disable. If you intentionally enable or deploy a separate IPC-capable service (for example, rpcdaemon's socket-based IPC server), treat it as a privileged local interface and restrict access with filesystem permissions, careful path placement, and host-level access controls.

Copilot uses AI. Check for mistakes.
Comment on lines +191 to +210
* `--ipcdisable`: Disables the IPC (Unix socket / named pipe) endpoint. Recommended for production servers where local IPC access is not needed.
* Default: `false`
* `--ipcpath value`: Custom filename for the IPC socket within the datadir (OS default if not set).
* `--authrpc.vhosts value`: A comma-separated list of virtual hostnames for the Engine API.
* Default: `localhost`
* `--http.api value`: The APIs offered over the HTTP-RPC interface.
* Default: `eth,erigon,engine`
* `--ws`: Enables the WS-RPC server.
* Default: `false`
* `--ws.addr value`: The WS-RPC server listening interface.
* Default: `localhost`
* `--ws.port value`: The WS-RPC server listening port.
* Default: `8546`
* `--ws.api value`: The APIs offered over the WebSocket interface. If unset, inherits from `--http.api`.
* `--ws.origins value`: Comma-separated list of allowed WebSocket origins. Empty by default (all cross-origin connections denied). Set explicitly when browser-based clients connect via WebSocket.
* `--ws.rpcprefix value`: HTTP path prefix for the WebSocket JSON-RPC handler. Useful for reverse-proxy setups where WS is exposed on a sub-path.
* `--ws.compression`: Enables compression over WebSocket.
* Default: `true`
* `--ws.api.subscribelogs.channelsize value`: Buffer size for WebSocket log subscription channels.
* Default: `8192`

Copilot AI Apr 6, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This flags list documents --http.rpcprefix, --ipcdisable/--ipcpath, and several WS flags (--ws.addr, --ws.api, --ws.origins, --ws.rpcprefix, --ws.api.subscribelogs.channelsize), but these flags are not part of the erigon CLI’s DefaultFlags (so they won’t show up in erigon --help / won’t be settable via CLI). Either wire these flags into the erigon binary (and keep the later --help excerpt in sync) or remove/clarify them here (e.g., config-file-only vs rpcdaemon-only).

Suggested change
* `--ipcdisable`: Disables the IPC (Unix socket / named pipe) endpoint. Recommended for production servers where local IPC access is not needed.
* Default: `false`
* `--ipcpath value`: Custom filename for the IPC socket within the datadir (OS default if not set).
* `--authrpc.vhosts value`: A comma-separated list of virtual hostnames for the Engine API.
* Default: `localhost`
* `--http.api value`: The APIs offered over the HTTP-RPC interface.
* Default: `eth,erigon,engine`
* `--ws`: Enables the WS-RPC server.
* Default: `false`
* `--ws.addr value`: The WS-RPC server listening interface.
* Default: `localhost`
* `--ws.port value`: The WS-RPC server listening port.
* Default: `8546`
* `--ws.api value`: The APIs offered over the WebSocket interface. If unset, inherits from `--http.api`.
* `--ws.origins value`: Comma-separated list of allowed WebSocket origins. Empty by default (all cross-origin connections denied). Set explicitly when browser-based clients connect via WebSocket.
* `--ws.rpcprefix value`: HTTP path prefix for the WebSocket JSON-RPC handler. Useful for reverse-proxy setups where WS is exposed on a sub-path.
* `--ws.compression`: Enables compression over WebSocket.
* Default: `true`
* `--ws.api.subscribelogs.channelsize value`: Buffer size for WebSocket log subscription channels.
* Default: `8192`
* `--authrpc.vhosts value`: A comma-separated list of virtual hostnames for the Engine API.
* Default: `localhost`
* `--http.api value`: The APIs offered over the HTTP-RPC interface.
* Default: `eth,erigon,engine`
* `--ws`: Enables the WS-RPC server.
* Default: `false`
* `--ws.port value`: The WS-RPC server listening port.
* Default: `8546`
* `--ws.compression`: Enables compression over WebSocket.
* Default: `true`

Copilot uses AI. Check for mistakes.
Comment on lines 25 to 31
* `--log.json`: Enable JSON formatting for console logs
* `--verbosity`: Set console log level (default: `2`)
* `--verbosity`: Set console log level (default: `3` / `info`)
* `--log.dir.path`: Specify directory for log files. By default Erigon writing logs to `datadir/logs` directory.
* `--log.dir.verbosity`: Set file log level
* `--log.delays`: Enable block delay logging
* `--vmodule`: Per-module verbosity overrides using `pattern=level` pairs, overriding `--verbosity` for matching packages. Example: `--vmodule=eth/*=5,p2p=4` sets trace-level logging for all packages under `eth/` and debug-level for `p2p`. Useful for targeted debugging without flooding all logs.

Copilot AI Apr 6, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--verbosity is described as having a numeric default (3), but the CLI flag default is the string level info (numeric values are accepted, but --help shows the default as info). To avoid confusion, consider documenting the default as info (and optionally mention it corresponds to level 3).

Copilot uses AI. Check for mistakes.
@bloxster

bloxster commented Apr 7, 2026

Copy link
Copy Markdown
Collaborator Author

All the above requests have been implemented.

@bloxster bloxster merged commit 46b2f7e into release/3.3 Apr 7, 2026
13 checks passed
@bloxster bloxster deleted the gitbook_docs_v3.3 branch April 7, 2026 09:40
awskii pushed a commit that referenced this pull request Apr 7, 2026
…xprice, whitelist, silkworm.workers) (#20384)

## Summary

Removes 4 flags from the prose section of `configuring-erigon.md` that
are **not in `node/cli/default_flags.go`** (= not accessible via `erigon
--help`) and also absent from the verbatim `--help` dump in the docs.

Flags removed:
- `--vmodule` — not in DefaultFlags (already removed from `logs.md` in
#20263; this removes the remaining mention in `configuring-erigon.md`)
- `--gpo.maxprice` (`GpoMaxGasPriceFlag`) — not in DefaultFlags
- `--whitelist` (`WhitelistFlag`) — not in DefaultFlags
- `--silkworm.workers` — not in DefaultFlags and not found in
`cmd/utils/flags.go`

Identified by the weekly DefaultFlags comprehensive audit (w15,
2026-04-07).

🤖 Generated with [Claude Code](https://claude.ai/claude-code)
github-merge-queue Bot pushed a commit that referenced this pull request Apr 8, 2026
….api, ws.origins) (#20382)

## Summary

Removes flags documented in the prose section of
`configuring-erigon/README.md` that are **not registered in
`node/cli/default_flags.go`** and therefore not settable via `erigon`
CLI.

Flags removed:
- `--ipcdisable` — not in DefaultFlags; IPC is also force-disabled at
runtime (`nodeConfig.IPCPath = ""`)
- `--ipcpath` — not in DefaultFlags; IPC is force-disabled at runtime
- `--ws.addr` — not in DefaultFlags
- `--ws.api` — not in DefaultFlags
- `--ws.origins` — not in DefaultFlags

The WS flags that ARE in DefaultFlags remain: `--ws`, `--ws.port`,
`--ws.compression`.

Mirrors fixes already applied to `release/3.3` (PR #20263, commit
e2edbc7 / d1baf2f).

Note: `release/3.4` was already clean (no issue found there).

🤖 Generated with [Claude Code](https://claude.ai/claude-code)
pull Bot pushed a commit to Dustin4444/erigon that referenced this pull request May 13, 2026
## Summary

Brings the full `docs/site/` Docusaurus tree into `main`, incorporating
all documentation improvements developed against `release/3.4`.

**Scope:** `docs/site/**` + root `llms.txt` / `llms-full.txt` + removal
of superseded `docs/gitbook/` and `docs/gitbook-help/`. No changes to
Go, proto, or any non-docs source files.

### Included — merged to release/3.4

| PR | What |
|----|------|
| [erigontech#20883](erigontech#20883) | Docusaurus
v3 migration — full `docs/site/` tree, Docusaurus config, versioned v3.3
snapshot |
| [erigontech#20263](erigontech#20263) /
[erigontech#20264](erigontech#20264) | All v3.3
docs ported; branch/versioning convention established |
| [erigontech#20978](erigontech#20978) | Mobile
footer fix, SEO meta tags, OG image |
| [erigontech#20991](erigontech#20991) | Self-host
brand fonts (remove Google Fonts / CDN) |
| [erigontech#21000](erigontech#21000) | `llms.txt`
/ `llms-full.txt` generator script + root artifacts |
| [erigontech#21018](erigontech#21018) | May 2026
w19 maintenance — stale flags, broken links, accuracy fixes |
| [erigontech#21045](erigontech#21045) | CI:
docs-only path filter (skip Go jobs, run docs-site build) |
| [erigontech#21063](erigontech#21063) | `trace`
response fields reference + sync-monitoring guidance |
| [erigontech#21074](erigontech#21074) | Regenerate
`llms.txt` after sync-modes update |
| [erigontech#20997](erigontech#20997) | Brand font
consistency fix, installation page UX |

### Included — pending review on release/3.4

| PR | What |
|----|------|
| [erigontech#21030](erigontech#21030) | Automated
disk size pipeline: `update-disk-sizes.py`, `disk-sizes.json`,
`hardware-requirements.mdx` JSX fix, `generate-llms.py` `—` fallback,
unit tests |
| [erigontech#21129](erigontech#21129) | May 2026
w20 maintenance — `--caplin.nat`, `--caplin.columns-keep-slots`, RPC
subscription defaults, `nat.md` Caplin section, log.dir.verbosity
default |

### What changes on `main`

- `docs/site/` added (full Docusaurus tree, current v3.4 + frozen v3.3
snapshot)
- `docs/gitbook/` and `docs/gitbook-help/` removed (superseded by
Docusaurus)
- Root `llms.txt` and `llms-full.txt` updated to Docusaurus-generated
versions

> ⚠️ This PR does **not** remove `docs/gitbook/` yet — that cleanup will
be a separate commit once this PR is reviewed and approved.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Bloxster <bloxster@proton.me>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: lupin012 <58134934+lupin012@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.

3 participants