Skip to main content

Local Docker

Estimated deployment time: 2 minutes

For testing purposes, you can install the agent on your local machine with Docker Compose following these steps.

caution

Meant for testing only. A local deployment means you are the only user who can access the agent from Superblocks. To deploy the agent for use across your organization, use one of the production deployment methods.

Install and run container on your machine​

info

To generate a SUPERBLOCKS_AGENT_KEY, go to the Superblocks On-Premise Agent Setup Wizard.

curl -s https://raw.githubusercontent.com/superblocksteam/agent/main/compose.yaml | \
SUPERBLOCKS_AGENT_KEY="<YOUR_AGENT_KEY>" \
SUPERBLOCKS_AGENT_HOST_URL="http://localhost:8080" \
SUPERBLOCKS_AGENT_DATA_DOMAIN="app.superblocks.com" \
SUPERBLOCKS_DOCKER_AGENT_TAG="latest" \
docker compose -p superblocks -f - up
info

If you use the EU Superblocks instance, set SUPERBLOCKS_AGENT_DATA_DOMAIN to eu.superblocks.com.

Connect to a local database​

To connect your agent to a locally running database, you must specify host.docker.internal in the Superblocks integration config, not localhost. More on this here.