Comment on page
Learn how to run PACE in your local environment
There are several ways to run PACE – including starting the Spring Boot application from your IDE – but the easiest way to run it, is via Docker. This way, no JVM is needed, and a REST interface to PACE is included out of the box (whereas the standalone Spring Boot application only exposes a gRPC interface).
Before you get started, make sure you've installed the following tools:
The relative location of the files created in the rest of this document can be seen as titles in the respective code blocks.
The following config is used for configuring your PACE application. If you use your own Postgres instance, modify accordingly.
Create the following
docker-compose.yamlin the parent directory of where you created
Extra Spring Boot configuration is configured to be read from an**
/app/config**volume. Be sure to add all relevant Spring Boot configuration files there. The below setup mounts the config dir to this volume.
# you may want to update the image to the latest version
- "8080:8080" # Spring Boot
- "9090:9090" # Envoy JSON / gRPC Proxy
- "50051:50051" # gRPC
If you are already logged in to ghcr.io with Docker, you can skip this step. If not, or if you get an unauthorized exception during the next step, you most likely need to do follow the GitHub Authentication instructions.
To start pace, execute
docker compose upin the directory containing your
docker-compose.yamlfile. You should see the Spring Boot startup logs, which will end with
Started PaceApplicationKt [...], if all went well.
pace list catalogs -o table
curl --silent http://localhost:9090/catalogs | jq
Since we have not configured any catalogs, the result is not particularly interesting, though it confirms that your PACE instance is running correctly.