Toggle navigation
Guides
Product manuals
Glossary
Reference
Samples
Docker v18.09 (current)
Docker edge
Docker v18.03
Docker v17.12
Docker v17.09
Docker v17.06
Docker v17.03
docker-compose help
Estimated reading time:
1 minute
Usage: help COMMAND
Displays help and usage instructions for a command.
Rate this page:
7
63
i
Docker Enterprise Edition
About Docker EE
Try Docker EE on the cloud
Supported platforms
Deploy Docker EE standard
Backup Docker EE
Upgrade Docker EE
Docker EE Architecture
Manage usage data collection
Docker EE Engine
Install Docker EE Engine
Release notes
Universal Control Plane
Universal Control Plane overview
UCP Architecture
Administration
Install
System requirements
Plan your installation
Install
Install offline
Install on Azure
Upgrade
Upgrade offline
Uninstall
Architecture-specific images
Configure
Add labels to cluster nodes
Add SANs to cluster certificates
Collect UCP cluster metrics with Prometheus
Using UCP cluster metrics with Prometheus
Configure native Kubernetes role-based access control
Create UCP audit logs
Enable SAML authentication
Enable Helm and Tiller with UCP
Integrate with LDAP
License your installation
Restrict services to worker nodes
Run only the images you trust
Set the user's session timeout
UCP configuration file
Use a local node network in a swarm
Use your own TLS certificates
Manage and deploy private images
Set the orchestrator type for a node
View Kubernetes objects in a namespace
Join nodes to your cluster
Set up high availability
Join nodes to your cluster
Join Windows worker nodes to your cluster
Use a load balancer
Improve network performance with Route Reflectors
Monitor and troubleshoot
Monitor the cluster status
Troubleshoot node messages
Troubleshoot with logs
Troubleshoot configurations
Backups and disaster recovery
CLI reference
Authorize role-based access
Access control model overview
The basics
Create users and teams manually
Create teams with LDAP
Define roles with authorized API operations
Group and isolate cluster resources
Grant role-access to cluster resources
Reset user passwords
Tutorials and use cases
Deploy stateless app with RBAC
Isolate volumes
Isolate nodes
Allow users to pull images
Docker EE Standard use case
Docker EE Advanced use case
Access UCP
Web-based access
CLI-based access
Install the Kubernetes CLI
Deploy an application package
Deploy apps with Swarm
Deploy a single service
Deploy a multi-service app
Deploy application resources to a collection
Use secrets in your services
Layer 7 routing
Overview
Architecture
Deploy
Simple deployment
Production deployment
Offline installation
Layer 7 routing upgrade
Configuration
Configure your deployment
Using a custom extension template
Configuring an HAProxy extension
Configuring host mode networking
Configuring an nginx extension
Using application service labels
Tuning the proxy service
Updating Interlock services
Routing traffic to services
Deploying services
Publishing a service as a canary instance
Using context or path-based routing
Specifying a routing mode
Using routing labels
Implementing redirects
Implementing a service cluster
Implementing persistent (sticky) sessions
Implementing SSL
Securing services with TLS
Configuring websockets
Deploy apps with Kubernetes
Access Kubernetes Resources
Deploy a workload
Deploy a Compose-based app
Deploy an ingress controller
Create a service account for a Kubernetes app
Install a CNI plugin
Kubernetes network encryption
Persistent Storage
Use NFS storage
Use AWS EBS Storage
API reference
Release notes
Previous versions
Universal Control Plane 3.0
Universal Control Plane overview
Architecture
Administration
Install
System requirements
Plan your installation
Install
Install offline
Install on Azure
Upgrade
Upgrade offline
Uninstall
Architecture-specific images
Configure
Add labels to cluster nodes
Add SANs to cluster certificates
Join Windows worker nodes to a swarm
Integrate with Docker Trusted Registry
Integrate with LDAP
Integrate with LDAP by using a configuration file
License your installation
Restrict services to worker nodes
Run only the images you trust
Scale your cluster
Set the user's session timeout
Set up high availability
Store logs in an external system
UCP configuration file
Use a load balancer
Use a local node network in a swarm
Use domain names to access services
Use your own TLS certificates
Monitor and troubleshoot
Monitor the cluster status
Troubleshoot node messages
Troubleshoot with logs
Troubleshoot configurations
Backups and disaster recovery
CLI reference
docker/ucp overview
backup
dump-certs
example-config
id
images
install
restart
restore
stop
support
uninstall-ucp
upgrade
Access control
Access control model
Create and manage users
Create and manage teams
Deploy a service with view-only access across an organization
Grant permissions to users based on roles
Isolate swarm nodes to a specific team
Isolate volumes between two different teams
Manage access to resources by using collections
Node access control
Permission levels
Access control design with Docker EE Standard
Access control design with Docker EE Advanced
Recover a user password
User guides
Access UCP
Web-based access
CLI-based access
Install the Kubernetes CLI
Deploy apps with Swarm
Deploy a single service
Deploy a multi-service app
Deploy application resources to a collection
Use secrets in your services
Layer 7 routing
Overview
Architecture
Deploy
Simple deployment
Configure your deployment
Production deployment
Host mode networking
Configuration reference
Route traffic to services
Simple swarm service
Set a default service
Applications with TLS
Application redirects
Persistent (sticky) sessions
Websockets
Canary application instances
Service clusters
Context/Path based routing
Service labels reference
Layer 7 routing upgrade
Deploy apps with Kubernetes
Deploy a workload
Deploy a Compose-based app
Deploy an ingress controller
Create a service account for a Kubernetes app
Install a CNI plugin
API reference
Release notes
Get support
Universal Control Plane 2.2
Universal Control Plane overview
Architecture
Administration
Install
System requirements
Plan your installation
Install
Install offline
Upgrade
Upgrade offline
Uninstall
Architecture-specific images
Configure
Add labels to cluster nodes
Add SANs to cluster certificates
Join Windows worker nodes to a swarm
Integrate with Docker Trusted Registry
Integrate with LDAP
Integrate with LDAP by using a configuration file
License your installation
Restrict services to worker nodes
Run only the images you trust
Use trusted images for continuous integration
Scale your cluster
Set the user's session timeout
Set up high availability
Store logs in an external system
UCP configuration file
Use a load balancer
Use a local node network in a swarm
Use domain names to access services
Use your own TLS certificates
Monitor and troubleshoot
Monitor the cluster status
Troubleshoot node messages
Troubleshoot with logs
Troubleshoot configurations
Backups and disaster recovery
CLI reference
docker/ucp overview
backup
dump-certs
example-config
id
images
install
restart
restore
stop
support
uninstall-ucp
upgrade
Access control
Access control model
Create and manage users
Create and manage teams
Deploy a service with view-only access across an organization
Grant permissions to users based on roles
Isolate swarm nodes to a specific team
Isolate volumes between two different teams
Manage access to resources by using collections
Node access control
Permission levels
Access control design with Docker EE Standard
Access control design with Docker EE Advanced
Recover a user password
User guides
Access UCP
Web-based access
CLI-based access
Deploy an application
Deploy a service
Use domain names to access services
Deploy an app from the UI
Deploy an app from the CLI
Deploy application resources to a collection
Secrets
Manage secrets
Grant access to secrets
API reference
Release notes
Get support
Universal Control Plane 2.1
Universal Control Plane overview
Architecture
Administration
Install
System requirements
Plan your installation
Install
Install offline
Upgrade
Upgrade offline
Uninstall
Configure
License your installation
Scale your cluster
Set up high availability
Use a load balancer
Add labels to cluster nodes
Add SANs to cluster certificates
Store logs in an external system
Restrict services to worker nodes
Use domain names to access services
Run only the images you trust
Use trusted images for continuous integration
Integrate with Docker Trusted Registry
Integrate with LDAP
Use your own TLS certificates
Manage users
Authentication and authorization
Create and manage users
Create and manage teams
Permission levels
Recover a user password
Monitor and troubleshoot
Monitor the cluster status
Troubleshoot node messages
Troubleshoot with logs
Troubleshoot configurations
Backups and disaster recovery
CLI reference
docker/ucp overview
backup
dump-certs
fingerprint
id
images
install
restart
restore
stop
support
uninstall-ucp
upgrade
User guides
Access UCP
Web-based access
CLI-based access
Deploy an application
Deploy a service
Use domain names to access services
Deploy an app from the UI
Deploy an app from the CLI
Secrets
Manage secrets
Grant access to secrets
Release notes
Release notes
Incompatibilities and breaking changes
Get support
Universal Control Plane 2.0
Universal Control Plane overview
Architecture
Installation
System requirements
Plan a production installation
Install UCP for production
Install offline
License UCP
Scale your cluster
Upgrade UCP
Uninstall UCP
Access UCP
Web-based access
CLI-based access
Configuration
Use externally-signed certificates
Configure UCP logging
Integrate with Docker Trusted Registry
Integrate with LDAP
Route hostnames to services
Monitor and troubleshoot
Monitor your cluster
Troubleshoot your cluster
Troubleshoot cluster configurations
High-availability
Set up high availability
Backups and disaster recovery
User management
Authentication and authorization
Create and manage users
Create and manage teams
Permission levels
Applications
Deploy an app from the UI
Deploy an app from the CLI
Content trust
Run only images you trust
Manage trusted repositories
Use trusted images for continuous integration
CLI reference
docker/ucp overview
backup
dump-certs
fingerprint
id
images
install
restart
restore
stop
support
uninstall-ucp
upgrade
Get support
Release notes
Universal Control Plane 1.0
Universal Control Plane overview
Install DDC in a sandbox for evaluation
Evaluate DDC in a sandbox deployment
Architecture
Installation
System requirements
Plan a production installation
Install UCP for production
Install offline
License UCP
Upgrade UCP
Uninstall UCP
Access UCP
Web-based access
CLI-based access
Configuration
Use externally-signed certificates
Configure UCP logging
Integrate with Docker Trusted Registry
Integrate with LDAP
Set up container networking
Monitor and troubleshoot
Monitor your cluster
Troubleshoot your cluster
Troubleshoot cluster configurations
High-availability
Set up high availability
Replicate CAs for high availability
Backups and disaster recovery
User management
Authentication and authorization
Create and manage users
Create and manage teams
Permission levels
Applications
Deploy an app from the UI
Deploy an app from the CLI
UCP tool CLI
UCP tool v1.1 overview
backup
dump-certs
engine-discovery
fingerprint
help
id
images
install
join
regen-certs
restart
restore
stop
support
uninstall
upgrade
Get support
undefined
Docker Trusted Registry
Docker Trusted Registry overview
Architecture
Administration
Install
System requirements
Install
Install offline
Upgrade
Uninstall
Configure
License your installation
Use your own TLS certificates
Enable single sign-on
External storage
Overview
Switch storage backends
S3
NFS
Set up high availability
Use a load balancer
Set up vulnerability scans
Deploy caches
Cache overview
Cache deployment strategy
Deploy a DTR cache with Docker Swarm
Deploy a DTR cache with Kubernetes
Configure caches for high availability
Cache configuration reference
Garbage collection
Allow users to create repositories when pushing
Use a web proxy
Manage users
Authentication and authorization
Create and manage users
Create and manage teams
Create and manage organizations
Permission levels
Manage jobs
Job Queue
Audit Jobs with the Web Interface
Audit Jobs with the API
Enable Auto-Deletion of Job Logs
Monitor and troubleshoot
Monitor the cluster status
Check Notary audit logs
Troubleshoot Docker Trusted Registry
Disaster recovery
Overview
Repair a single replica
Repair a cluster
Create a backup
Restore from a backup
CLI reference
User guides
Access DTR
Configure your Docker daemon
Configure your Notary client
Use a cache
Manage images
Create a repository
Review repository info
Pull and push images
Delete images
Scan images for vulnerabilities
Override a vulnerability
Prevent tags from being overwritten
Sign images
Sign an image
Trust with a Remote UCP
Promotion policies and mirroring
Overview
Promote an image using policies
Mirror images to another registry
Mirror images from another registry
Template reference
Manage repository events
Audit repository events
Auto-delete repository events
Create and manage webhooks
Manage access tokens
Tag pruning
API reference
Release notes
Previous versions
Docker Trusted Registry 2.5
Docker Trusted Registry overview
Architecture
Administration
Install
System requirements
Install
Install offline
Upgrade
Uninstall
Configure
License your installation
Use your own TLS certificates
Enable single sign-on
External storage
Overview
S3
NFS
Set up high availability
Use a load balancer
Set up vulnerability scans
Deploy caches
Overview
Cache deployment strategy
Deploy a DTR cache
Configure caches for high availability
Cache configuration reference
Garbage collection
Use a web proxy
Manage users
Authentication and authorization
Create and manage users
Create and manage teams
Create and manage organizations
Permission levels
Monitor and troubleshoot
Monitor the cluster status
Check Notary audit logs
Troubleshoot Docker Trusted Registry
Troubleshoot batch jobs
Backups and disaster recovery
CLI reference
Overview
backup
destroy
images
install
join
reconfigure
remove
restore
upgrade
User guides
Access DTR
Configure your Docker daemon
Configure your Notary client
Use a cache
Manage images
Create a repository
Pull and push images
Delete images
Scan images for vulnerabilities
Prevent tags from being overwritten
Sign images
Sign an image
Delegate image signing
Manage trusted repositories
Create and manage webhooks
Create promotion policies
API reference
Release notes
Get support
Docker Trusted Registry 2.4
Docker Trusted Registry overview
Architecture
Administration
Install
System requirements
Install
Install offline
Upgrade
Uninstall
Configure
License your installation
Use your own TLS certificates
Enable single sign-on
External storage
Overview
S3
NFS
Set up high availability
Use a load balancer
Set up vulnerability scans
Deploy caches
Overview
Deploy caches with TLS
Chain multiple caches
Garbage collection
Use a web proxy
Manage users
Authentication and authorization
Create and manage users
Create and manage teams
Create and manage organizations
Permission levels
Monitor and troubleshoot
Monitor the cluster status
Check Notary audit logs
Troubleshoot with logs
Troubleshoot batch jobs
Backups and disaster recovery
CLI reference
Overview
backup
destroy
images
install
join
reconfigure
remove
restore
upgrade
User guides
Access DTR
Configure your Docker daemon
Configure your Notary client
Use a cache
Manage images
Create a repository
Pull and push images
Delete images
Scan images for vulnerabilities
Prevent tags from being overwritten
Sign images
Sign an image
Delegate image signing
Manage trusted repositories
Create and manage webhooks
Create promotion policies
API reference
Release notes
Get support
Docker Trusted Registry 2.3
Docker Trusted Registry overview
Architecture
Administration
Install
System requirements
Install
Install offline
Upgrade
Uninstall
Configure
License your installation
Use your own TLS certificates
Enable single sign-on
External storage
Overview
S3
NFS
Set up high availability
Use a load balancer
Set up vulnerability scans
Deploy caches
Overview
Deploy caches with TLS
Chain multiple caches
Garbage collection
Use a web proxy
Manage users
Authentication and authorization
Create and manage users
Create and manage teams
Create and manage organizations
Permission levels
Monitor and troubleshoot
Monitor the cluster status
Troubleshoot with logs
Troubleshoot batch jobs
Backups and disaster recovery
CLI reference
Overview
backup
destroy
dumpcerts
images
install
join
reconfigure
remove
restore
upgrade
User guides
Access DTR
Configure your Docker daemon
Configure your Notary client
Use a cache
Manage images
Create a repository
Pull and push images
Delete images
Scan images for vulnerabilities
Prevent tags from being overwritten
Sign images
Sign an image
Delegate image signing
Manage trusted repositories
Create and manage webhooks
Create promotion policies
API reference
Release notes
Get support
Docker Trusted Registry 2.2
Docker Trusted Registry overview
Architecture
Administration
Install
System requirements
Install
Install offline
Upgrade
Uninstall
Configure
License your installation
Use your own TLS certificates
External storage
Overview
S3
NFS
Set up high availability
Use a load balancer
Set up vulnerability scans
Deploy caches
Overview
Deploy caches with TLS
Chain multiple caches
Garbage collection
Manage users
Create and manage users
Create and manage users
Create and manage teams
Permission levels
Monitor and troubleshoot
Monitor the cluster status
Troubleshoot with logs
Troubleshoot batch jobs
Backups and disaster recovery
CLI reference
Overview
backup
destroy
dumpcerts
images
install
join
reconfigure
remove
restore
upgrade
User guides
Access DTR
Configure your Docker daemon
Configure your Notary client
Use a cache
Manage images
Create a repository
Pull and push images
Delete images
Scan images for vulnerabilities
Sign images
Sign an image
Delegate image signing
Manage trusted repositories
Create and manage webhooks
API reference
Release notes
Release notes
Incompatibilities and breaking changes
Get support
Docker Trusted Registry 2.1
Docker Trusted Registry overview
Architecture
Installation
System requirements
Install Docker Trusted Registry
Install offline
License your deployment
Scale your deployment
Upgrade
Uninstall
Configuration
Use your own certificates
Storage configuration
Use NFS
Monitor and troubleshoot
Monitor DTR
Troubleshoot DTR
High-availability
Set up high availability
Backups and disaster recovery
User management
Authentication and authorization
Create and manage users
Create and manage organizations
Create and manage teams
Permission levels
Repositories and images
Configure your Docker daemon
Pull an image
Push an image
Delete an image
API and CLI reference
API reference
CLI reference
Overview
backup
dumpcerts
images
install
join
reconfigure
remove
restore
upgrade
Release notes
Get support
Docker Trusted Registry 2.0
Docker Trusted Registry overview
Architecture
Installation
System requirements
Install Docker Trusted Registry
Install offline
License DTR
Upgrade
Upgrade from 1.4.3
Upgrade from 2.0.0
Uninstall
docker/dtr image reference
Overview
backup
dumpcerts
images
install
join
migrate
reconfigure
remove
restore
upgrade
Configuration
Configuration overview
Configure general settings
Security configuration
Storage configuration
Monitor and troubleshoot
Monitor DTR
Troubleshoot DTR
High-availability
Set up high availability
Backups and disaster recovery
User management
Authentication and authorization
Create and manage users
Create and manage organizations
Create and manage teams
Permission levels
Repositories and images
Configure your Docker daemon
Pull an image
Push an image
Delete an image
Release notes
Trusted Registry release notes
Prior Trusted Registry release notes
Trusted Registry API
API v2.0.1
API v2.0.0
API v1.4.0
API v1.3.3
Get support
Get support
Docker Compose
Overview of Docker Compose
Install Compose
Getting started
Compose (docker-compose) CLI reference
Overview of docker-compose CLI
CLI environment variables
Command-line completion
build
bundle
config
create
down
events
exec
help
kill
logs
pause
port
ps
pull
push
restart
rm
run
scale
start
stop
top
unpause
up
Compose file reference
Version 3
Version 2
Version 1
About versions and upgrading
Frequently asked questions
Docker stacks and distributed application bundles
Using Compose with Swarm
Environment file
Environment variables in Compose
Extend services in Compose
Networking in Compose
Using Compose in production
Link environment variables (deprecated)
Control startup order
Sample apps with Compose
Docker Compose release notes
Docker Desktop for Mac
Getting started
Install Docker Desktop for Mac
Deploy on Kubernetes
Docker Desktop for Mac vs. Docker Toolbox
Leveraging Multi-CPU architecture support
Networking
File system sharing
Performance tuning for volume mounts (shared filesystems)
Disk utilization
Logs and troubleshooting
FAQs
Open source licensing
Stable release notes
Edge release notes
Docker Desktop for Windows
Getting started
Install Docker Desktop for Windows
Deploy on Kubernetes
Networking
Migrate Docker Toolbox
Logs and troubleshooting
FAQs
Open source licensing
Stable release notes
Edge release notes
Docker ID accounts
Docker Machine
Machine overview
Install Machine
Get started with a local VM
Provision hosts in the cloud
Learn by example
Provision Digital Ocean Droplets
Provision AWS EC2 instances
Machine concepts and help
Machine (docker-machine) CLI
Machine CLI overview
Machine command-line completion
active
config
create
env
help
inspect
ip
kill
ls
mount
provision
regenerate-certs
restart
rm
scp
ssh
start
status
stop
upgrade
url
Machine drivers
Drivers overview
Driver options and operating system defaults
Amazon Web Services
Digital Ocean
Exoscale
Generic
Google Compute Engine
IBM Softlayer
Microsoft Azure
Microsoft Hyper-V
OpenStack
Oracle VirtualBox
Rackspace
VMware Fusion
VMware vCloud Air
VMware vSphere
Migrate from Boot2Docker to Machine
Docker Machine release notes
Docker Hub
Quickstart
Repositories
Official Images
Teams & Organizations
Webhooks
Slack Integration
Upgrading your plan
Automated Builds
Set up Automated builds
Testing in Automated Builds
Advanced Automated Builds
Link to GitHub and BitBucket
Classic Automated Builds
Publisher & Certified Content
Overview
User FAQs
Publisher FAQs
Certify Images & Plugins
Certify Logging Plugins
Trust Chain
Bring Your Own License (BYOL)
Open-source projects
Docker Notary
Getting started with Notary
Use the Notary client
Understand the service architecture
Running a Notary service
Notary changelog
Configuration files
Server configuration
Signer configuration
Client configuration
Common Server and signer configurations
Docker Registry
Registry overview
Understanding the Registry
Deploy a registry server
Configuring a registry
Working with notifications
Recipes
Recipes overview
Authenticating proxy with apache
Authenticating proxy with nginx
Mirroring Docker Hub
Running on macOS
Garbage collection
Testing an insecure registry
Deprecated features
Compatibility
Getting help
Registry reference
Registry HTTP API v2
Registry image manifests
Image manifest v 2, schema 1
Image manifest v 2, schema 2
Registry storage drivers
Storage driver overview
Aliyun OSS storage driver
Filesystem storage driver
GCS storage driver
In-memory storage driver
Microsoft Azure storage driver
S3 storage driver
Swift storage driver
Registry specifications
Docker Registry token authentication
Token authentication implementation
Oauth2 token authentication
Token scope documentation
Token authentication specification
Release notes
Overview
Docker EE and CE
CS Docker Engine
Docker (1.13 and earlier)
Docker Desktop for Mac
Docker Desktop for Windows
Docker Compose
Docker for AWS
Docker for Azure
Docker Machine release notes
Docker Swarm release notes
Superseded products and tools
Docker Swarm (standalone)
Swarm overview
How to get Swarm
Evaluate Swarm in a sandbox
Plan for Swarm in production
Build a Swarm cluster for production
Try Swarm at scale
Learn the application architecture
Deploy application infrastructure
Deploy the application
Troubleshoot the application
High availability in Swarm
Swarm and container networks
Discovery
Provision with Machine
Scheduling
Filters
Rescheduling
Strategies
Overview Docker Swarm with TLS
Configure Docker Swarm for TLS
Command line reference
create
help
join
list
manage
swarm
API response codes
Docker Swarm API
Docker Swarm release notes
Edit this page
Request docs changes
Get support