Skip to content

docs: add Docker/Compose prerequisites to Quick Start #640

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Docker/Compose prerequisites to Quick Start #640

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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,18 @@ Base is a secure, low-cost, developer-friendly Ethereum L2 built on Optimism's [
# For testnet with a specific client:
NETWORK_ENV=.env.sepolia CLIENT=reth docker compose up --build
```
### Prerequisites (Software)

- **Docker** (v24+ recommended) and **Docker Compose v2** (uses the `docker compose` syntax).
- Install Docker: https://docs.docker.com/engine/install/
- Enable Docker Compose v2: https://docs.docker.com/compose/
- Make sure `docker compose` command works:
```bash
docker compose version
```
If your system only has `docker-compose` (with a hyphen), please install/enable Compose **v2** or upgrade Docker.

> This clarifies the `docker compose up` commands used below and helps avoid “command not found” issues on older setups.

### Supported Clients

Expand Down Expand Up @@ -140,6 +152,8 @@ For support please join our [Discord](https://discord.gg/buildonbase) post in `

## Disclaimer



THE NODE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. We make no guarantees about asset protection or security. Usage is subject to applicable laws and regulations.

For more information, visit [docs.base.org](https://docs.base.org/).