Skip to content

docs: add Default Ports and Stopping the Node sections to README #928

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

docs: add Default Ports and Stopping the Node sections to README #928

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
38 changes: 38 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,44 @@ Base is a secure, low-cost, developer-friendly Ethereum L2 built on Optimism's [
- `geth`
- `nethermind`

## Default Ports

The node exposes the following ports by default:

**Execution Client:**
| Port | Protocol | Description |
|------|----------|-------------|
| 8545 | TCP | HTTP JSON-RPC |
| 8546 | TCP | WebSocket |
| 7301 | TCP | Metrics |
| 30303 | TCP/UDP | P2P |

**OP Node:**
| Port | Protocol | Description |
|------|----------|-------------|
| 7545 | TCP | HTTP JSON-RPC |
| 9222 | TCP/UDP | P2P |
| 7300 | TCP | Metrics |
| 6060 | TCP | pprof |

These ports can be customized by modifying the `docker-compose.yml` file.

## Stopping the Node

To stop the node gracefully:

```bash
docker compose down
```

To stop the node and remove all data volumes (full reset):

```bash
docker compose down -v
```

If running in the foreground, you can also press `Ctrl+C` to initiate a graceful shutdown.

## Requirements

### Minimum Requirements
Expand Down