README.md

Docker Compose

All commands are run from the monorepo root.

Files

File	Purpose
docker/docker-compose.yml	Base stack — ensindexer, ensapi, ensrainbow, ensadmin, ensdb. For mainnet/sepolia.
docker/docker-compose.devnet.yml	Full stack against local devnet (ens-test-env). Includes all base services + devnet.
docker/docker-compose.orchestrator.yml	Minimal infra for CI — devnet + ensdb only. Used by orchestrator.ts.
docker/services/*.yml	Individual service definitions. Extended by the compose files above.
docker/envs/.env.docker.common	Shared env defaults (ensdb credentials, internal service URLs). Committed.
docker/envs/.env.docker.devnet	Devnet defaults (PLUGINS, etc.). Committed. Works out of the box.
docker/envs/.env.docker.example	Example for user-specific config. Copy to .env.docker.local for mainnet/sepolia.
docker/envs/.env.docker.local	User config (gitignored). Required for base stack, optional for devnet overrides.

To inspect the fully resolved config for any compose file (resolves all extends):

docker compose -f docker/docker-compose.yml config

Use cases

Mainnet / Sepolia

1. Configure environment (one-time setup):

cp docker/envs/.env.docker.example docker/envs/.env.docker.local

Edit docker/envs/.env.docker.local and set NAMESPACE, PLUGINS, and your RPC endpoints (e.g. ALCHEMY_API_KEY or RPC_URL_1).

2. Start/stop the stack:

# Start full stack in background
docker compose -f docker/docker-compose.yml up -d

# Stop
docker compose -f docker/docker-compose.yml down

# Stop and remove volumes
docker compose -f docker/docker-compose.yml down -v

Local devnet (for developers)

No setup required — devnet defaults are committed in docker/envs/.env.docker.devnet.

To override defaults (e.g. change PLUGINS), create docker/envs/.env.docker.local with your values.

# Start full stack against devnet
docker compose -f docker/docker-compose.devnet.yml up -d

# Start only devnet + core services (no ensadmin)
docker compose -f docker/docker-compose.devnet.yml up -d ensindexer ensapi

# Start only devnet (quick local EVM node, also shows data information about devnet)
docker compose -f docker/docker-compose.devnet.yml up devnet
# or
pnpm devnet

# Stop
docker compose -f docker/docker-compose.devnet.yml down

Build images locally

# Build all images
pnpm docker:build:ensnode

# Build a specific image
pnpm docker:build:ensindexer
pnpm docker:build:ensapi
pnpm docker:build:ensrainbow
pnpm docker:build:ensadmin

CI / integration tests

Used internally by orchestrator.ts via testcontainers. Starts devnet + ensdb only.

pnpm test:integration:ci