Skip to content

docs: align README with default execution client (Geth) #1032

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RonCongrevekun wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −11
Open

docs: align README with default execution client (Geth) #1032

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,16 @@ Base is a secure, low-cost, developer-friendly Ethereum L2 built on Optimism's [
```
4. Start the node:

The default [execution client](#supported-clients) is **Geth** unless you set the `CLIENT` environment variable (see the root `.env` and `docker-compose.yml`).

```bash
# For mainnet (default):
# For mainnet (default, Geth):
docker compose up --build

# For testnet:
NETWORK_ENV=.env.sepolia docker compose up --build

# To use a specific client (optional):
# To use a different client (e.g. Reth):
CLIENT=reth docker compose up --build

# For testnet with a specific client:
Expand All @@ -40,8 +42,10 @@ Base is a secure, low-cost, developer-friendly Ethereum L2 built on Optimism's [

### Supported Clients

- `reth` (default)
- `geth`
Execution clients (override with `CLIENT=…`; default is **Geth**):

- `geth` (default)
- `reth`
- `nethermind`

## Requirements
Expand Down Expand Up @@ -71,13 +75,7 @@ The following are the hardware specifications we use in production:
- **Filesystem**: ext4

> [!NOTE]
To run the node using a supported client, you can use the following command:
`CLIENT=supported_client docker compose up --build`

Supported clients:
- reth (runs vanilla node by default, Flashblocks mode enabled by providing RETH_FB_WEBSOCKET_URL, see [Reth Node README](./reth/README.md))
- geth
- nethermind
The default image is Geth. To use another client, set `CLIENT` and rebuild, for example: `CLIENT=reth docker compose up --build` or `CLIENT=nethermind docker compose up --build`. For Reth-specific options (e.g. Flashblocks via `RETH_FB_WEBSOCKET_URL`), see the [Reth Node README](./reth/README.md).

## Configuration

Expand Down