Skip to content

Commit 564c00f

Browse files
author
Cruz Molina
committed
docs: Update node setup docs and runtime wiring
Clarify the validated first-run Ink node flow and simplify the env template defaults. Align op-node, Compose, and Prometheus settings with the documented setup so startup checks, ports, and sidecar behavior match runtime behavior.
1 parent 8b7947a commit 564c00f

5 files changed

Lines changed: 221 additions & 125 deletions

File tree

.env.example

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,48 +2,49 @@
22
# ↓ REQUIRED ↓ #
33
###############################################################################
44

5-
# Network to run the node on ("ink-mainnet", "ink-sepolia", etc.)
6-
NETWORK_NAME=ink-mainnet
5+
# Recommended first run: ink-sepolia + full
6+
NETWORK_NAME=ink-sepolia
77

8-
# Type of node to run ("full" or "archive"), note that "archive" is 10x bigger
9-
NODE_TYPE=archive
8+
# "full" starts from an empty datadir. "archive" downloads a network snapshot
9+
# during bedrock-init and needs much more disk.
10+
NODE_TYPE=full
1011

11-
# L1 node that the op-node (Bedrock) will get chain data from
12+
# For a quick Sepolia smoke test, these public endpoints worked during docs
13+
# validation:
14+
# - https://ethereum-sepolia-rpc.publicnode.com
15+
# - https://ethereum-sepolia-beacon-api.publicnode.com
16+
# For a long-running node, use a provider with higher rate limits.
17+
18+
# L1 execution RPC endpoint for the matching Ethereum network
1219
OP_NODE__RPC_ENDPOINT=
1320

14-
# L1 beacon endpoint, you can setup your own or use Quicknode
21+
# L1 beacon API endpoint for the matching Ethereum network
1522
OP_NODE__L1_BEACON=
1623

17-
# Type of RPC that op-node is connected to, see README
18-
OP_NODE__RPC_TYPE=quicknode
19-
20-
# L2 RPC to compare your local node against (https://rpc-gel-sepolia.inkonchain.com for ink-sepolia or https://rpc-gel.inkonchain.com for ink-mainnet)
21-
HEALTHCHECK__REFERENCE_RPC_PROVIDER=https://rpc-gel.inkonchain.com
24+
# Use "basic" for generic providers. Other supported values are alchemy,
25+
# quicknode, and erigon.
26+
OP_NODE__RPC_TYPE=basic
2227

28+
# L2 RPC used by the healthcheck sidecar for comparison.
29+
# The per-network env files provide defaults, and this value overrides them.
30+
# For ink-mainnet, switch this to https://rpc-gel.inkonchain.com
31+
HEALTHCHECK__REFERENCE_RPC_PROVIDER=https://rpc-gel-sepolia.inkonchain.com
2332

2433
###############################################################################
2534
# ↓ OPTIONAL ↓ #
2635
###############################################################################
2736

28-
# Feel free to customize your image tag if you want, uses "latest" by default
29-
# See here for all available images: https://hub.docker.com/u/ethereumoptimism
30-
IMAGE_TAG__DTL=
37+
# Optional image tag overrides for sidecars
3138
IMAGE_TAG__HEALTHCHECK=
3239
IMAGE_TAG__PROMETHEUS=
3340
IMAGE_TAG__GRAFANA=
3441
IMAGE_TAG__INFLUXDB=
35-
IMAGE_TAG__OP_GETH=
36-
IMAGE_TAG__OP_NODE=
3742

38-
# Exposed server ports (must be unique)
39-
# See docker-compose.yml for default values
40-
PORT__DTL=
43+
# Exposed host ports (must be unique). Set these only if the defaults clash.
4144
PORT__HEALTHCHECK_METRICS=
4245
PORT__PROMETHEUS=
4346
PORT__GRAFANA=
4447
PORT__INFLUXDB=
45-
PORT__TORRENT_UI=
46-
PORT__TORRENT=
4748
PORT__OP_GETH_HTTP=
4849
PORT__OP_GETH_WS=
4950
PORT__OP_GETH_P2P=

0 commit comments

Comments
 (0)