description

keywords

redirect_from

title

toc_max

toc_min

Getting Started

windows, edge, tutorial

/winkit/getting-started/

/winkit/

/windows/

/windows/started/

/docker-for-windows/started/

/installation/windows/

/engine/installation/windows/

/docker-for-windows/index/

Get started with Docker for Windows

4

1

Welcome to Docker for Windows!

Docker is a full development platform for creating containerized apps, and Docker for Windows is the best way to get started with Docker on Windows systems.

Got Docker for Windows? If you have not yet installed Docker for Windows, see Install Docker for Windows for an explanation of stable and edge channels, system requirements, and download/install information.

Looking for system requirements? Check out What to know before you install, which has moved to the new install topic. {: id="what-to-know-before-you-install" }

Check versions of Docker Engine, Compose, and Machine

Start your favorite shell (cmd.exe, PowerShell, or other) to check your versions of docker and docker-compose, and verify the installation.

PS C:\Users\Docker> docker --version
Docker version 17.03.0-ce, build 60ccb22

PS C:\Users\Docker> docker-compose --version
docker-compose version 1.11.2, build dfed245

PS C:\Users\Docker> docker-machine --version
docker-machine version 0.10.0, build 76ed2a6

Explore the application and run examples

The next few steps take you through some examples. These are just suggestions for ways to experiment with Docker on your system, check version information, and make sure docker commands are working properly.

Quote syntax

Remember to use double quotes (") instead of single quotes (') when specifying parameters in docker commands while using CMD/Powershell. {: .important}

Open a shell (cmd.exe, PowerShell, or other).

Run some Docker commands, such as docker ps, docker version, and docker info.

Here is the output of docker ps run in a powershell. (In this example, no containers are running yet.)

PS C:\Users\jdoe> docker ps

CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS               NAMES

Here is an example of command output for docker version.

PS C:\Users\Docker> docker version
Client:
Version:      17.03.0-ce
API version:  1.26
Go version:   go1.7.5
Git commit:   60ccb22
Built:        Thu Feb 23 10:40:59 2017
OS/Arch:      windows/amd64

Server:
Version:      17.03.0-ce
API version:  1.26 (minimum version 1.12)
Go version:   go1.7.5
Git commit:   3a232c8
Built:        Tue Feb 28 07:52:04 2017
OS/Arch:      linux/amd64
Experimental: true

Here is an example of command output for docker info.

PS C:\Users\Docker> docker info
Containers: 0
 Running: 0
 Paused: 0
 Stopped: 0
Images: 0
Server Version: 17.03.0-ce
Storage Driver: overlay2
 Backing Filesystem: extfs
 Supports d_type: true
 Native Overlay Diff: true
Logging Driver: json-file
Cgroup Driver: cgroupfs
Plugins:
 Volume: local
 Network: bridge host ipvlan macvlan null overlay
Swarm: inactive
Runtimes: runc
Default Runtime: runc
Init Binary: docker-init
containerd version: 977c511eda0925a723debdc94d09459af49d082a
runc version: a01dafd48bc1c7cc12bdb01206f9fea7dd6feb70
init version: 949e6fa
Security Options:
 seccomp
  Profile: default
Kernel Version: 4.9.12-moby
Operating System: Alpine Linux v3.5
OSType: linux
Architecture: x86_64
CPUs: 2
Total Memory: 1.934 GiB
Name: moby
ID: BM4O:645U:LUS6:OGMD:O6WH:JINS:K7VF:OVDZ:7NE4:ZVJT:PSMQ:5UA6
Docker Root Dir: /var/lib/docker
Debug Mode (client): false
Debug Mode (server): true
 File Descriptors: 13
 Goroutines: 21
 System Time: 2017-03-02T16:59:13.417299Z
 EventsListeners: 0
Registry: https://index.docker.io/v1/
Experimental: true
Insecure Registries:
 127.0.0.0/8
Live Restore Enabled: false

Note: The outputs above are examples. Your output for commands like docker version and docker info varies depending on your product versions.

Run docker run hello-world to test pulling an image from Docker Hub and starting a container.

PS C:\Users\jdoe> docker run hello-world

Hello from Docker.
This message shows that your installation appears to be working correctly.

To generate this message, Docker took the following steps:
1. The Docker client contacted the Docker daemon.
2. The Docker daemon pulled the "hello-world" image from the Docker Hub.
3. The Docker daemon created a new container from that image which runs the executable that produces the output you are currently reading.
4. The Docker daemon streamed that output to the Docker client, which sent it to your terminal.

Try something more ambitious, and run an Ubuntu container with this command.

PS C:\Users\jdoe> docker run -it ubuntu bash

This downloads the ubuntu container image and start it. Here is the output of running this command in a powershell.

PS C:\Users\jdoe> docker run -it ubuntu bash

Unable to find image 'ubuntu:latest' locally
latest: Pulling from library/ubuntu
5a132a7e7af1: Pull complete
fd2731e4c50c: Pull complete
28a2f68d1120: Pull complete
a3ed95caeb02: Pull complete
Digest: sha256:4e85ebe01d056b43955250bbac22bdb8734271122e3c78d21e55ee235fc6802d
Status: Downloaded newer image for ubuntu:latest

Type exit to stop the container and close the powershell.

Start a Dockerized webserver with this command:

PS C:\Users\jdoe> docker run -d -p 80:80 --name webserver nginx

This downloads the nginx container image and start it. Here is the output of running this command in a powershell.

PS C:\Users\jdoe> docker run -d -p 80:80 --name webserver nginx

Unable to find image 'nginx:latest' locally
latest: Pulling from library/nginx

fdd5d7827f33: Pull complete
a3ed95caeb02: Pull complete
716f7a5f3082: Pull complete
7b10f03a0309: Pull complete
Digest: sha256:f6a001272d5d324c4c9f3f183e1b69e9e0ff12debeb7a092730d638c33e0de3e
Status: Downloaded newer image for nginx:latest
dfe13c68b3b86f01951af617df02be4897184cbf7a8b4d5caf1c3c5bd3fc267f

Point your web browser at http://localhost to display the start page.

(Since you specified the default HTTP port, it isn't necessary to append :80 at the end of the URL.)

Run docker ps while your webserver is running to see details on the container.

PS C:\Users\jdoe> docker ps

CONTAINER ID        IMAGE               COMMAND                  CREATED             STATUS              PORTS
NAMES
dfe13c68b3b8        nginx               "nginx -g 'daemon off"   3 days ago          Up 45 seconds       0.0.0.0:80->80/tcp, 443/tc
p   webserver

Stop or remove containers and images.

The nginx webserver continues to run in the container on that port until you stop and/or remove the container. If you want to stop the webserver, type: docker container stop webserver and start it again with docker start webserver.

To stop and remove the running container with a single command, type: docker container rm -f webserver. This removes the container, but not the nginx image. You can list local images with docker image ls. You might want to keep some images around so that you don't need to pull them again from Docker Hub. To remove an image you no longer need, use docker image rm followed by an image ID or image name. For example, docker image rm nginx.

Want more example applications? Get Started and Samples are great places to start.

Set up tab completion in PowerShell

If you would like to have handy tab completion for Docker commands, you can install the posh-docker PowerShell Module as follows.

Prerequisite Notes

Depending on your setup, you might need the NuGet package manager{: target="blank" class="" } so you might get a prompt to install it.

Make sure you have administrator permissions to run an elevated PowerShell.

Start an "elevated" PowerShell, running as an administrator.

To do this, search for PowerShell, right-click, and choose Run as administrator.

When asked if you want to allow this app to make changes to your device, click Yes.
Set the script execution policy to allow downloaded scripts signed by trusted publishers to run on your computer. To do so, type this at the PowerShell prompt.
```
Set-ExecutionPolicy RemoteSigned
```
To check that the policy is set properly, run get-executionpolicy, which should return RemoteSigned.
To install the posh-docker PowerShell module for auto-completion of Docker commands, type:
```
Install-Module posh-docker
```
Or, to install the module for the current user only, type:
```
Install-Module -Scope CurrentUser posh-docker
```
After installation to enable autocompletion for the current PowerShell only, type:
```
Import-Module posh-docker
```
To make tab completion persistent across all PowerShell sessions, add the command to a $PROFILE by typing these commands at the PowerShell prompt.
```
if (-Not (Test-Path $PROFILE)) {
    New-Item $PROFILE –Type File –Force
}

Add-Content $PROFILE "`nImport-Module posh-docker"
```
This creates a $PROFILE if one does not already exist, and adds this line into the file:
```
Import-Module posh-docker
```
To check that the file was properly created, or simply edit it manually, type this in PowerShell:
```
Notepad $PROFILE
```

Open a new PowerShell session. Now, when you press tab after typing the first few letters, Docker commands such as start, stop, run, and their options, along with container and image names should now auto-complete.

Docker Settings

When Docker is running, the Docker whale is displayed. By default, the Docker whale icon is placed in the Notifications area. If it is hidden, click the up arrow on the taskbar to show it.

You can dock the whale on the taskbar so it is always visible

You can pin the whale outside of the notification box so that it is always visible on the taskbar. To do this, drag-and-drop the whale icon. Or, right-click an empty portion of the taskbar, select Settings, and choose display options through taskbar settings for notifications.

To get a popup menu with application options, right-click the whale:

Note: The above example shows a user signed in for integrated Docker Cloud access. To learn more about the feature, see Docker Cloud.

The Settings dialogs provide options to allow Docker auto-start, automatically check for updates, share local drives with Docker containers, enable VPN compatibility, manage CPUs and memory Docker uses, restart Docker, or perform a factory reset.

General

Start Docker when you log in - Automatically start the Docker for Windows application upon Windows system login.
Check for updates when the application starts - Docker for Windows is set to automatically check for updates and notify you when an update is available. If an update is found, click OK to accept and install it (or cancel to keep the current version). Uncheck this option if you do not want notifications of version upgrades. You can still find out about updates manually by choosing Check for Updates from the menu.
Send usage statistics - You can set Docker for Windows to auto-send diagnostics, crash reports, and usage data. This information can help Docker improve the application and get more context for troubleshooting problems.

Uncheck any of the options to opt out and prevent auto-send of data. Docker may prompt for more information in some cases, even with auto-send enabled.

Shared Drives

Share your local drives (volumes) with Docker for Windows, so that they are available to your containers.

You are prompted for your Windows system username and password (domain user) to apply shared drives. You can select an option to have Docker store the credentials so that you don't need to re-enter them every time.

Permissions to access shared drives are tied to the credentials you provide here. If you run docker commands and tasks under a different username than the one used here to set up sharing, your containers do not have permissions to access the mounted volumes.

Tips on shared drives, permissions, and volume mounts

Shared drives are only required for mounting volumes in Linux containers, not for Windows containers. For Linux containers, you need to share the drive where the Dockerfile and volume are located. If you get errors such as file not found or cannot start service you may need to enable shared drives. See Volume mounting requires shared drives for Linux containers.)

If possible, avoid volume mounts from the Windows host, and instead mount on the MobyVM, or use a data volume (named volume) or data container. There are a number of issues with using host-mounted volumes and network paths for database files. see the troubleshooting topic on Volume mounts from host paths use a nobrl option to override database locking.

You cannot control (chmod) permissions on shared volumes for deployed containers. Docker for Windows sets permissions to a default value of 0755 (read, write, execute permissions for user, read and execute for group). This is not configurable. See the troubleshooting topic Permissions errors on data directories for shared volumes for workarounds and more detail.

Make sure that the domain user has permissions to shared drives, as described in the troubleshooting topic (Verify domain user has permissions for shared drives).

You can share local drives with your containers but not with Docker Machine nodes. See Can I share local drives and filesystem with my Docker Machine VMs? in the FAQs.

Firewall rules for shared drives

Shared drives require port 445 to be open between the host machine and the virtual machine that runs Linux containers.

Note: Docker detects if port 445 is closed and shows the following message when you try to add a shared drive:

To share the drive, allow connections between the Windows host machine and the virtual machine in Windows Firewall or your third party firewall software. You do not need to open port 445 on any other network. By default, allow connections to 10.0.75.1 port 445 (the Windows host) from 10.0.75.2 (the virtual machine). If the firewall rules appear to be open, consider reinstalling the File and Print Sharing service on the virtual network adapter.

Shared drives on demand

You can share a drive "on demand" the first time a particular mount is requested.

If you run a Docker command from a shell with a volume mount (as shown in the example below) or kick off a Compose file that includes volume mounts, you get a popup asking if you want to share the specified drive.

You can select to Share it, in which case it is added your Docker for Windows Shared Drives list and available to containers. Alternatively, you can opt not to share it by hitting Cancel.

Advanced

CPUs - Change the number of processors assigned to the Linux VM.
Memory - Change the amount of memory the Docker for Windows Linux VM uses.

After you change these settings, the Linux VM restarts. This takes a few seconds.

Network

You can configure Docker for Windows networking to work on a virtual private network (VPN).

Internal Virtual Switch - You can specify a network address translation (NAT) prefix and subnet mask to enable internet connectivity.
DNS Server - You can configure the DNS server to use dynamic or static IP addressing.

Note: Some users reported problems connecting to Docker Hub on Docker for Windows stable version. This would manifest as an error when trying to run docker commands that pull images from Docker Hub that are not already downloaded, such as a first time run of docker run hello-world. If you encounter this, reset the DNS server to use the Google DNS fixed address: 8.8.8.8. For more information, see Networking issues in Troubleshooting.

Updating these settings requires a reconfiguration and reboot of the Linux VM.

Proxies

Docker for Windows lets you configure HTTP/HTTPS Proxy Settings and automatically propagate these to Docker and to your containers. For example, if you set your proxy settings to http://proxy.example.com, Docker uses this proxy when pulling containers.

When you start a container, your proxy settings propagate into the containers. For example:

PS C:\Users\jdoe> docker run alpine env
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
HOSTNAME=b7edf988b2b5
TERM=xterm
HOME=/root
HTTP_PROXY=http://proxy.example.com:3128
http_proxy=http://proxy.example.com:3128
no_proxy=*.local, 169.254/16

You can see from the above output that the HTTP_PROXY, http_proxy, and no_proxy environment variables are set. When your proxy configuration changes, Docker restarts automatically to pick up the new settings. If you have containers that you wish to keep running across restarts, you should consider using restart policies.

### Docker daemon

You can configure options on the Docker daemon that determine how your containers run. You can configure some Basic options on the daemon with interactive settings, or switch to Advanced to edit the JSON directly.

The settings offered on Basic dialog can be configured directly in the JSON as well. This version just surfaces some of the common settings to make it easier to configure them.

Experimental mode
Custom registries
Edit the daemon configuration file

Experimental mode

Both Docker for Windows Stable and Edge releases have the experimental version of Docker Engine enabled, described in the Docker Experimental Features README on GitHub.

Experimental features are not appropriate for production environments or workloads. They are meant to be sandbox experiments for new ideas. Some experimental features may become incorporated into upcoming stable releases, but others may be modified or pulled from subsequent Edge releases, and never released on Stable.

On both Edge and Stable releases, you can toggle experimental mode on and off. If you toggle it off, Docker for Windows uses the current generally available release of Docker Engine.

You can check whether you are running experimental mode or not by typing docker version in a PowerShell. Experimental mode is listed under Server data. If Experimental is true, then Docker is running in experimental mode, as shown here. (If false, Experimental mode is off.)

PS C:\Users\Vicky> docker version
Client:
 Version:      1.13.0-rc4
 API version:  1.25
 Go version:   go1.7.3
 Git commit:   88862e7
 Built:        Sat Dec 17 01:34:17 2016
 OS/Arch:      windows/amd64

Server:
 Version:      1.13.0-rc4
 API version:  1.25 (minimum version 1.12)
 Go version:   go1.7.3
 Git commit:   88862e7
 Built:        Sat Dec 17 01:34:17 2016
 OS/Arch:      linux/amd64
 Experimental: true

Custom registries

You can set up your own registries on the Basic Daemon settings.

As an alternative to using Docker Hub to store your public or private images or Docker Trusted Registry, you can use Docker to set up your own insecure registry. Add URLs for insecure registries and registry mirrors on which to host your images. (See also, How do I add custom CA certificates? and How do I add client certificates? in the FAQs.)

Edit the daemon configuration file

The Advanced daemon settings provide the original option to directly edit the JSON configuration file for the daemon.

For a full list of options on the Docker daemon, see daemon in the Docker Engine command line reference.

In that topic, see also:

Daemon configuration file
Linux configuration file
Windows configuration file

Updating these settings requires a reconfiguration and reboot of the Linux VM.

Switch between Windows and Linux containers

You can select which daemon (Linux or Windows) the Docker CLI talks to. Select Switch to Windows containers to toggle to Windows containers. Select Switch to Linux containers to toggle back to the default, Linux containers.

Microsoft Developer Network has preliminary/draft information on Windows containers here.

For a full list of options on the Docker daemon, see daemon in the Docker Engine command line reference.

In that topic, see also:

Daemon configuration file
Linux configuration file
Windows configuration file

Getting started with Windows containers

If you are interested in working with Windows containers, here are some guides to help you get started.

Build and Run Your First Windows Server Container (Blog Post) gives a quick tour of how to build and run native Docker Windows containers on Windows 10 and Windows Server 2016 evaluation releases.
Getting Started with Windows Containers (Lab) shows you how to use the MusicStore application with Windows containers. The MusicStore is a standard .NET application and, forked here to use containers, is a good example of a multi-container application.

Disclaimer: This lab is still under development, and is adapted from a blog post. Check back as the lab evolves.
This troubleshooting issue is useful for understanding how to connect to Windows containers from the local host: Limitations of Windows containers for localhost and published ports

About the Docker Windows containers specific dialogs

When you switch to Windows containers, the Settings panel updates to show only those dialogs that are active and apply to your Windows containers:

General
Proxies
Docker daemon
Diagnose and Feedback
Reset

Keep in mind that if you set proxies or daemon configuration in Windows containers mode, these apply only on Windows containers. If you switch back to Linux containers, proxies and daemon configurations return to what you had set for Linux containers. Your Windows container settings are retained and become available again when you switch back.

The following settings are not available in Windows containers mode, because they do not apply to Windows containers:

Shared Drives
Network
Advanced (CPU and Memory configuration)

Docker Store

Choose Docker Store from the Docker for Windows menu to get to the Docker app downloads site. Docker store is a component of the next-generation Docker Hub, and the best place to find compliant, trusted commercial and free software distributed as Docker Images.

Docker Cloud

You can access your Docker Cloud account from within Docker for Windows.

From the Docker for Windows menu, sign in to Docker Cloud with your Docker ID, or create one.

Then use the Docker for Windows menu to create, view, or navigate directly to your Cloud resources, including organizations, repositories, and swarms.

Check out these Docker Cloud topics to learn more:

Organizations and Teams in Docker Cloud
Builds and Images
Swarms in Docker Cloud

Need a direct link to Cloud? Take me to Docker Cloud{: target="blank" class="" }.

Kubernetes

Kubernetes is only available in Docker for Windows 18.02 CE Edge. Kubernetes support is not included in Docker for Windows 18.02 CE Stable.

To find out more about Stable and Edge channels and how to switch between them, see General configuration.

Docker for Windows 18.02 CE Edge includes a standalone Kubernetes server that runs on your Windows host, so that you can test deploying your Docker workloads on Kubernetes.

The Kubernetes client command, kubectl, is included and configured to connect to the local Kubernetes server. If you have kubectl already installed and pointing to some other environment, such as minikube or a GKE cluster, be sure to change context so that kubectl is pointing to docker-for-desktop:

kubectl config get-contexts
kubectl config use-context docker-for-desktop

If you installed kubectl by another method, and experience conflicts, remove it.

To enable Kubernetes support and install a standalone instance of Kubernetes running as a Docker container, select Enable Kubernetes and click the Apply and restart button.

An internet connection is required. Images required to run the Kubernetes server are downloaded and instantiated as containers, and the C:\>Program Files\Docker\Docker\Resources\bin\kubectl.exe command is installed.

When Kubernetes is enabled and running, an additional status bar item displays at the bottom left of the Docker for Windows Preferences dialog.
By default, Kubernetes containers are hidden from commands like docker service ls, because managing them manually is not supported. To make them visible, select Show system containers (advanced) and click Apply and restart. Most users do not need this option.
To disable Kubernetes support at any time, deselect Enable Kubernetes. The Kubernetes containers are stopped and removed, and the /usr/local/bin/kubectl command is removed.

For more about using the Kubernetes integration with Docker for Windows, see Deploy to Kubernetes.

Giving feedback and getting help

To get help from the community, review current user topics, join or start a discussion, log on to our Docker for Windows forum.

To report bugs or problems, log on to Docker for Windows issues on GitHub, where you can review community reported issues, and file new ones. As a part of reporting issues on GitHub, we can help you troubleshoot the log data. See the Diagnose and Feedback topic below.

To give feedback on the documentation or update it yourself, use the Feedback options at the bottom of each docs page.

Diagnose and Feedback

If you encounter problems for which you do not find solutions in this documentation, searching Docker for Windows issues on GitHub already filed by other users, or on the Docker for Windows forum, we can help you troubleshoot the log data.

Select Upload a diagnostic.

This uploads (sends) the logs to Docker.

To create a new issue directly on GitHub, open Docker for Windows issues on GitHub in your web browser and follow the instructions in the README. Click New Issue on that page to get a "create new issue" template prepopulated with sections for the ID and summary of your diagnostics, system and version details, description of expected and actual behavior, and steps to reproduce the issue.

Reset

Restart Docker - Shuts down and restarts the Docker application.
Reset to Toolbox default machine content - Imports containers and images from the existing Docker Toolbox machine named default. (This option is enabled only if you have Toolbox installed.) The VirtualBox VM is not removed.
Reset to factory defaults - Resets Docker to factory defaults. This is useful in cases where Docker stops working or becomes unresponsive.

Adding TLS certificates

You can add trusted Certificate Authorities (CAs) (used to verify registry server certificates) and client certificates (used to authenticate to registries) to your Docker daemon.

To learn more, see How do I add custom CA certificates? and How do I add client certificates? in the FAQs.

Where to go next

Try out the walkthrough at Get Started.
Dig in deeper with Docker Labs example walkthroughs and source code.
For a summary of Docker command line interface (CLI) commands, see the Docker CLI Reference Guide.
Check out the blog post Introducing Docker 1.13.0.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

index.md

index.md

Check versions of Docker Engine, Compose, and Machine

Explore the application and run examples

Set up tab completion in PowerShell

Docker Settings

General

Shared Drives

Firewall rules for shared drives

Shared drives on demand

Advanced

Network

Proxies

Experimental mode

Custom registries

Edit the daemon configuration file

Switch between Windows and Linux containers

Getting started with Windows containers

About the Docker Windows containers specific dialogs

Docker Store

Docker Cloud

Kubernetes

Giving feedback and getting help

Diagnose and Feedback

Reset

Adding TLS certificates

Where to go next

Files

index.md

Latest commit

History

index.md

File metadata and controls

Check versions of Docker Engine, Compose, and Machine

Explore the application and run examples

Set up tab completion in PowerShell

Docker Settings

General

Shared Drives

Firewall rules for shared drives

Shared drives on demand

Advanced

Network

Proxies

Experimental mode

Custom registries

Edit the daemon configuration file

Switch between Windows and Linux containers

Getting started with Windows containers

About the Docker Windows containers specific dialogs

Docker Store

Docker Cloud

Kubernetes

Giving feedback and getting help

Diagnose and Feedback

Reset

Adding TLS certificates

Where to go next