mirror of https://github.com/docker/docs.git
merge dashboard and user manual (#15145)
* merge dashboard and user manual * fix broken links * fix broken links * fix broken links * updates * fixes
This commit is contained in:
Allie Sadler
GitHub
parent
5a3f44e176
commit
ab0dee78a2
|
|
@ -1155,10 +1155,18 @@ manuals:
|
|||
title: Install on Ubuntu
|
||||
- path: /desktop/install/archlinux/
|
||||
title: Install on Arch
|
||||
- path: /desktop/get-started/
|
||||
title: Quick Start Guide and sign in
|
||||
- sectiontitle: Explore Docker Desktop
|
||||
section:
|
||||
- path: /desktop/use-desktop/container/
|
||||
title: Explore Containers
|
||||
- path: /desktop/use-desktop/images/
|
||||
title: Explore Images
|
||||
- path: /desktop/use-desktop/volumes/
|
||||
title: Explore Volumes
|
||||
- sectiontitle: Mac
|
||||
section:
|
||||
- path: /desktop/mac/
|
||||
title: User manual
|
||||
- path: /desktop/mac/troubleshoot/
|
||||
title: Logs and troubleshooting
|
||||
- path: /desktop/mac/apple-silicon/
|
||||
|
|
@ -1167,20 +1175,14 @@ manuals:
|
|||
title: Privileged Helper
|
||||
- sectiontitle: Windows
|
||||
section:
|
||||
- path: /desktop/windows/
|
||||
title: User manual
|
||||
- path: /desktop/windows/troubleshoot/
|
||||
title: Logs and troubleshooting
|
||||
- path: /desktop/windows/wsl/
|
||||
title: Docker Desktop WSL 2 backend
|
||||
- sectiontitle: Linux
|
||||
section:
|
||||
- path: /desktop/linux/
|
||||
title: User manual
|
||||
- path: /desktop/linux/troubleshoot/
|
||||
title: Logs and troubleshooting
|
||||
- path: /desktop/dashboard/
|
||||
title: Dashboard
|
||||
title: Logs and troubleshooting
|
||||
- sectiontitle: Change settings
|
||||
section:
|
||||
- path: /desktop/settings/mac/
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ cannot access features that require an active internet
|
|||
connection. Additionally, any functionality that requires you to sign won't work while using Docker Desktop offline or in air-gapped environments.
|
||||
This includes:
|
||||
|
||||
- The in-app [Quick Start Guide](../install/mac-install.md#quick-start-guide)
|
||||
- The in-app [Quick Start Guide](../get-started.md#quick-start-guide)
|
||||
- Pulling or pushing an image to Docker Hub
|
||||
- [Image Access Management](../../docker-hub/image-access-management.md)
|
||||
- [Vulnerability scanning](../../docker-hub/vulnerability-scanning.md)
|
||||
|
|
|
|||
|
|
@ -118,3 +118,167 @@ To reduce the maximum size of the disk image file:
|
|||
|
||||
When you reduce the maximum size, the current disk image file is deleted, and therefore, all containers and images will be lost.
|
||||
|
||||
### How do I add 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.
|
||||
|
||||
#### Add custom CA certificates (server side)
|
||||
|
||||
All trusted CAs (root or intermediate) are supported. Docker Desktop creates a
|
||||
certificate bundle of all user-trusted CAs based on the Mac Keychain, and
|
||||
appends it to Moby trusted certificates. So if an enterprise SSL certificate is
|
||||
trusted by the user on the host, it is trusted by Docker Desktop.
|
||||
|
||||
To manually add a custom, self-signed certificate, start by adding the
|
||||
certificate to the macOS keychain, which is picked up by Docker Desktop. Here is
|
||||
an example:
|
||||
|
||||
```console
|
||||
$ sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain ca.crt
|
||||
```
|
||||
|
||||
Or, if you prefer to add the certificate to your own local keychain only (rather
|
||||
than for all users), run this command instead:
|
||||
|
||||
```console
|
||||
$ security add-trusted-cert -d -r trustRoot -k ~/Library/Keychains/login.keychain ca.crt
|
||||
```
|
||||
|
||||
See also, [Directory structures for
|
||||
certificates](#directory-structures-for-certificates).
|
||||
|
||||
> **Note**: You need to restart Docker Desktop after making any changes to the
|
||||
> keychain or to the `~/.docker/certs.d` directory in order for the changes to
|
||||
> take effect.
|
||||
For a complete explanation of how to do this, see the blog post [Adding
|
||||
Self-signed Registry Certs to Docker & Docker Desktop for
|
||||
Mac](https://blog.container-solutions.com/adding-self-signed-registry-certs-docker-mac){:target="_blank" rel="noopener" class="_"}.
|
||||
|
||||
#### Add client certificates
|
||||
|
||||
You can put your client certificates in
|
||||
`~/.docker/certs.d/<MyRegistry>:<Port>/client.cert` and
|
||||
`~/.docker/certs.d/<MyRegistry>:<Port>/client.key`.
|
||||
|
||||
When the Docker Desktop application starts, it copies the `~/.docker/certs.d`
|
||||
folder on your Mac to the `/etc/docker/certs.d` directory on Moby (the Docker
|
||||
Desktop `xhyve` virtual machine).
|
||||
|
||||
> * You need to restart Docker Desktop after making any changes to the keychain
|
||||
> or to the `~/.docker/certs.d` directory in order for the changes to take
|
||||
> effect.
|
||||
>
|
||||
> * The registry cannot be listed as an _insecure registry_. Docker Desktop ignores certificates listed
|
||||
> under insecure registries, and does not send client certificates. Commands
|
||||
> like `docker run` that attempt to pull from the registry produce error
|
||||
> messages on the command line, as well as on the registry.
|
||||
#### Directory structures for certificates
|
||||
|
||||
If you have this directory structure, you do not need to manually add the CA
|
||||
certificate to your Mac OS system login:
|
||||
|
||||
```
|
||||
/Users/<user>/.docker/certs.d/
|
||||
└── <MyRegistry>:<Port>
|
||||
├── ca.crt
|
||||
├── client.cert
|
||||
└── client.key
|
||||
```
|
||||
|
||||
The following further illustrates and explains a configuration with custom
|
||||
certificates:
|
||||
|
||||
```
|
||||
/etc/docker/certs.d/ <-- Certificate directory
|
||||
└── localhost:5000 <-- Hostname:port
|
||||
├── client.cert <-- Client certificate
|
||||
├── client.key <-- Client key
|
||||
└── ca.crt <-- Certificate authority that signed
|
||||
the registry certificate
|
||||
```
|
||||
|
||||
You can also have this directory structure, as long as the CA certificate is
|
||||
also in your keychain.
|
||||
|
||||
```
|
||||
/Users/<user>/.docker/certs.d/
|
||||
└── <MyRegistry>:<Port>
|
||||
├── client.cert
|
||||
└── client.key
|
||||
```
|
||||
|
||||
To learn more about how to install a CA root certificate for the registry and
|
||||
how to set the client TLS certificate for verification, see
|
||||
[Verify repository client with certificates](../../engine/security/certificates.md)
|
||||
in the Docker Engine topics.
|
||||
|
||||
### How do I install shell completion?
|
||||
|
||||
Docker Desktop comes with scripts to enable completion for the `docker` and `docker-compose` commands. The completion scripts may be
|
||||
found inside `Docker.app`, in the `Contents/Resources/etc/` directory and can be
|
||||
installed both in Bash and Zsh.
|
||||
|
||||
#### Bash
|
||||
|
||||
Bash has [built-in support for
|
||||
completion](https://www.debian-administration.org/article/316/An_introduction_to_bash_completion_part_1){:target="_blank"
|
||||
class="_"} To activate completion for Docker commands, these files need to be
|
||||
copied or symlinked to your `bash_completion.d/` directory. For example, if you
|
||||
installed bash via [Homebrew](https://brew.sh):
|
||||
|
||||
```bash
|
||||
etc=/Applications/Docker.app/Contents/Resources/etc
|
||||
ln -s $etc/docker.bash-completion $(brew --prefix)/etc/bash_completion.d/docker
|
||||
ln -s $etc/docker-compose.bash-completion $(brew --prefix)/etc/bash_completion.d/docker-compose
|
||||
```
|
||||
|
||||
Add the following to your `~/.bash_profile`:
|
||||
|
||||
```bash
|
||||
[ -f /usr/local/etc/bash_completion ] && . /usr/local/etc/bash_completion
|
||||
```
|
||||
|
||||
OR
|
||||
|
||||
```bash
|
||||
if [ -f $(brew --prefix)/etc/bash_completion ]; then
|
||||
. $(brew --prefix)/etc/bash_completion
|
||||
fi
|
||||
```
|
||||
|
||||
#### Zsh
|
||||
|
||||
In Zsh, the [completion
|
||||
system](http://zsh.sourceforge.net/Doc/Release/Completion-System.html){:target="_blank" rel="nooopener" class="_"}
|
||||
takes care of things. To activate completion for Docker commands,
|
||||
these files need to be copied or symlinked to your Zsh `site-functions/`
|
||||
directory. For example, if you installed Zsh via [Homebrew](https://brew.sh){:target="_blank" rel="nooopener" class="_"}:
|
||||
|
||||
```bash
|
||||
etc=/Applications/Docker.app/Contents/Resources/etc
|
||||
ln -s $etc/docker.zsh-completion /usr/local/share/zsh/site-functions/_docker
|
||||
ln -s $etc/docker-compose.zsh-completion /usr/local/share/zsh/site-functions/_docker-compose
|
||||
```
|
||||
|
||||
#### Fish-Shell
|
||||
|
||||
Fish-shell also supports tab completion [completion
|
||||
system](https://fishshell.com/docs/current/#tab-completion){:target="_blank"
|
||||
class="_"}. To activate completion for Docker commands,
|
||||
these files need to be copied or symlinked to your Fish-shell `completions/`
|
||||
directory.
|
||||
|
||||
Create the `completions` directory:
|
||||
|
||||
```console
|
||||
$ mkdir -p ~/.config/fish/completions
|
||||
```
|
||||
|
||||
Now add fish completions from docker.
|
||||
|
||||
```console
|
||||
$ ln -shi /Applications/Docker.app/Contents/Resources/etc/docker.fish-completion ~/.config/fish/completions/docker.fish
|
||||
$ ln -shi /Applications/Docker.app/Contents/Resources/etc/docker-compose.fish-completion ~/.config/fish/completions/docker-compose.fish
|
||||
```
|
||||
|
|
@ -61,3 +61,77 @@ The Windows native symlinks are visible within the containers as symlinks, where
|
|||
|
||||
Docker Desktop mounts the Windows host filesystem under `/run/desktop` inside the container running Kubernetes.
|
||||
See the [Stack Overflow post](https://stackoverflow.com/questions/67746843/clear-persistent-volume-from-a-kubernetes-cluster-running-on-docker-desktop/69273405#69273){:target="_blank" rel="noopener" class="_"} for an example of how to configure a Kubernetes Persistent Volume to represent directories on the host.
|
||||
|
||||
### How do I add custom CA certificates?
|
||||
|
||||
You can add trusted **Certificate Authorities (CAs)** to your Docker daemon to verify registry server certificates, and **client certificates**, to authenticate to registries.
|
||||
|
||||
Docker Desktop supports all trusted Certificate Authorities (CAs) (root or
|
||||
intermediate). Docker recognizes certs stored under Trust Root
|
||||
Certification Authorities or Intermediate Certification Authorities.
|
||||
|
||||
Docker Desktop creates a certificate bundle of all user-trusted CAs based on
|
||||
the Windows certificate store, and appends it to Moby trusted certificates. Therefore, if an enterprise SSL certificate is trusted by the user on the host, it is trusted by Docker Desktop.
|
||||
|
||||
To learn more about how to install a CA root certificate for the registry, see
|
||||
[Verify repository client with certificates](../../engine/security/certificates.md)
|
||||
in the Docker Engine topics.
|
||||
|
||||
### How do I add client certificates?
|
||||
|
||||
You can add your client certificates
|
||||
in `~/.docker/certs.d/<MyRegistry><Port>/client.cert` and
|
||||
`~/.docker/certs.d/<MyRegistry><Port>/client.key`. You do not need to push your certificates with `git` commands.
|
||||
|
||||
When the Docker Desktop application starts, it copies the
|
||||
`~/.docker/certs.d` folder on your Windows system to the `/etc/docker/certs.d`
|
||||
directory on Moby (the Docker Desktop virtual machine running on Hyper-V).
|
||||
|
||||
You need to restart Docker Desktop after making any changes to the keychain
|
||||
or to the `~/.docker/certs.d` directory in order for the changes to take effect.
|
||||
|
||||
The registry cannot be listed as an _insecure registry_ (see
|
||||
[Docker Daemon](../settings/windows.md#docker-engine)). Docker Desktop ignores
|
||||
certificates listed under insecure registries, and does not send client
|
||||
certificates. Commands like `docker run` that attempt to pull from the registry
|
||||
produce error messages on the command line, as well as on the registry.
|
||||
|
||||
To learn more about how to set the client TLS certificate for verification, see
|
||||
[Verify repository client with certificates](../../engine/security/certificates.md)
|
||||
in the Docker Engine topics.
|
||||
|
||||
## How do I switch between Windows and Linux containers
|
||||
|
||||
From the Docker Desktop menu, you can toggle which daemon (Linux or Windows)
|
||||
the Docker CLI talks to. Select **Switch to Windows containers** to use Windows
|
||||
containers, or select **Switch to Linux containers** to use Linux containers
|
||||
(the default).
|
||||
|
||||
For more information on Windows containers, refer to the following documentation:
|
||||
|
||||
- Microsoft documentation on [Windows containers](https://docs.microsoft.com/en-us/virtualization/windowscontainers/about/index).
|
||||
|
||||
- [Build and Run Your First Windows Server Container (Blog Post)](https://blog.docker.com/2016/09/build-your-first-docker-windows-server-container/)
|
||||
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)](https://github.com/docker/labs/blob/master/windows/windows-containers/README.md)
|
||||
shows you how to use the [MusicStore](https://github.com/aspnet/MusicStore/blob/dev/README.md)
|
||||
application with Windows containers. The MusicStore is a standard .NET application and,
|
||||
[forked here to use containers](https://github.com/friism/MusicStore), is a good example of a multi-container application.
|
||||
|
||||
- To understand how to connect to Windows containers from the local host, see
|
||||
[I want to connect to a container from Windows](../networking.md#i-want-to-connect-to-a-container-from-the-host)
|
||||
|
||||
> Settings dialog changes with Windows containers
|
||||
>
|
||||
> When you switch to Windows containers, the Settings dialog only shows those tabs that are active and apply to your Windows containers:
|
||||
>
|
||||
* [General](../settings/windows.md#general)
|
||||
* [Proxies](../settings/windows.md#proxies)
|
||||
* [Daemon](../settings/windows.md#docker-engine)
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
description: Docker Dashboard
|
||||
keywords: Docker Dashboard, manage, containers, gui, dashboard, images, user manual
|
||||
title: Sign in and get started
|
||||
redirect_from:
|
||||
- /docker-for-windows/
|
||||
- /docker-for-windows/index/
|
||||
- /docker-for-windows/started/
|
||||
- /engine/installation/windows/
|
||||
- /installation/windows/
|
||||
- /win/
|
||||
- /windows/
|
||||
- /windows/started/
|
||||
- /winkit/
|
||||
- /winkit/getting-started/
|
||||
- /desktop/linux/index/
|
||||
- /desktop/windows/index/
|
||||
- /docker-for-mac/
|
||||
- /docker-for-mac/index/
|
||||
- /docker-for-mac/mutagen/
|
||||
- /docker-for-mac/mutagen-caching/
|
||||
- /docker-for-mac/osx/
|
||||
- /docker-for-mac/started/
|
||||
- /engine/installation/mac/
|
||||
- /installation/mac/
|
||||
- /mac/
|
||||
- /mac/started/
|
||||
- /mackit/
|
||||
- /mackit/getting-started/
|
||||
- /docker-for-mac/osxfs/
|
||||
- /docker-for-mac/osxfs-caching/
|
||||
- /desktop/mac/index/
|
||||
---
|
||||
|
||||
## Quick Start Guide
|
||||
|
||||
Once Docker Desktop is installed, the Quick Start Guide launches. It includes a simple exercise to build an example Docker image, run it as a container, push and save the image to Docker Hub.
|
||||
|
||||
|
||||
|
||||
To run the Quick Start Guide on demand, select {: .inline} and then choose **Quick Start Guide**.
|
||||
|
||||
For a more detailed guide, see [Get started](../get-started/index.md)
|
||||
|
||||
## Sign in to Docker Desktop
|
||||
|
||||
We recommend that you authenticate using the **Sign in/Create ID** option in the top-right corner of Docker Desktop.
|
||||
|
||||
Once logged in, you can access your Docker Hub repositories directly from Docker Desktop.
|
||||
|
||||
Authenticated users get a higher pull rate limit compared to anonymous users. For example, if you are authenticated, you get 200 pulls per 6 hour period, compared to 100 pulls per 6 hour period per IP address for anonymous users. For more information, see [Download rate limit](https://docs.docker.com/docker-hub/download-rate-limit/).
|
||||
|
||||
In large enterprises where admin access is restricted, administrators can create a registry.json file and deploy it to the developers’ machines using a device management software as part of the Docker Desktop installation process. Enforcing developers to authenticate through Docker Desktop also allows administrators to set up guardrails using features such as [Image Access Management](https://docs.docker.com/docker-hub/image-access-management/) which allows team members to only have access to Trusted Content on Docker Hub, and pull only from the specified categories of images. For more information, see Configure registry.json to enforce sign in https://docs.docker.com/docker-hub/configure-sign-in/.
|
||||
|
||||
### Two-factor authentication
|
||||
|
||||
Docker Desktop enables you to sign in to Docker Hub using two-factor authentication. Two-factor authentication provides an extra layer of security when accessing your Docker Hub account.
|
||||
|
||||
You must enable two-factor authentication in Docker Hub before signing into your Docker Hub account through Docker Desktop. For instructions, see [Enable two-factor authentication for Docker Hub](/docker-hub/2fa/).
|
||||
|
||||
After two-factor authentication is enabled:
|
||||
|
||||
1. Go to the Docker Desktop menu and then select **Sign in / Create Docker ID**.
|
||||
|
||||
2. Enter your Docker ID and password and click **Sign in**.
|
||||
|
||||
3. After you have successfully signed in, Docker Desktop prompts you to enter the authentication code. Enter the six-digit code from your phone and then click **Verify**.
|
||||
|
||||
### Credentials management for Linux users
|
||||
|
||||
Docker Desktop relies on [`pass`](https://www.passwordstore.org/){: target="_blank" rel="noopener" class="_"} to store credentials in gpg2-encrypted files.
|
||||
Before signing in to Docker Hub from the Docker Dashboard or the Docker menu, you must initialize `pass`.
|
||||
Docker Desktop displays a warning if you've not initialized `pass`.
|
||||
|
||||
You can intialize pass by using a gpg key. To generate a gpg key, run:
|
||||
|
||||
``` console
|
||||
$ gpg --generate-key
|
||||
...
|
||||
GnuPG needs to construct a user ID to identify your key.
|
||||
|
||||
Real name: Molly
|
||||
Email address: molly@example.com
|
||||
You selected this USER-ID:
|
||||
"Molly <molly@example.com>"
|
||||
|
||||
Change (N)ame, (E)mail, or (O)kay/(Q)uit? O
|
||||
...
|
||||
pub rsa3072 2022-03-31 [SC] [expires: 2024-03-30]
|
||||
7865BA9185AFA2C26C5B505669FC4F36530097C2
|
||||
uid Molly <molly@example.com>
|
||||
sub rsa3072 2022-03-31 [E] [expires: 2024-03-30]
|
||||
```
|
||||
|
||||
To initialize `pass`, run:
|
||||
|
||||
```console
|
||||
molly@ubuntu:~$ pass init 7865BA9185AFA2C26C5B505669FC4F36530097C2
|
||||
mkdir: created directory '/home/molly/.password-store/'
|
||||
Password store initialized for 7865BA9185AFA2C26C5B505669FC4F36530097C2
|
||||
```
|
||||
|
||||
Once `pass` is initialized, you can sign in on the Docker Dashboard and pull your private images.
|
||||
When credentials are used by the Docker CLI or Docker Desktop, a user prompt may pop up for the password you set during the gpg key generation.
|
||||
|
||||
```console
|
||||
$ docker pull molly/privateimage
|
||||
Using default tag: latest
|
||||
latest: Pulling from molly/privateimage
|
||||
3b9cc81c3203: Pull complete
|
||||
Digest: sha256:3c6b73ce467f04d4897d7a7439782721fd28ec9bf62ea2ad9e81a5fb7fb3ff96
|
||||
Status: Downloaded newer image for molly/privateimage:latest
|
||||
docker.io/molly/privateimage:latest
|
||||
```
|
||||
|
||||
## Pause or resume Docker Desktop
|
||||
|
||||
You can pause your Docker Desktop session when you are not actively using it and save CPU resources on your machine. When you pause Docker Desktop, the Linux VM running Docker Engine is paused, the current state of all your containers are saved in memory, and all processes are frozen. This reduces the CPU usage and helps you retain a longer battery life on your laptop. You can resume Docker Desktop when you want by clicking the **Resume** option.
|
||||
|
||||
From the Docker menu, select{: .inline} and then **Pause** to pause Docker Desktop.
|
||||
|
||||
Docker Desktop displays the paused status on the Docker menu and on the **Containers**, **Images**, **Volumes**, and **Dev Environment** screens in Docker Dashboard. You can still access the **Preferences** (or **Settings** if you are a Windows user) and the **Troubleshoot** menu from the Dashboard when you've paused Docker Desktop.
|
||||
|
||||
Select {: .inline} then **Resume** to resume Docker Desktop.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> When Docker Desktop is paused, running any commands in the Docker CLI will automatically resume Docker Desktop.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
|
Before Width: | Height: | Size: 99 KiB After Width: | Height: | Size: 99 KiB |
|
|
@ -1,11 +1,12 @@
|
|||
---
|
||||
description: Docker Desktop overview
|
||||
keywords: Desktop, Docker, GUI, run, docker, local, machine
|
||||
keywords: Desktop, Docker, GUI, run, docker, local, machine, dashboard
|
||||
title: Docker Desktop overview
|
||||
redirect_from:
|
||||
- /desktop/opensource/
|
||||
- /docker-for-mac/opensource/
|
||||
- /docker-for-windows/opensource/
|
||||
- /desktop/dashboard/
|
||||
---
|
||||
|
||||
> **Update to the Docker Desktop terms**
|
||||
|
|
@ -16,7 +17,9 @@ redirect_from:
|
|||
{: .important}
|
||||
|
||||
Docker Desktop is an easy-to-install application for your Mac or Windows environment
|
||||
that enables you to build and share containerized applications and microservices.
|
||||
that enables you to build and share containerized applications and microservices.
|
||||
|
||||
It provides a simple interface that enables you to manage your containers, applications, and images directly from your machine without having to use the CLI to perform core actions.
|
||||
|
||||
Docker Desktop includes:
|
||||
|
||||
|
|
@ -33,17 +36,34 @@ gives you access to a vast library of certified images and templates in
|
|||
their environment to rapidly auto-build, continuously integrate, and collaborate
|
||||
using a secure repository.
|
||||
|
||||
### Key features of Docker Desktop:
|
||||
## Overview of Docker Dashboard
|
||||
|
||||
* Ability to containerize and share any application on any cloud platform, in multiple languages and frameworks
|
||||
* Easy installation and setup of a complete Docker development environment
|
||||
* Includes the latest version of Kubernetes
|
||||
* Automatic updates to keep you up to date and secure
|
||||
* On Windows, the ability to toggle between Linux and Windows Server environments to build applications
|
||||
* Fast and reliable performance with native Windows Hyper-V virtualization
|
||||
* Ability to work natively on Linux through WSL 2 on Windows machines
|
||||
* Volume mounting for code and data, including file change notifications and easy access to running containers on the localhost network
|
||||
* In-container development and debugging with supported IDEs
|
||||
When you open Docker Desktop, the Docker Dashboard displays.
|
||||
|
||||
{:width="750px"}
|
||||
|
||||
The **Containers** view provides a runtime view of all your containers and applications. It allows you to interact with containers and applications, and manage the lifecycle of your applications directly from your machine. This view also provides an intuitive interface to perform common actions to inspect, interact with, and manage your Docker objects including containers and Docker Compose-based applications. For more information, see [Explore running containers and applications](use-desktop/container.md).
|
||||
|
||||
The **Images** view displays a list of your Docker images and allows you to run an image as a container, pull the latest version of an image from Docker Hub, and inspect images. It also displays a summary of the vulnerability scanning report using Snyk. In addition, the **Images** view contains clean-up options to remove unwanted images from the disk to reclaim space. If you are logged in, you can also see the images you and your organization have shared on Docker Hub. For more information, see [Explore your images](use-desktop/images.md)
|
||||
|
||||
The **Volumes** view displays a list of volumes and allows you to easily create and delete volumes and see which ones are being used. For more information, see [Explore volumes](use-desktop/volumes.md).
|
||||
|
||||
In addition, the Docker Dashboard allows you to:
|
||||
|
||||
- Easily navigate to the **Preferences** (**Settings** in Windows) menu to configure Docker Desktop preferences. Select the **Preferences** or **Settings** icon in the Dashboard header.
|
||||
- Access the **Troubleshoot** menu to debug and perform restart operations. Select the **Troubleshoot** icon in the Dashboard header.
|
||||
|
||||
### Other key features of Docker Desktop:
|
||||
|
||||
* Ability to containerize and share any application on any cloud platform, in multiple languages and frameworks.
|
||||
* Easy installation and setup of a complete Docker development environment.
|
||||
* Includes the latest version of Kubernetes.
|
||||
* Automatic updates to keep you up to date and secure.
|
||||
* On Windows, the ability to toggle between Linux and Windows Server environments to build applications.
|
||||
* Fast and reliable performance with native Windows Hyper-V virtualization.
|
||||
* Ability to work natively on Linux through WSL 2 on Windows machines.
|
||||
* Volume mounting for code and data, including file change notifications and easy access to running containers on the localhost network.
|
||||
* In-container development and debugging with supported IDEs.
|
||||
|
||||
## Download and install
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ redirect_from:
|
|||
- /desktop/linux/install/
|
||||
---
|
||||
|
||||
Welcome to Docker Desktop for Linux. This page contains information about system requirements, download URLs, and instructions on how to install and update Docker Desktop for Linux.
|
||||
This page contains information about system requirements, download URLs, and instructions on how to install and update Docker Desktop for Linux.
|
||||
|
||||
> Download Docker Desktop for Linux packages
|
||||
>
|
||||
|
|
@ -216,16 +216,6 @@ Current context is now "desktop-linux"
|
|||
|
||||
Refer to the [Docker Context documentation](../../engine/context/working-with-contexts.md) for more details.
|
||||
|
||||
|
||||
## Quick Start Guide
|
||||
|
||||
If you've just installed the app, Docker Desktop launches the Quick Start Guide. The tutorial includes a simple exercise to build an example Docker image, run it as a container, push and save the image to Docker Hub.
|
||||
|
||||
|
||||
|
||||
Congratulations! You are now successfully running Docker Desktop. Click the Docker menu ({: .inline}) to see
|
||||
**Settings** and other options. To run the Quick Start Guide on demand, select the Docker menu and then choose **Quick Start Guide**.
|
||||
|
||||
## Updates
|
||||
|
||||
Once a new version for Docker Desktop is released, the Docker UI shows a notification.
|
||||
|
|
|
|||
|
|
@ -103,15 +103,6 @@ The `install` command accepts the following flags:
|
|||
- `--accept-license`: accepts the [Docker Subscription Service Agreement](https://www.docker.com/legal/docker-subscription-service-agreement){: target="_blank" rel="noopener" class="_"} now, rather than requiring it to be accepted when the application is first run
|
||||
- `--allowed-org=<org name>`: requires the user to sign in and be part of the specified Docker Hub organization when running the application
|
||||
|
||||
### Quick start guide
|
||||
|
||||
If you've just installed the app, Docker Desktop launches the Quick Start Guide. The tutorial includes a simple exercise to build an example Docker image, run it as a container, push and save the image to Docker Hub.
|
||||
|
||||
|
||||
|
||||
Congratulations! You are now successfully running Docker Desktop. Click the Docker menu ({: .inline}) to see
|
||||
**Preferences** and other options. To run the Quick Start Guide on demand, select the Docker menu and then choose **Quick Start Guide**.
|
||||
|
||||
## Updates
|
||||
|
||||
{% include desktop-update.md %}
|
||||
|
|
|
|||
|
|
@ -180,16 +180,6 @@ Docker Desktop does not start automatically after installation. To start Docker
|
|||
|
||||
For more information, see [Docker Desktop License Agreement](../../subscription/index.md#docker-desktop-license-agreement). We recommend that you also read the [Blog](https://www.docker.com/blog/updating-product-subscriptions/){: target="_blank" rel="noopener" class="_" id="dkr_docs_desktop_install_btl"} and [FAQs](https://www.docker.com/pricing/faq){: target="_blank" rel="noopener" class="_" id="dkr_docs_desktop_install_btl"} to learn how companies using Docker Desktop may be affected.
|
||||
|
||||
### Quick Start Guide
|
||||
|
||||
When the initialization is complete, Docker Desktop launches the **Quick Start Guide**. This tutorial includes a simple exercise to build an example Docker image, run it as a container, push and save the image to Docker Hub.
|
||||
|
||||
To run the Quick Start Guide on demand, right-click the Docker icon in the Notifications area (or System tray) to open the Docker Desktop menu and then select **Quick Start Guide**.
|
||||
|
||||
{:width="450px"}
|
||||
|
||||
Congratulations! You are now successfully running Docker Desktop on Windows.
|
||||
|
||||
## Updates
|
||||
|
||||
{% include desktop-update.md %}
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ This page contains information about the new features, improvements, known issue
|
|||
### New
|
||||
|
||||
- **Dev Environments**: You can now create a Dev Environment from your local Git repository. For more information, see [Create a Dev Environment from a local folder](../dev-environments/create-dev-env.md#create-a-dev-environment-from-a-local-folder).
|
||||
- **Volume Management**: You can now sort volumes by the name, the date created, and the size of the volume. You can also search for specific volumes using the **Search** field. For more information, see [Explore volumes](../dashboard.md#explore-volumes).
|
||||
- **Volume Management**: You can now sort volumes by the name, the date created, and the size of the volume. You can also search for specific volumes using the **Search** field. For more information, see [Explore volumes](../use-desktop/volumes.md).
|
||||
|
||||
### Upgrades
|
||||
|
||||
|
|
@ -167,7 +167,7 @@ This page contains information about the new features, improvements, known issue
|
|||
|
||||
### New
|
||||
|
||||
**Volume Management**: Docker Desktop users can now create and delete volumes using the Docker Dashboard and also see which volumes are being used. For more information, see [Explore volumes](../dashboard.md#explore-volumes).
|
||||
**Volume Management**: Docker Desktop users can now create and delete volumes using the Docker Dashboard and also see which volumes are being used. For more information, see [Explore volumes](../use-desktop/volumes.md).
|
||||
|
||||
**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](../../compose/cli-command-compatibility.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository.
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ This page contains information about the new features, improvements, known issue
|
|||
### New
|
||||
|
||||
- **Dev Environments**: You can now create a Dev Environment from your local Git repository. For more information, see [Create a Dev Environment from a local folder](../dev-environments/create-dev-env.md#create-a-dev-environment-from-a-local-folder).
|
||||
- **Volume Management**: You can now sort volumes by the name, the date created, and the size of the volume. You can also search for specific volumes using the **Search** field. For more information, see [Explore volumes](../dashboard.md#explore-volumes).
|
||||
- **Volume Management**: You can now sort volumes by the name, the date created, and the size of the volume. You can also search for specific volumes using the **Search** field. For more information, see [Explore volumes](../use-desktop/volumes.md).
|
||||
|
||||
### Upgrades
|
||||
|
||||
|
|
@ -169,7 +169,7 @@ This page contains information about the new features, improvements, known issue
|
|||
|
||||
### New
|
||||
|
||||
**Volume Management**: Docker Desktop users can now create and delete volumes using the Docker Dashboard and also see which volumes are being used. For more information, see [Explore volumes](../dashboard.md#explore-volumes).
|
||||
**Volume Management**: Docker Desktop users can now create and delete volumes using the Docker Dashboard and also see which volumes are being used. For more information, see [Explore volumes](../use-desktop/volumes.md).
|
||||
|
||||
**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](../../compose/cli-command-compatibility.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository.
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
description: Docker Dashboard
|
||||
keywords: Docker Dashboard, manage, containers, gui, dashboard, images, user manual
|
||||
title: Explore Containers
|
||||
---
|
||||
|
||||
The **Containers** view lists all your running containers and applications. You must have running or stopped containers and applications to see them listed.
|
||||
|
||||
## Container actions
|
||||
|
||||
Use the **Search** field to search for any specific container.
|
||||
|
||||
From the **Containers** view you can perform the following actions on one or more containers at once:
|
||||
- Pause
|
||||
- Resume
|
||||
- Stop
|
||||
- Start
|
||||
- Delete
|
||||
|
||||
When you hover over individual containers, you can also:
|
||||
- Click **Open in Visual Studio Code** to open the application in VS Code.
|
||||
- Open the port exposed by the container in a browser.
|
||||
|
||||
### Inspect a container
|
||||
|
||||
You can obtain detailed information about the container when you select a container.
|
||||
|
||||
The **container view** displays **Logs**, **Inspect**, and **Stats** tabs and provides quick action buttons to perform various actions.
|
||||
|
||||
- Select **Logs** to see logs from the container. You can also:
|
||||
- Use `Cmd + f`/`Ctrl + f` to open the search bar and find specific entries. Search matches are highlighted in yellow.
|
||||
- Press `Enter` or `Shit + Enter` to jump to the next or previous search match respectively.
|
||||
- Use the **Copy** icon in the top right-hand corner to copy all the logs to your clipboard.
|
||||
- Automatically copy any logs content by highlighting a few lines or a section of the logs.
|
||||
- Use the **Clear terminal** icon in the top right-hand corner to clear the logs terminal.
|
||||
- Select and view external links that may be in your logs.
|
||||
|
||||
|
||||
- Select **Inspect** to view low-level information about the container. You can see the local path, version number of the image, SHA-256, port mapping, and other details.
|
||||
|
||||
- Select **Stats** to view information about the container resource utilization. You can see the amount of CPU, disk I/O, memory, and network I/O used by the container.
|
||||
|
|
@ -0,0 +1,108 @@
|
|||
---
|
||||
description: Docker Dashboard
|
||||
keywords: Docker Dashboard, manage, containers, gui, dashboard, images, user manual
|
||||
title: Explore Images
|
||||
---
|
||||
|
||||
The **Images** view is a simple interface that lets you manage Docker images without having to use the CLI. By default, it displays a list of all Docker images on your local disk.
|
||||
|
||||
You can also view images in remote repositories, once you have signed in to Docker Hub. This allows you to collaborate with your team and manage your images directly through Docker Desktop.
|
||||
|
||||
The **Images** view allows you to perform core operations such as running an image as a container, pulling the latest version of an image from Docker Hub, pushing the image to Docker Hub, and inspecting images.
|
||||
|
||||
The **Images** view displays metadata about the image such as the:
|
||||
- Tag
|
||||
- Image ID
|
||||
- Date created
|
||||
- Size of the image.
|
||||
|
||||
It also displays **In Use** tags next to images used by running and stopped containers.
|
||||
|
||||
The **Images on disk** status bar displays the number of images and the total disk space used by the images.
|
||||
|
||||
## Manage your images
|
||||
|
||||
Use the **Search** field to search for any specific image.
|
||||
|
||||
You can sort images by:
|
||||
- Name
|
||||
- Date created
|
||||
- Size
|
||||
|
||||
|
||||
## Run an image as a container
|
||||
|
||||
From the **Images view**, hover over an image and click **Run**.
|
||||
|
||||
When prompted you can either:
|
||||
|
||||
- Click the **Optional settings** drop-down to specify a name, port, volumes, environment variables and click **Run**
|
||||
- Click **Run** without specifying any optional settings.
|
||||
|
||||
## Inspect an image
|
||||
|
||||
Inspecting an image displays detailed information about the image such as the:
|
||||
|
||||
- Image history
|
||||
- Image ID
|
||||
- Date the image was created
|
||||
- Size of the imag
|
||||
|
||||
To inspect an image, hover over an image, select the **More options** button and then select **Inspect** from the dropdown menu.
|
||||
|
||||
## Pull the latest image from Docker Hub
|
||||
|
||||
Select the image from the list, click the **More options** button and click **Pull**.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> The repository must exist on Docker Hub in order to pull the latest version of an image. You must be logged in to pull private images.
|
||||
|
||||
## Push an image to Docker Hub
|
||||
|
||||
Select the image from the list, click the **More options** button and click **Push to Hub**.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> You can only push an image to Docker Hub if the image belongs to your Docker ID or your organization. That is, the image must contain the correct username/organization in its tag to be able to push it to Docker Hub.
|
||||
|
||||
## Remove an image
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> To remove an image used by a running or a stopped container, you must first remove the associated container.
|
||||
|
||||
You can remove individual images or use the **Clean up** option to delete unused and dangling images.
|
||||
|
||||
An unused image is an image which is not used by any running or stopped containers. An image becomes dangling when you build a new version of the image with the same tag.
|
||||
|
||||
To remove individual images, select the image from the list, click the **More options** button and click **Remove**
|
||||
|
||||
To remove an unused or a dangling image:
|
||||
|
||||
1. Select the **Clean up** option from the **Images on disk** status bar.
|
||||
2. Use the **Unused** or **Dangling** check boxes to select the type of images you would like to remove.
|
||||
|
||||
The **Clean up** images status bar displays the total space you can reclaim by removing the selected images.
|
||||
3.. Select **Remove** to confirm.
|
||||
|
||||
## Interact with remote repositories
|
||||
|
||||
The **Images** view also allows you to manage and interact with images in remote repositories and lets you switch between organizations. Select an organization from the drop-down to view a list of repositories in your organization.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> If you have a paid Docker subscription and enabled [Vulnerability Scanning](../../docker-hub/vulnerability-scanning.md) in Docker Hub, the scan results appear on the Remote repositories tab.
|
||||
The **Pull** option allows you to pull the latest version of the image from Docker Hub. The **View in Hub** option opens the Docker Hub page and displays detailed information about the image, such as the OS architecture, size of the image, the date when the image was pushed, and a list of the image layers.
|
||||
|
||||
To interact with remote repositories:
|
||||
|
||||
1. Click the **Remote repositories** tab.
|
||||
2. Select an organization from the drop-down list. This displays a list of repositories in your organization.
|
||||
3. Hover over an image from the list and then select **Pull** to pull the latest image from the remote repository.
|
||||
|
||||
To view a detailed information about the image in Docker Hub, select the image and then click **View in Hub**.
|
||||
|
||||
The **View in Hub** option opens the Docker Hub page and displays detailed information about the image, such as the OS architecture, size of the image, the date when the image was pushed, and a list of the image layers.
|
||||
|
||||
If you have a paid Docker subscription and have enabled [Vulnerability Scanning](../../docker-hub/vulnerability-scanning.md) the Docker Hub page also displays a summary of the vulnerability scan report and provides detailed information about the vulnerabilities identified.
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
description: Docker Dashboard
|
||||
keywords: Docker Dashboard, manage, containers, gui, dashboard, images, user manual
|
||||
title: Explore Volumes
|
||||
---
|
||||
|
||||
The **Volumes** view in Docker Dashboard enables you to easily create and delete volumes and see which ones are being used. You can also see which container is using a specific volume and explore the files and folders in your volumes.
|
||||
|
||||
For more information about volumes, see [Use volumes](../../storage/volumes.md)
|
||||
|
||||
By default, the **Volumes** view displays a list of all the volumes. Volumes that are currently used by a container display the **In Use** badge.
|
||||
|
||||
## Manage your volumes
|
||||
|
||||
Use the **Search** field to search for any specific volume.
|
||||
|
||||
You can sort volumes by:
|
||||
- Name
|
||||
- Date created
|
||||
- Size
|
||||
|
||||
From the **More options** menu to the right of the search bar, you can choose what volume information to display.
|
||||
|
||||
## Inspect a volume
|
||||
|
||||
To explore the details of a specific volume, select a volume from the list. This opens the detailed view.
|
||||
|
||||
The **In Use** tab displays the name of the container using the volume, the image name, the port number used by the container, and the target. A target is a path inside a container that gives access to the files in the volume.
|
||||
|
||||
The **Data** tab displays the files and folders in the volume and the file size. To save a file or a folder, hover over the file or folder and click on the more options menu. Select **Save As** and then specify a location to download the file.
|
||||
|
||||
To delete a file or a folder from the volume, select **Remove** from the **More options** menu.
|
||||
|
||||
### Remove a volume
|
||||
|
||||
Removing a volume deletes the volume and all its data.
|
||||
|
||||
To remove a volume, hover over the volume and then click the **Delete** icon. Alternatively, select the volume from the list and then click the **Delete** button.
|
||||
|
|
@ -185,7 +185,7 @@ Successfully tagged java-docker:latest
|
|||
|
||||
## View local images
|
||||
|
||||
To see a list of images we have on our local machine, we have two options. One is to use the CLI and the other is to use [Docker Desktop](../../desktop/dashboard.md#explore-your-images). As we are currently working in the terminal let’s take a look at listing images using the CLI.
|
||||
To see a list of images we have on our local machine, we have two options. One is to use the CLI and the other is to use [Docker Desktop](../../desktop/use-desktop/images.md). As we are currently working in the terminal let’s take a look at listing images using the CLI.
|
||||
|
||||
To list images, simply run the `docker images` command.
|
||||
|
||||
|
|
|
|||
|
|
@ -173,7 +173,7 @@ $ docker build --tag python-docker .
|
|||
|
||||
## View local images
|
||||
|
||||
To see a list of images we have on our local machine, we have two options. One is to use the CLI and the other is to use [Docker Desktop](../../desktop/dashboard.md#explore-your-images). As we are currently working in the terminal let’s take a look at listing images using the CLI.
|
||||
To see a list of images we have on our local machine, we have two options. One is to use the CLI and the other is to use [Docker Desktop](../../desktop/use-desktop/images.md). As we are currently working in the terminal let’s take a look at listing images using the CLI.
|
||||
|
||||
To list images, simply run the `docker images` command.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue