Docker

Docker builds of cardano-graphql are available on DockerHub, built using the root Dockerfile

As the service dependencies are all defined in their own images, the docker-compose.yml is used to provide a self-documenting starting point for your own deployment. It is advised to check a copy into source control, and configure it further to meet your requirements. The default configuration uses the IOHK-managed mainnet config, however you can pass NETWORK=testnet or mount you own config for complete control.

System Requirements

• docker v19+
• docker-compose 1.24+

Start in detached mode, then view output from containers

docker-compose up -d
docker-compose logs -f

The initial sync will take some time, but then you can freely stop, stop, and rebuild the stack if you retain the volumes that persist the node and db state. Once synced, the GraphQL Playground will be fully functional at http://localhost:3100.

List containers

docker-compose ps

Display running processes

docker-compose top

Stop the stack

docker-compose stop

Stop and remove containers, networks, images, and volumes

⚠️ Only do this if you need to re-sync from genesis, or wish to wipe all state from the host.

docker-compose down -v

Troubleshooting

If you have a port clash on the host, change the mapping in the docker-compose