Skip to content

Commit 83df99f

Browse files
authored
Add details on volume mapping (#21)
1 parent e502f52 commit 83df99f

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,40 +29,56 @@ This repository contains the relevant Docker builds to run your own node on the
2929
### Hardware requirements
3030

3131
We recommend you this configuration to run a node:
32+
3233
- at least 16 GB RAM
3334
- an SSD drive with at least 100 GB free
3435

3536
### Troubleshooting
3637

3738
If you encounter problems with your node, please open a [GitHub issue](https://github.com/base-org/node/issues/new/choose) or reach out on our [Discord](https://discord.gg/buildonbase):
39+
3840
- Once you've joined, in the Discord app go to `server menu` > `Linked Roles` > `connect GitHub` and connect your GitHub account so you can gain access to our developer channels
3941
- Report your issue in `#🛟|node-support`
4042

4143
### Supported networks
4244

4345
| Ethereum Network | Status |
44-
|------------------|--------|
46+
| ---------------- | ------ |
4547
| Goerli testnet ||
4648
| Mainnet | 🚧 |
4749

4850
### Usage
4951

5052
1. Ensure you have an Ethereum Goerli L1 node RPC available (not Base Goerli), and set `OP_NODE_L1_ETH_RPC` (in `docker-compose.yml` if using docker-compose). If running your own L1 node, it needs to be synced before Base will be able to fully sync.
5153
2. Run:
54+
5255
```
53-
docker compose up
56+
docker compose up --build
5457
```
58+
5559
3. You should now be able to `curl` your Base node:
60+
5661
```
5762
curl -d '{"id":0,"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":["latest",false]}' \
5863
-H "Content-Type: application/json" http://localhost:8545
5964
```
6065

6166
Note: Some L1 nodes (e.g. Erigon) do not support fetching storage proofs. You can work around this by specifying `--l1.trustrpc` when starting op-node (add it in `op-node-entrypoint.sh` and rebuild the docker image with `docker compose build`.) Do not do this unless you fully trust the L1 node provider.
6267

68+
You can map a local data directory for `op-geth` by adding a volume mapping to the `docker-compose.yaml`:
69+
70+
```yaml
71+
services:
72+
geth: # this is Optimism's geth client
73+
...
74+
volumes:
75+
- $HOME/data/base:/data
76+
```
77+
6378
### Syncing
6479
6580
Sync speed depends on your L1 node, as the majority of the chain is derived from data submitted to the L1. You can check your syncing status using the `optimism_syncStatus` RPC on the `op-node` container. Example:
81+
6682
```
6783
echo Latest synced block behind by: \
6884
$((($( date +%s )-\

0 commit comments

Comments
 (0)