Skip to content

docs: document Reth port and log level variables in env files#1077

Open
erhnysr wants to merge 1 commit into
base:mainfrom
erhnysr:docs/document-reth-port-and-log-variables
Open

docs: document Reth port and log level variables in env files#1077
erhnysr wants to merge 1 commit into
base:mainfrom
erhnysr:docs/document-reth-port-and-log-variables

Conversation

@erhnysr
Copy link
Copy Markdown

@erhnysr erhnysr commented May 13, 2026

Summary

Adds commented-out documentation for Reth-specific port and log level variables that are supported by reth-entrypoint but were completely absent from the env files.

Problem

Operators who want to customize Reth ports (e.g. running multiple nodes, resolving port conflicts) or change log verbosity had no way to discover these variables without reading the entrypoint source code directly.

Changes

Added documented, commented-out entries to both .env.mainnet and .env.sepolia:

Variable Default Description
RPC_PORT 8545 HTTP JSON-RPC port
WS_PORT 8546 WebSocket JSON-RPC port
AUTHRPC_PORT 8551 Engine API (authenticated RPC) port
METRICS_PORT 6060 Prometheus metrics port
DISCOVERY_PORT 30303 P2P discovery port
V5_DISCOVERY_PORT 9200 discv5 discovery port
P2P_PORT 30303 P2P TCP port
LOG_LEVEL info Reth log verbosity (error/warn/info/debug/trace)

Verification

All variables verified against reth/reth-entrypoint source.

@cb-heimdall
Copy link
Copy Markdown
Collaborator

cb-heimdall commented May 13, 2026

🟡 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 0
Sum 1

Operators who want to customise execution-client ports (e.g. to run
multiple nodes or resolve port conflicts) or change log verbosity had
no way to discover the supported variables without reading
execution-entrypoint directly.

Add commented-out PORT CONFIGURATION and LOG LEVEL sections to both
.env.mainnet and .env.sepolia, listing all variables already supported
by execution-entrypoint with their defaults:

  RPC_PORT, WS_PORT, AUTHRPC_PORT, METRICS_PORT,
  DISCOVERY_PORT, V5_DISCOVERY_PORT, P2P_PORT, LOG_LEVEL

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@erhnysr erhnysr force-pushed the docs/document-reth-port-and-log-variables branch from 4a57828 to 40f1179 Compare May 22, 2026 06:52
@erhnysr
Copy link
Copy Markdown
Author

erhnysr commented May 22, 2026

Rebased on latest main (post #1090)

The PR has been rebased onto the current main branch. After #1090 unified the client entrypoints, execution-entrypoint already defines all of these variables — but they remain undocumented in the .env files, so operators still can't discover them without reading the entrypoint source.

Changes (.env.mainnet and .env.sepolia):

Added two new commented-out sections before the existing PRUNING block:

# PORT CONFIGURATION (OPTIONAL - UNCOMMENT TO OVERRIDE DEFAULTS)
# RPC_PORT=8545          # HTTP JSON-RPC port
# WS_PORT=8546           # WebSocket JSON-RPC port
# AUTHRPC_PORT=8551      # Engine API (authenticated RPC) port
# METRICS_PORT=6060      # Prometheus metrics port
# DISCOVERY_PORT=30303   # P2P discovery port
# V5_DISCOVERY_PORT=9200 # discv5 discovery port
# P2P_PORT=30303         # P2P TCP port

# LOG LEVEL (OPTIONAL - UNCOMMENT TO OVERRIDE DEFAULT)
# Supported values: error, warn, info, debug, trace (default: info)
# LOG_LEVEL=info

All variables verified against the current execution-entrypoint. No behaviour change — purely additive documentation. Happy to address any feedback.

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