README.local.md

Setting Development Environment Locally

Up All Services

# up = build image + start service
make -f Makefile.local up

Up a Single Service

# up = build image + start service
make -f Makefile.local up service=l1_chain

Down All Services

# down = destroy all containers with images kept; you can not down a single service
make -f Makefile.local down

Stop All Service And Clear Data

make -f Makefile.local clean

Start/Stop All Services

make -f Makefile.local start
make -f Makefile.local stop

Start/Stop a Single Service

equal to docker start/stop bitl1chain (container name, not service name)

make -f Makefile.local start service=l1_chain
make -f Makefile.local stop service=l1_chain

Restart All Services

make -f Makefile.local restart

Restart a Single Service

make -f Makefile.local restart service=l1_chain

List Containers/Services

make -f Makefile.local ps

Rebuild All Service Images

make -f Makefile.local build

Rebuild A Single Service Image

make -f Makefile.local build service=l1_chain

Clean All Local Data

# this will stop all services and delete all data in data/
make -f Makefile.local clean

Some Key Points

Multiple docker compose files

ref: https://docs.docker.com/compose/extends/#example-use-case

docker-compose -f docker-compose.yml \
              -f docker-compose.override.yml up

This feature can be used to split / extend docker-compose.yml

.env file

If you need to override some environment variables, use .env docker-compose will load it automatically

It is ignored by .gitignore and .dockerignore.

cp template.local.env .env

vim .env

Data Volume Mount

Data of container such as l1_chain l2geth verifier is mapped to ops/data directory by volume directive in docker-compose.yaml