Skip to content

Main Navigation Home Get Started Guides Engine Compose Desktop Reference

Appearance

Sidebar Navigation

Accounts

Accounts

Create an account

Deactivate an account

Manage an account

Admin

Company

Company administration overview

Convert an account into an organization

Create and manage a team

Create your organization

Manage Docker products

Manage organization members

Onboard your organization

Organization

Organization administration

Ai

A2A

ACP

Agents

Architecture

Best practices

Building a coding agent

CLI

Catalog

Claude Code

Codex

Configuration file

Configuration options

Copilot

Credentials

DMR REST API

DMR examples

Defaults

Docker Sandboxes

Dynamic discovery

Examples

Gateway

Gemini

Get started

Get started

Get started with DMR

IDE and tool integrations

Inference engines

Isolation layers

Local models

MCP Catalog and Toolkit

Model Runner

Model providers

OpenCode

Policies

Profiles

Toolkit UI

Toolsets

Troubleshooting

Usage

Use AI models in Compose

Use with CLI

Billing

3D Secure authentication

Add or update a payment method

Invoices and billing history

Manage your billing information

Build

Annotations

Annotations

Architecture

Bake standard library functions

Bake workflow

Base images

Build checks

Build context

Build drivers

Build garbage collection

Build workflow

Builders

Cache storage backends

Debugging

Docker Build Overview

Docker driver

Dockerfile overview

Exporters

Functions

Git validation

Image attestation storage

Image validation

Inheritance

Introduction

Introduction

Local cache

Multi-platform

Multi-stage

Named contexts

SLSA definitions

Secrets

Share image between jobs

Tags and labels

Targets

Test before push

Usage

Variables

Build Cloud

Continuous integration

Optimization

Setup

Usage

Compose

Compose Bridge

Compose SDK

Control startup order

Customize

Environment variables precedence

Extend

FAQs

Give feedback

History and development

How Compose works

Include

Install

Interpolation

Merge

Networking

Plugin

Pre-defined environment variables

Quickstart

Release notes

Secrets in Compose

Set environment variables

Specify a project name

Standalone (Legacy)

Usage

Use Compose in production

Use Model Runner

Use lifecycle hooks

Use service profiles

Why use Compose?

Desktop

Allowlist

Backup and restore data

Builds

Change settings

Common topics

Containers

Debian

Fedora

GPU support

General

Give feedback

Images

Known issues

Linux

Logs

Mac

Mac

Mac permission requirements

MacOS app damaged dialog

Networking

Pause Docker Desktop

Troubleshoot and diagnose

Ubuntu

VM or VDI environments

Virtual Machine Manager

Volumes

WSL

Windows

Windows

Dhi

Attestations

Build process

CVEs

Code signing

Core concepts

Create and build an image

Customize an image or chart

Distroless images

Explore

FIPS

Features

Go

Hardened images

How-tos

Image types

Immutability

Migrate from Alpine or Debian

Migrate from Ubuntu

Migrate from Wolfi

Migration checklist

Migration examples

Mirror a repository

Node.js

Python

Responsibility overview

SBOMs

SSDLC

Search and evaluate

Use a Helm chart

Use an image

Use hardened packages

Use the CLI

VEX

Docker Hub

Advanced options

Archive

Automated repository tests

Create

Delete

Docker Official Images

Export repositories

Image Management

Images

Immutable tags

Insights and analytics

Library

Link accounts

Move images

Optimize usage

Pulls

Push images

Quickstart

Release notes

Repositories

Repository information

Search

Set up

Settings

Software artifacts

Tags

Trusted content

Usage and limits

Engine

Add nodes to the swarm

Administer and maintain a swarm of Docker Engines

Alternative container runtimes

Amazon CloudWatch Logs logging driver

AppArmor security profiles for Docker

BTRFS storage driver

Binaries

Bind mounts

Bridge network driver

CA certificates

CentOS

Collect Docker metrics with Prometheus

Completion

Configure logging drivers

Configure remote access for Docker daemon

Create a swarm

Customize log driver output

Daemon

Daemon proxy configuration

Debian

Delete the service running on the swarm

Deploy Notary Server with Compose

Deploy a service to the swarm

Device Mapper storage driver (deprecated)

Docker contexts

Docker network driver plugins

Docker object labels

Docker with iptables

Docker with nftables

Drain a node on the swarm

ETW logging driver

Engine v17.03

Engine v17.06

Engine v17.09

Engine v18.01

Engine v18.05

Engine v18.06

Engine v19.03

Engine v25.0

Engine v29

Fedora

Filter commands

Fluentd logging driver

Format command and log output

GPU access

Google Cloud Logging driver

Host network driver

How nodes work

How services work

IPvlan network driver

Inspect a service on the swarm

Install

JSON File logging driver

Join nodes to a swarm

Legacy container links

Live restore

Lock your swarm to protect its encryption key

Logs and metrics

Macvlan network driver

Manage keys for content trust

Manage nodes in a swarm

Manage swarm security with public key infrastructure (PKI)

Manage swarm service networks

Network drivers

Networking

None network driver

OpenTelemetry for the Docker CLI

Overlay network driver

OverlayFS storage driver

Packet filtering and firewalls

Plugin Config Version 1 of Plugin V2

Port publishing and mapping

Post-installation steps

Prior releases

Protect the Docker daemon socket

Proxy configuration

Prune unused Docker objects

RHEL

Raspberry Pi OS (32-bit / armhf)

Read the daemon logs

Resource constraints

Rootless mode

Run multiple processes in a container

Running containers

Runtime metrics

SLES (s390x)

Select a storage driver

Splunk logging driver

Start containers automatically

Start the daemon

Storage

Storage drivers

Store configuration data using Docker Configs

Syslog logging driver

Tips

Troubleshooting

Troubleshooting the Docker daemon

Ubuntu

Use IPv6 networking

VFS storage driver

Verify repository client with certificates

Volumes

ZFS storage driver

containerd image store

tmpfs mounts

windowsfilter storage driver

Enterprise

Air-gapped containers

Configure advanced settings

Core roles

Deploy Docker Desktop

Deploy with Intune

Deploy with Jamf Pro

Desktop settings reporting

Enable ECI

Enforce sign-in

Enhanced Container Isolation

FAQs

General

Group mapping

Identity providers

Just-in-Time

Limitations

MS Store

MSI installer

Manage connections

Organization access tokens

PKG installer

Provision

Registry Access Management

SCIM

Security

Set up

Settings Management

Single sign-on

Troubleshoot provisioning

Use the Admin Console

Extensions

Add labels

CLI reference

Configure a private marketplace

Continuous Integration (CI)

Create a simple extension

Create an advanced frontend extension

Design and UI styling

Docker design principles

Guidelines

Marketplace extensions

Non-marketplace extensions

Package and release your extension

Part two: Publish

Quickstart

Settings and feedback

Share your extension

Test and debug

The build and publish process

Validate

Get Started

Build and push your first image

Build, tag, and publish an image

Building images

Develop with containers

Docker workshop

Educational resources

Get Docker

Get Docker Desktop

Introduction

Multi-container applications

Multi-stage builds

Overriding container defaults

Part 1: Containerize an application

Part 2: Update the application

Part 3: Share the application

Part 4: Persist the DB

Part 5: Use bind mounts

Part 6: Multi-container apps

Part 7: Use Docker Compose

Part 8: Image-building best practices

Part 9: What next

Persisting container data

Publishing and exposing ports

Sharing local files with containers

Understanding the image layers

Using the build cache

What is Docker Compose?

What is Docker?

What is a container?

What is a registry?

What is an image?

What's next

Writing a Dockerfile

Guides

ASP.NET Core testing

AWS LocalStack

AWS development with LocalStack

Admin set up

Advanced Configuration and Initialization

Agentic AI applications

Angular

Attestations

Automate your builds with GitHub Actions

Automate your builds with GitHub Actions

Azure Pipelines and Docker

Build an AI-powered code quality workflow

Build and run a C++ application using Docker Compose

Build images

Build images

Build workflow

Building Compose projects with Bake

Bun

C# (.NET)

C++

Common Questions on Using Laravel with Docker

Common challenges and questions

Common challenges and questions

Common challenges and questions

Communication and information gathering

Companions for PostgreSQL

Configure CI/CD

Configure CI/CD

Configure CI/CD

Configure CI/CD

Configure CI/CD

Configure CI/CD

Configure CI/CD

Configure CI/CD

Configure CI/CD

Configuring Testcontainers Cloud in the CI Pipeline

Connecting services with Docker Compose

Container lifecycle (Java)

Container-supported development

Containerize

Containerize

Containerize

Containerize

Containerize

Containerize your app

Containerize your app

Containerize your app

Containerize your app

Containerize your app

Containerize your app

Containerize your app

Containerize your app

Containerize your app

Containerize your app

Containerize your app

Containerize your app using a multi-stage build

Copy files

Create the project

Create the project

Create the project

Create the project

Create the project

Create the project

Create the project

Create the project

Create the project

Create the project

Create the project

Create the project

Create the project

Create the project

Create the project

Create the project

Create the project

Customize workflow

Data science with JupyterLab

Demo

Demo: Using Docker Build Cloud in CI

Demo: set up and use Docker Build Cloud in development

Demo: set up and use Docker Compose

Deno

Deploy your Docker setup

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Develop your app

Execute commands

Extension annotations

Finalize plans and begin setup

Generate Docker Compose Files with Claude Code and Docker MCP Toolkit

Guides

Immediate setup & data persistence

Instrumenting JS Apps with OpenTelemetry

JDBC URL approach

JUnit 5 extension

Java

Keycloak with Spring Boot

Lab: Building Agentic Apps

Lab: Container Image Attestations

Lab: Getting Started with Docker

Lab: Migrating to DHI (Node)

Lab: The Containerized SDLC

Language translation

Laravel Development Setup with Docker Compose

Laravel Production Setup with Docker Compose

Leveraging RAG in GenAI

Lifecycle callbacks

Linting and typing

Mastering Docker Buildx Bake

Mastering user and access management

Monitoring and insights

Networking and connectivity

Onboarding and managing roles and permissions in Docker

PDF analysis and chat

PostgreSQL

Pre-seeding database

Prerequisites for Setting Up Laravel with Docker Compose

R

ROS 2

Remediation

Run ROS 2

Run containers

Run containers

Run tests

Run tests

Run tests

Run tests

Run tests

Run tests

Run tests

Run tests

Run tests

Run tests

Run tests

Run tests

Run tests

Run tests

Run tests

Run your tests

Run your tests

Run your tests

Run your tests

Run your tests

Rust

Set Up ROS 2 workspace

Setting up Testcontainers Cloud by Docker

Setting up roles and permissions in Docker

Singleton containers

Software supply chain security

Test suites

Test your deployment

Test your deployment

Test your deployment

Test your deployment

Test your deployment

Testcontainers Cloud by Docker

Testcontainers for Java

Testcontainers for Node.js

Testing

Text classification

Text summarization

The H2 problem

Troubleshoot

Turtlesim example

Understand the application

Use Docker Hardened Images with Red Hat OpenShift

Use OpenCode with Docker Model Runner

Using Docker with Zscaler

Video transcription and chat

Visualizing your PostgreSQL databases with pgAdmin

Vue.js

Why Docker Build Cloud?

Why Docker Compose?

Why Docker Scout?

Why Testcontainers Cloud?

Write tests

Write tests

Write tests

Write tests

Write tests

Write tests

Write tests

Write tests

Write tests

Write tests

Write tests

Write tests

Write tests

Write tests

Write tests

Write tests

Offload

About

Configure

Optimize usage

Quickstart

Usage

Reference

.NET samples

404 Page not found

AI/ML samples

Agentic AI samples

Angular samples

Build checks

Changelog

Changelog

Cloudflared samples

Compose Deploy Specification

ConsistentInstructionCasing

Deprecated

Deprecated

Django samples

Dockerfile reference

ExposeProtoCasing

Extensions API

Flask samples

Fragments

FromPlatformFlagConstDisallowed

Include

Interface: BackendV0

Interface: DockerDesktopClient

Interface: ExecOptions

Interface: ExecResult

Interface: ExecStreamOptions

Interface: Extension

Interface: ExtensionHost

Interface: Host

Interface: HttpService

InvalidDefaultArgInFrom

InvalidDefinitionDescription

JavaScript samples

LegacyKeyValueFormat

Merge

Minecraft samples

Models

Networks

Nextcloud samples

Node.js samples

PHP samples

Pi-hole samples

Portainer samples

Profiles

Python samples

React samples

RedundantTargetPlatform

Registry authentication

Ruby samples

Rust samples

SDK

Samples

Services

UndefinedArgInFrom

Version and name top-level elements

Volumes

WireGuard samples

WorkdirRelativePath

docker

docker builder

docker builder prune

docker buildx

docker buildx bake

docker buildx build

docker buildx create

docker buildx dap

docker buildx dap build

docker buildx debug

docker buildx debug build

docker buildx dial-stdio

docker buildx du

docker buildx history

docker buildx history export

docker buildx history import

docker buildx history inspect

docker buildx history inspect attachment

docker buildx history logs

docker buildx history ls

docker buildx history open

docker buildx history rm

docker buildx history trace

docker buildx imagetools

docker buildx imagetools create

docker buildx imagetools inspect

docker buildx inspect

docker buildx ls

docker buildx policy

docker buildx policy eval

docker buildx policy test

docker buildx prune

docker buildx rm

docker buildx stop

docker buildx use

docker buildx version

docker checkpoint

docker checkpoint create

docker checkpoint ls

docker checkpoint rm

docker compose

docker compose alpha dry-run

docker compose alpha scale

docker compose alpha watch

docker compose attach

docker compose bridge

docker compose bridge convert

docker compose bridge transformations

docker compose bridge transformations create

docker compose bridge transformations list

docker compose build

docker compose commit

docker compose config

docker compose convert

docker compose cp

docker compose create

docker compose down

docker compose events

docker compose exec

docker compose export

docker compose images

docker compose kill

docker compose logs

docker compose pause

docker compose ps

docker compose push

docker compose restart

docker compose rm

docker compose run

docker compose stats

docker compose top

docker compose up

docker compose volumes

docker compose watch

docker config

docker config create

docker config ls

docker config rm

docker container

docker container attach

docker container commit

docker container cp

docker container create

docker container diff

docker container logs

docker container ls

docker container port

docker container prune

docker container restart

docker container rm

docker container run

docker container stop

docker container top

docker container unpause

docker context export

docker context inspect

docker context rm

docker desktop diagnose

docker desktop disable model-runner

docker desktop engine

docker desktop logs

docker desktop stop

docker desktop version

docker dhi

docker dhi catalog

docker dhi catalog list

docker dhi customization

docker dhi customization build

docker dhi customization build get

docker dhi customization build list

docker dhi customization build logs

docker dhi customization create

docker dhi customization prepare

docker image

docker image build

docker image history

docker image inspect

docker image load

docker image ls

docker image pull

docker image push

docker image rm

docker image tag

docker inspect

docker login

docker logout

docker manifest

docker manifest annotate

docker manifest create

docker manifest inspect

docker manifest push

docker mcp catalog list

docker mcp catalog ls

docker mcp catalog rm

docker mcp catalog server

docker mcp catalog server remove

docker mcp catalog show

docker mcp client connect

docker mcp client disconnect

docker mcp client ls

docker mcp feature

docker mcp feature disable

docker mcp feature enable

docker mcp profile

docker mcp profile create

docker mcp profile remove

docker mcp profile server

docker mcp secret

docker mcp server

docker mcp server init

docker mcp tools

docker mcp tools ls

docker mcp version

docker model

docker model bench

docker model inspect

docker model list

docker model package

docker model pull

docker model purge

docker model push

docker model reinstall-runner

docker model show

docker model start-runner

docker model status

docker model tag

docker model unload

docker network

docker network disconnect

docker network ls

docker node promote

docker node ps

docker offload diagnose

docker offload status

docker offload stop

docker pass

docker pass get

docker pass ls

docker pass rm

docker plugin

docker plugin disable

docker plugin enable

docker plugin install

docker plugin upgrade

docker sandbox

docker sandbox create copilot

docker sandbox create shell

docker sandbox network log

docker sandbox reset

docker sandbox save

docker sandbox version

docker scout

docker scout attestation

docker scout attestation add

docker scout attestation list

docker scout cache prune

docker scout cves

docker scout environment

docker scout help

docker scout integration

docker scout integration list

docker scout policy

docker scout push

docker scout repo disable

docker scout sbom

docker scout stream

docker scout version

docker scout vex get

docker search

docker secret inspect

docker secret rm

docker service rm

docker service scale

docker service update

docker stack

docker stack services

docker swarm

docker swarm init

docker swarm join

docker swarm join-token

docker swarm leave

docker swarm unlock

docker swarm unlock-key

docker system events

docker system info

docker trust

docker trust inspect

docker trust revoke

docker trust sign

docker version

docker volume

docker volume inspect

sbx

sbx completion

sbx completion bash

sbx completion zsh

sbx create

sbx create shell

sbx policy

sbx policy log

sbx policy reset

sbx policy rm

sbx policy set-default

sbx secret set

sbx stop

sbx version

Root

404 Page not found

Administration

Billing

Docker Build

Docker Build Cloud

Docker Compose

Docker Engine

Docker Hardened Images

Docker Hub

Docker Offload

Docker Scout

Docker accounts

Get started

Guides

Reference

Security

Support

Testcontainers

Testcontainers Cloud

Scout

Azure DevOps Pipelines

Configure policies

Create an exception using the GUI

Docker Scout environment variables

Docker Scout metrics exporter

Evaluate policy compliance in CI

GitHub

GitHub Actions

GitLab CI/CD

Install

Jenkins

Manage vulnerability exceptions

Quickstart

Remediation with Docker Scout

Security

Container

General

Network and VM

Personal access tokens

Recover your Docker account

Security announcements

Two-factor authentication

Subscription

Change your subscription

Compare subscription

Docker Desktop license agreement

FAQs

Manage seats

Scale your subscription

Set up your subscription

On this page

Fresh

Interface: ExecOptions

Back

Get started
Guides
Manuals

Interface: ExecOptions

Copy as Markdown

Open MarkdownAsk Docs AIClaudeOpen in Claude

Table of contents

Since

0.3.0

Hierarchy

ExecOptions

↳ SpawnOptions

Properties

cwd

• Optional cwd: string

env

• Optional env: ProcessEnv

Pager

Previous pageInterface: DockerDesktopClient

Next pageInterface: ExecResult