11# Scroll Rollup Node Docker Compose
22
3- This guide explains how to use Docker Compose to launch the Scroll Rollup Node, including standard and shadow-fork modes.
3+ This guide explains how to use Docker Compose to launch the Scroll Rollup Node, including standard and shadow-fork
4+ modes.
45
56---
67
78## Prerequisites
9+
810- [ Docker] ( https://docs.docker.com/get-docker/ ) and [ Docker Compose] ( https://docs.docker.com/compose/install/ ) installed
911- Clone this repository
1012
@@ -24,20 +26,20 @@ This guide explains how to use Docker Compose to launch the Scroll Rollup Node,
2426 This will launch the rollup node, Prometheus, and Grafana with default settings.
2527
26283 . ** Access the services:**
27- - Rollup Node JSON-RPC: [ http://localhost:8545 ] ( http://localhost:8545 )
28- - Rollup Node WebSocket: [ ws://localhost:8546] ( ws://localhost:8546 )
29- - Prometheus: [ http://localhost:19090 ] ( http://localhost:19090 )
30- - Grafana: [ http://localhost:13000 ] ( http://localhost:13000 )
29+ - Rollup Node JSON-RPC: [ http://localhost:8545 ] ( http://localhost:8545 )
30+ - Rollup Node WebSocket: [ ws://localhost:8546] ( ws://localhost:8546 )
31+ - Prometheus: [ http://localhost:19090 ] ( http://localhost:19090 )
32+ - Grafana: [ http://localhost:13000 ] ( http://localhost:13000 )
3133
3234---
3335
3436## Shadow-Fork Mode
3537
3638Shadow-fork mode allows you to run the node against a forked L1 chain for testing and development.
3739
38- ### 1. Edit the ` .env.shadow-fork ` file
40+ ### 1. Edit the ` .env ` file
3941
40- The file ` docker-compose/.env.shadow-fork ` contains environment variables for shadow-fork mode:
42+ The file ` docker-compose/.env ` contains environment variables for enabling shadow-fork mode:
4143
4244```
4345SHADOW_FORK=true
@@ -50,40 +52,34 @@ ENV=sepolia # Or 'mainnet' for mainnet fork
5052** Recommended (Docker Compose v1.28+):**
5153
5254``` sh
53- docker compose --env-file .env.shadow-fork --profile shadow-fork up -d
55+ docker compose --env-file .env --profile shadow-fork up -d
5456```
5557
5658- This will start both the L1 devnet and the rollup node in shadow-fork mode.
5759- The ` FORK_BLOCK_NUMBER ` and ` ENV ` variables control the fork point and network.
5860
59- ** Alternative:**
60- You can also copy or rename ` .env.shadow-fork ` to ` .env ` if you want it to be loaded automatically:
61-
62- ``` sh
63- cp .env.shadow-fork .env
64- # Then run:
65- docker compose --profile shadow-fork up -d
66- ```
67-
6861---
6962
7063## Stopping the Stack
7164
7265To stop all services:
66+
7367``` sh
7468docker compose down
7569```
7670
7771---
7872
7973## Troubleshooting
74+
8075- Make sure the ports (8545, 8546, 19090, 13000) are not used by other processes.
8176- If you change environment variables, restart the stack with ` docker compose down && docker compose up -d ` .
8277- For shadow-fork mode, always ensure you specify the correct ` --env-file ` or have the right ` .env ` file in place.
8378
8479---
8580
8681## More
82+
8783- See ` docker-compose/docker-compose.yml ` for all available services and configuration options.
8884- For advanced usage, refer to the official [ Docker Compose documentation] ( https://docs.docker.com/compose/ ) .
8985
0 commit comments