---
component: docker
version: "0.9"
slug: docker/getting-started
canonical_url: "https://docs.develocity.ai/docker/0.9/getting-started/"
title: "Getting Started With Develocity for Docker"
description: "Install the Develocity Docker agent, connect it to your Develocity server, and publish a Build Scan for your first Docker image build."
keywords:
  - "docker agent"
  - "installation"
  - "BuildKit"
  - "agent setup"
status: current
---

<!-- llms-index: https://docs.develocity.ai/llms.txt -->

# Getting Started With Develocity for Docker

<a id="preamble"></a>

> [!NOTE]
> Docker support is not enabled by default. To enable it, contact Develocity support.

<a id="installation"></a>

## Installation

Develocity server installation isn’t covered here. Consult one of the following installation manuals for help with installation:

*   [Self-Hosted Kubernetes Installation Guide](https://docs.develocity.ai/2026.3/installation/kubernetes-installation/)
    
*   [Self-Hosted Standalone Installation Guide](https://docs.develocity.ai/2026.3/installation/standalone-installation/)
    
*   [Amazon EKS Kubernetes Installation Guide](https://docs.develocity.ai/2026.3/installation/aws/aws-eks-cluster/)
    
*   [Amazon EC2 Standalone Installation Guide](https://docs.develocity.ai/2026.3/installation/aws/aws-ec2-standalone/)
    
*   [Azure AKS Kubernetes Installation Guide](https://docs.develocity.ai/2026.3/installation/azure/azure-aks-cluster/)
    
*   [Azure VM Standalone Installation Guide](https://docs.develocity.ai/2026.3/installation/azure/azure-vm-standalone/)
    
*   [Google GKE Kubernetes Installation Guide](https://docs.develocity.ai/2026.3/installation/google-cloud/gke-kubernetes/)
    
*   [Google Compute Engine Standalone Installation Guide](https://docs.develocity.ai/2026.3/installation/google-cloud/gce-standalone/)
    

The examples in this guide use `develocity.example.com` as the Develocity hostname with HTTPS enabled.

<a id="develocity-docker-agent"></a>

### Develocity Docker Agent

The Develocity Docker agent runs alongside your Docker builder as a separate process, on the same host where you run `docker buildx build`. It requires no change to your Dockerfiles or build commands.

> [!IMPORTANT]
> Docker Engine 24.0 or later, with the docker CLI on PATH Docker Buildx 0.13 or later Java 21 or later Network access to your Develocity server

1.  Download the agent JAR:
    
    ```shell
    curl -OL https://develocity-docker-build-agent.gradle.com/develocity-docker-agent-0.9.0.jar
    ```
    
    > [!TIP]
    > To verify the download before running it, see Verifying the Signature of the Agent JAR in the Docker agent user manual.
    
2.  Start the agent, pointing it at your Develocity server with the `DEVELOCITY_URL` environment variable:
    
    ```shell
    DEVELOCITY_URL=https://develocity.example.com java -jar develocity-docker-agent-0.9.0.jar
    ```
    
    The agent accepts no command line arguments: it is configured entirely through environment variables.
    
3.  Wait for the agent to report that it is ready:
    
    **Output:**
    
    ```
    subscribed to BuildKit, waiting for builds
    ```
    

To publish to a Develocity instance that requires authentication, configure an access key. See [Authenticating With Develocity](https://docs.develocity.ai/docker/0.9/docker-agent/#authenticating-with-develocity) in the Docker agent user manual.

<a id="build-scan"></a>

## Build Scan

A Build Scan is a record of each Docker image build, captured and published to your Develocity instance. Each Build Scan includes the build steps, their console output, and a searchable history across all builds.

<a id="quick-start"></a>

### Quick Start

While the agent is running, every image build performed by the observed builder publishes a Build Scan. The agent observes the builder currently selected for its Docker CLI environment: see [How the Agent Observes Builds](https://docs.develocity.ai/docker/0.9/docker-agent/#how-the-agent-observes-builds) in the Docker agent user manual. Run any image build:

```shell
docker buildx build -t acme/app .
```

As the build completes, the agent logs a line similar to:

**Output:**

```
scan published: https://develocity.example.com/s/3z475bz247h5g
```

Follow that link to view your Build Scan.

![Docker Build Scan summary view of a successful build](https://docs.develocity.ai/docker/0.9/getting-started/../_images/docker-build-scan-summary.png)

Docker Build Scan Summary

Build Scan publication is passive with regard to the build process: it doesn’t affect the outcome or outputs of your build. The agent won’t cause build failures, even when there is no connection to the Develocity server when trying to publish.

<a id="find-and-view-any-build-scan"></a>

### Find and View Any Build Scan

Search through all captured Build Scan records by going to `https://develocity.example.com/scans`.

![Build Scan list filtered to Docker builds](https://docs.develocity.ai/docker/0.9/getting-started/../_images/docker-build-scan-list.png)

Build Scan List Filtered to Docker Builds

Search by project name, username, build outcome, start time, and more. By default, the list shows the most recent Build Scan records first.

<a id="inspect-build-steps"></a>

### Inspect Build Steps

Each Build Scan breaks the image build down into its individual steps. For every step you can see how long it took, its outcome (passed, cached, canceled, or failed), and the console output it produced. The timeline highlights the build’s critical path, and selecting a step opens its details.

![Timeline view showing the steps of an image build](https://docs.develocity.ai/docker/0.9/getting-started/../_images/docker-build-scan-timeline.png)

Timeline of an Image Build

Failed steps show their console output, and the build’s exit code is reported alongside.

![Failures view showing a failed step with its error output](https://docs.develocity.ai/docker/0.9/getting-started/../_images/docker-build-scan-failures.png)

Failure View of a Failed Image Build

<a id="custom-tags-values-and-links"></a>

### Custom Tags, Values, and Links

The agent adds some metadata automatically, and each Build Scan can be enriched further with custom tags, values, and links passed as build arguments: see [Extending Build Scan](https://docs.develocity.ai/docker/0.9/docker-agent/#extending-build-scans) in the Docker agent user manual for the available options. Captured automatically:

*   A `CI` or `LOCAL` tag, depending on where the build ran, and the name of the CI provider
    
*   VCS information for git checkouts: the repository URL and the commit identifier, and the branch name when the agent can resolve it (see [VCS Information](https://docs.develocity.ai/docker/0.9/docker-agent/#vcs-information) in the Docker agent user manual)
    
*   A link to the corresponding CI build on TeamCity; for other CI providers, pass the link with a `DEVELOCITY_LINK_«label»` build argument
    

<a id="whats-next"></a>

## What’s Next

*   For the full configuration reference, see the [Develocity Docker agent user manual](https://docs.develocity.ai/docker/0.9/docker-agent/).
    
*   For what changed in each Docker agent release, see [Release History](https://docs.develocity.ai/docker/0.9/release-history/).