diff --git a/docs.json b/docs.json index b46e18eca..3220f9d24 100644 --- a/docs.json +++ b/docs.json @@ -440,6 +440,10 @@ { "tab": "Operate", "groups": [ + { + "group": "Introduction", + "pages": ["operate/index"] + }, { "group": "Network Notices", "pages": [ diff --git a/operate/index.mdx b/operate/index.mdx new file mode 100644 index 000000000..660015186 --- /dev/null +++ b/operate/index.mdx @@ -0,0 +1,87 @@ +--- +title: "Operate a Celo Node" +sidebarTitle: "Start here" +description: Run and maintain a Celo L2 node, read the protocol specification, and track the upgrades that affect operators +--- + +This section is for node operators, RPC providers, and readers of the Celo L2 protocol specification. The fastest path to a synced node is [Run a node with Docker](/operate/operators/run-node). Ask in [#celo-L2-support](https://discord.com/channels/600834479145353243/1286649605798367252) on [Discord](https://chat.celo.org) if you get stuck. + + +Celo is replacing `op-geth` with `op-reth` as its execution client. See [End of Support for op-geth](/operate/notices/op-geth-deprecation) for each network's switch date. + + +## Run a node + + + + What a Celo L2 node is, the node tiers, and which execution client to run. + + + Bring up a full node with op-reth from a published snapshot. + + + Keep all historical state so the node answers RPC calls at any block. + + + Settings for a node that serves public JSON-RPC traffic. + + + +## Keep a node healthy + + + + Enable the monitoring stack and watch sync status and node health. + + + Upgrade clients, restart safely, and back up node data. + + + Fixes for stalled transactions, stalled syncs, and a node that finds no peers. + + + Serve deep `eth_getProof` requests from op-reth without running an archive node. + + + +## Reference + + + + The environment variables and client flags used by celo-l2-node-docker-compose. + + + Bootnodes, container images, and downloadable artifacts for each network. + + + Answers to common questions about running nodes on Celo L2. + + + +## Protocol specification + + + + How the Celo L2 differs from the OP Stack it is built on. + + + Deployment parameters and OP Stack config for Celo mainnet and Celo Sepolia. + + + Optimism's Jovian hardfork plus Celo's transfer precompile and gas pricing changes. + + + +## Network notices + + + + Upgrade notices and deprecations that need action from node operators. + + + +## Related + +- [Network information](/build-on-celo/network-overview) — chain IDs, RPC URLs, explorers, and the faucet for Celo mainnet and Celo Sepolia. +- [Nodes and services](/tooling/nodes/overview) — hosted RPC providers and Forno, for readers who need an endpoint rather than their own node. +- [Operating a community RPC node](/contribute-to-celo/community-rpc-nodes/community-rpc-node) — run a registered node that serves a public endpoint and earns rewards.