diff --git a/content/manuals/desktop/images/notifications.svg b/content/manuals/desktop/images/notifications.svg deleted file mode 100644 index 45a9e4904f39..000000000000 --- a/content/manuals/desktop/images/notifications.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/content/manuals/desktop/settings-and-maintenance/backup-and-restore.md b/content/manuals/desktop/settings-and-maintenance/backup-and-restore.md index bec9b9f232b4..4ada95b5fda3 100644 --- a/content/manuals/desktop/settings-and-maintenance/backup-and-restore.md +++ b/content/manuals/desktop/settings-and-maintenance/backup-and-restore.md @@ -1,5 +1,6 @@ --- title: How to back up and restore your Docker Desktop data +linkTitle: Backup and restore data keywords: Docker Desktop, backup, restore, migration, reinstall, containers, images, volumes weight: 20 @@ -7,8 +8,7 @@ aliases: - /desktop/backup-and-restore/ --- -Use the following procedure to save and restore your images and container data. This is useful if you want to reset your VM disk or to move your Docker environment to a new -computer, for example. +Use this procedure to back up and restore your images and container data. This is useful if you want to reset your VM disk or to move your Docker environment to a new computer. > [!IMPORTANT] > @@ -18,12 +18,10 @@ computer, for example. 1. Commit your containers to an image with [`docker container commit`](/reference/cli/docker/container/commit.md). - Committing a container stores the container filesystem changes and some of the - container's configuration, for example labels and environment-variables, as a local image. Be aware that environment variables may contain sensitive - information such as passwords or proxy-authentication, so care should be taken - when pushing the resulting image to a registry. + Committing a container stores filesystem changes and some container configurations, such as labels and environment variables, as a local image. Be aware that environment variables may contain sensitive + information such as passwords or proxy-authentication, so take care when pushing the resulting image to a registry. - Also note that filesystem changes in volume that are attached to the + Also note that filesystem changes in a volume that are attached to the container are not included in the image, and must be backed up separately. If you used a [named volume](/manuals/engine/storage/_index.md#more-details-about-mount-types) to store container data, such as databases, refer to the [back up, restore, or migrate data volumes](/manuals/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) page in the storage section. @@ -31,24 +29,33 @@ computer, for example. 2. Use [`docker push`](/reference/cli/docker/image/push.md) to push any images you have built locally and want to keep to the [Docker Hub registry](/manuals/docker-hub/_index.md). - Make sure to configure the [repository's visibility as "private"](/manuals/docker-hub/repos/_index.md) - for images that should not be publicly accessible. + > [!TIP] + > + > [Set the repository visibility to private](/manuals/docker-hub/repos/_index.md) if your image includes sensitive content. Alternatively, use [`docker image save -o images.tar image1 [image2 ...]`](/reference/cli/docker/image/save.md) - to save any images you want to keep to a local tar file. + to save any images you want to keep to a local `.tar` file. After backing up your data, you can uninstall the current version of Docker Desktop and [install a different version](/manuals/desktop/release-notes.md) or reset Docker Desktop to factory defaults. ## Restore your data -1. Use [`docker pull`](/reference/cli/docker/image/pull.md) to restore images - you pushed to Docker Hub. +1. Load your images. - If you backed up your images to a local tar file, use [`docker image load -i images.tar`](/reference/cli/docker/image/load.md) - to restore previously saved images. + - If you pushed to Docker Hub: + + ```console + $ docker pull + ``` + + - If you saved a `.tar` file: + + ```console + $ docker image load -i images.tar + ``` 2. Re-create your containers if needed, using [`docker run`](/reference/cli/docker/container/run.md), or [Docker Compose](/manuals/compose/_index.md). -Refer to the [backup, restore, or migrate data volumes](/manuals/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) page in the storage section to restore volume data. +To restore volume data, refer to [backup, restore, or migrate data volumes](/manuals/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes). diff --git a/content/manuals/desktop/settings-and-maintenance/settings.md b/content/manuals/desktop/settings-and-maintenance/settings.md index d3fb8530d746..662d07d83df9 100644 --- a/content/manuals/desktop/settings-and-maintenance/settings.md +++ b/content/manuals/desktop/settings-and-maintenance/settings.md @@ -34,6 +34,8 @@ On the **General** tab, you can configure when to start Docker and specify other - **Choose theme for Docker Desktop**. Choose whether you want to apply a **Light** or **Dark** theme to Docker Desktop. Alternatively you can set Docker Desktop to **Use system settings**. +- **Configure shell completions**. Automatically edits your shell configuration and gives you word completion for commands, flags, and Docker objects (such as container and volume names) when you hit `` as you type into your terminal. For more information, see [Completion](/manuals/engine/cli/completion.md). + - **Choose container terminal**. Determines which terminal is launched when opening the terminal from a container. If you choose the integrated terminal, you can run commands in a running container straight from the Docker Desktop Dashboard. For more information, see [Explore containers](/manuals/desktop/use-desktop/container.md). @@ -44,6 +46,12 @@ If you choose the integrated terminal, you can run commands in a running contain - {{< badge color=blue text="Mac only" >}}**Include VM in Time Machine backups**. Select to back up the Docker Desktop virtual machine. This option is turned off by default. +- **Use containerd for pulling and storing images**. + Turns on the containerd image store. + This brings new features like faster container startup performance by lazy-pulling images, + and the ability to run Wasm applications with Docker. + For more information, see [containerd image store](/manuals/desktop/features/containerd.md). + - {{< badge color=blue text="Windows only" >}}**Expose daemon on tcp://localhost:2375 without TLS**. Check this option to enable legacy clients to connect to the Docker daemon. You must use this option with caution as exposing the daemon without TLS can result in remote code @@ -54,12 +62,6 @@ If you choose the integrated terminal, you can run commands in a running contain - {{< badge color=blue text="Windows only" >}}**Add the `*.docker.internal` names to the host's `/etc/hosts` file (Password required)**. Lets you resolve `*.docker.internal` DNS names from both the host and your containers. -- **Use containerd for pulling and storing images**. - Turns on the containerd image store. - This brings new features like faster container startup performance by lazy-pulling images, - and the ability to run Wasm applications with Docker. - For more information, see [containerd image store](/manuals/desktop/features/containerd.md). - - {{< badge color=blue text="Mac only" >}} **Choose Virtual Machine Manager (VMM)**. Choose the Virtual Machine Manager for creating and managing the Docker Desktop Linux VM. - Select **Docker VMM** for the latest and most performant Hypervisor/Virtual Machine Manager. This option is available only on Apple Silicon Macs running macOS 12.5 or later and is currently in Beta. > [!TIP] @@ -88,7 +90,7 @@ If you choose the integrated terminal, you can run commands in a running contain - **Show CLI hints**. Displays CLI hints and tips when running Docker commands in the CLI. This is turned on by default. To turn CLI hints on or off from the CLI, set `DOCKER_CLI_HINTS` to `true` or `false` respectively. -- **SBOM Indexing**. When this option is enabled, inspecting an image in Docker Desktop shows a **Start analysis** button that, when selected, analyzes the image with Docker Scout. +- **Enable Scout image analysis**. When this option is enabled, inspecting an image in Docker Desktop shows a **Start analysis** button that, when selected, analyzes the image with Docker Scout. - **Enable background SBOM indexing**. When this option is enabled, Docker Scout automatically analyzes images that you build or pull. @@ -128,7 +130,7 @@ Advanced settings are: - **Swap**. Configure swap file size as needed. The default is 1 GB. -- **Virtual disk limit**. Specify the maximum size of the disk image. +- **Disk usage limit**. Specify the maximum amount of disk space the engine can use. - **Disk image location**. Specify the location of the Linux volume where containers and images are stored. @@ -429,8 +431,6 @@ With Docker Desktop version 4.38 and later, you can choose your cluster provisio - **Kubeadm** creates a single-node cluster and the version is set by Docker Desktop. - **kind** creates a multi-node cluster and you can set the version and number of nodes. -Docker Desktop version 4.38 and later also lets you install the Kubernetes Dashboard within an existing Kubernetes cluster with the **Deploy the Kubernetes Dashboard into cluster** setting. It provides real-time visibility into workloads and nodes and helps you manage and monitor your Kubernetes clusters and applications easily. - Select **Show system containers (advanced)** to view internal containers when using Docker commands. @@ -499,12 +499,15 @@ For a list of current experimental features in the Docker CLI, see [Docker CLI E Use the **Notifications** tab to turn on or turn off notifications for the following events: - **Status updates on tasks and processes** +- **Recommendations from Docker** - **Docker announcements** - **Docker surveys** -By default, all notifications are turned on. You'll always receive error notifications and notifications about new Docker Desktop releases and updates. +By default, all general notifications are turned on. You'll always receive error notifications and notifications about new Docker Desktop releases and updates. + +You can also [configure notification settings for Docker Scout-related issues](/manuals/scout/explore/dashboard.md#notification-settings). -Notifications momentarily appear in the lower-right of the Docker Desktop Dashboard and then move to the **Notifications** drawer. To open the **Notifications** drawer, select {{< inline-image src="../images/notifications.svg" alt="notifications" >}}. +Notifications momentarily appear in the lower-right of the Docker Desktop Dashboard and then move to the **Notifications** drawer which can be accessed from the top-right of the Docker Desktop Dashboard. ## Advanced @@ -520,8 +523,8 @@ On Mac, you can reconfigure your initial installation settings on the **Advance ``` 3. Save and the close the file. Restart your shell to apply the changes to the PATH variable. -- **Enable default Docker socket (Requires password)**. Creates `/var/run/docker.sock` which some third party clients may use to communicate with Docker Desktop. For more information, see [permission requirements for macOS](/manuals/desktop/setup/install/mac-permission-requirements.md#installing-symlinks). +- **Allow the default Docker socket to be used (Requires password)**. Creates `/var/run/docker.sock` which some third party clients may use to communicate with Docker Desktop. For more information, see [permission requirements for macOS](/manuals/desktop/setup/install/mac-permission-requirements.md#installing-symlinks). -- **Enable privileged port mapping (Requires password)**. Starts the privileged helper process which binds the ports that are between 1 and 1024. For more information, see [permission requirements for macOS](/manuals/desktop/setup/install/mac-permission-requirements.md#binding-privileged-ports). +- **Allow privileged port mapping (Requires password)**. Starts the privileged helper process which binds the ports that are between 1 and 1024. For more information, see [permission requirements for macOS](/manuals/desktop/setup/install/mac-permission-requirements.md#binding-privileged-ports). - For more information on each configuration and use case, see [Permission requirements](/manuals/desktop/setup/install/mac-permission-requirements.md). +For more information on each configuration and use case, see [Permission requirements](/manuals/desktop/setup/install/mac-permission-requirements.md). diff --git a/content/manuals/desktop/troubleshoot-and-support/feedback.md b/content/manuals/desktop/troubleshoot-and-support/feedback.md index 3394c6de3949..6ab0af9cf893 100644 --- a/content/manuals/desktop/troubleshoot-and-support/feedback.md +++ b/content/manuals/desktop/troubleshoot-and-support/feedback.md @@ -12,7 +12,7 @@ There are many ways you can provide feedback on Docker Desktop or Docker Desktop ### In-product feedback -On each Docker Desktop Dashboard view, there is a **Give feedback** link. This sends you to a Google feedback form where you can share your feedback and ideas. +On each Docker Desktop Dashboard view, there is a **Give feedback** link. This opens a feedback form where you can share ideas directly with the Docker team. You can also use the `docker feedback` command to submit feedback directly from the command line. @@ -23,8 +23,7 @@ You can also use the `docker feedback` command to submit feedback directly from To get help from the community, review current user topics, join or start a discussion, sign in to the appropriate Docker forums: -- [Docker Desktop for Mac -forum](https://forums.docker.com/c/docker-for-mac) +- [Docker Desktop for Mac forum](https://forums.docker.com/c/docker-for-mac) - [Docker Desktop for Windows forum](https://forums.docker.com/c/docker-for-windows) - [Docker Desktop for Linux forum](https://forums.docker.com/c/docker-desktop-for-linux/60) @@ -36,7 +35,7 @@ GitHub](https://github.com/docker/for-mac/issues) - [Docker Desktop for Windows issues on GitHub](https://github.com/docker/for-win/issues) - [Docker Desktop for Linux issues on GitHub](https://github.com/docker/desktop-linux/issues) -- [Dev Environments issues on Github](https://github.com/docker/dev-environments/issues) +- [Dev Environments issues on GitHub](https://github.com/docker/dev-environments/issues) - [Docker Extensions issues on GitHub](https://github.com/docker/extensions-sdk/issues) ### Feedback via Community Slack channels diff --git a/content/manuals/desktop/uninstall.md b/content/manuals/desktop/uninstall.md index a33e0212e8dd..921bdf2f1723 100644 --- a/content/manuals/desktop/uninstall.md +++ b/content/manuals/desktop/uninstall.md @@ -15,13 +15,13 @@ weight: 210 {{< tabs >}} {{< tab name="Windows" >}} -To uninstall Docker Desktop from your Windows machine: +#### From the GUI 1. From the Windows **Start** menu, select **Settings** > **Apps** > **Apps & features**. 2. Select **Docker Desktop** from the **Apps & features** list and then select **Uninstall**. 3. Select **Uninstall** to confirm your selection. -You can also uninstall Docker Desktop from the CLI: +#### From the CLI 1. Locate the installer: ```console @@ -37,7 +37,7 @@ You can also uninstall Docker Desktop from the CLI: $ start /w "" "Docker Desktop Installer.exe" uninstall ``` -After uninstalling Docker Desktop, there may be some residual files left behind which you can remove manually. These are: +After uninstalling Docker Desktop, some residual files may remain which you can remove manually. These are: ```console C:\ProgramData\Docker @@ -52,128 +52,159 @@ C:\Users\\.docker {{< /tab >}} {{< tab name="Mac" >}} -To uninstall Docker Desktop from your Mac: +#### From the GUI -1. From the Docker menu, select the **Troubleshoot** icon in the top-right corner of the Docker Desktop Dashboard and then select **Uninstall**. -2. Select **Uninstall** to confirm your selection. +1. Open Docker Desktop. +2. In the top-right corner of the Docker Desktop Dashboard, select the **Troubleshoot** icon. +3. Select **Uninstall**. +4. When prompted, confirm by selecting **Uninstall** again. -You can also uninstall Docker Desktop from the CLI. Run: +You can then move the Docker application to the trash. -```console -$ /Applications/Docker.app/Contents/MacOS/uninstall -``` +#### From the CLI + +Run: -You may encounter the following error when uninstalling Docker Desktop using the uninstall command. ```console $ /Applications/Docker.app/Contents/MacOS/uninstall -Password: -Uninstalling Docker Desktop... -Error: unlinkat /Users//Library/Containers/com.docker.docker/.com.apple.containermanagerd.metadata.plist: operation not permitted ``` -The operation not permitted error is reported either on the file `.com.apple.containermanagerd.metadata.plist` or on the parent directory `/Users//Library/Containers/com.docker.docker/`. This error can be ignored as you have successfully uninstalled Docker Desktop. -You can remove the directory `/Users//Library/Containers/com.docker.docker/` later by allowing **Full Disk Access** to the terminal application you are using (**System Settings** > **Privacy & Security** > **Full Disk Access**). -After uninstalling Docker Desktop, there may be some residual files left behind which you can remove: +You can then move the Docker application to the trash. + +> [!NOTE] +> You may encounter the following error when uninstalling Docker Desktop using the uninstall command. +> +> ```console +> $ /Applications/Docker.app/Contents/MacOS/uninstall +> Password: +> Uninstalling Docker Desktop... +> Error: unlinkat /Users//Library/Containers/com.docker.docker/.com.apple.containermanagerd.metadata.plist: > operation not permitted +> ``` +> +> The operation not permitted error is reported either on the file `.com.apple.containermanagerd.metadata.plist` or on the parent directory `/Users//Library/Containers/com.docker.docker/`. This error can be ignored as you have successfully uninstalled Docker Desktop. +> You can remove the directory `/Users//Library/Containers/com.docker.docker/` later by allowing **Full Disk Access** to the terminal application you are using (**System Settings** > **Privacy & Security** > **Full Disk Access**). + +After uninstalling Docker Desktop, some residual files may remain which you can remove: ```console $ rm -rf ~/Library/Group\ Containers/group.com.docker $ rm -rf ~/.docker ``` -With Docker Desktop version 4.36 and earlier, the following files can also be left on the file system. You can remove these with administrative privileges: +With Docker Desktop version 4.36 and earlier, the following files may also be left on the file system. You can remove these with administrative privileges: ```console /Library/PrivilegedHelperTools/com.docker.vmnetd /Library/PrivilegedHelperTools/com.docker.socket ``` -You can also move the Docker application to the trash. - {{< /tab >}} -{{< tab name="Linux" >}} +{{< tab name="Ubuntu" >}} -Docker Desktop is removed from a Linux host using the package manager. +To uninstall Docker Desktop for Ubuntu: -Once Docker Desktop is removed, users must delete the `credsStore` and `currentContext` properties from the `~/.docker/config.json`. +1. Remove the Docker Desktop application. Run: -{{< /tab >}} -{{< tab name="Ubuntu" >}} + ```console + $ sudo apt remove docker-desktop + ``` -To remove Docker Desktop for Ubuntu, run: + This removes the Docker Desktop package itself but doesn’t delete all of its files or settings. -```console -$ sudo apt remove docker-desktop -``` +2. Manually remove leftover file. -For a complete cleanup, remove configuration and data files at `$HOME/.docker/desktop`, the symlink at `/usr/local/bin/com.docker.cli`, and purge -the remaining systemd service files. + ```console + $ rm -r $HOME/.docker/desktop + $ sudo rm /usr/local/bin/com.docker.cli + $ sudo apt purge docker-desktop + ``` -```console -$ rm -r $HOME/.docker/desktop -$ sudo rm /usr/local/bin/com.docker.cli -$ sudo apt purge docker-desktop -``` + This removes configuration and data files at `$HOME/.docker/desktop`, the symlink at `/usr/local/bin/com.docker.cli`, and purges the remaining systemd service files. + +3. Clean up Docker config settings. In `$HOME/.docker/config.json`, remove the `credsStore` and `currentContext` properties. -Remove the `credsStore` and `currentContext` properties from `$HOME/.docker/config.json`. Additionally, you must delete any edited configuration files manually. + These entries tell Docker where to store credentials and which context is active. If they remain after uninstalling Docker Desktop, they may conflict with a future Docker setup. {{< /tab >}} {{< tab name="Debian" >}} -To remove Docker Desktop for Debian, run: +To uninstall Docker Desktop for Debian, run: -```console -$ sudo apt remove docker-desktop -``` +1. Remove the Docker Desktop application: -For a complete cleanup, remove configuration and data files at `$HOME/.docker/desktop`, the symlink at `/usr/local/bin/com.docker.cli`, and purge -the remaining systemd service files. + ```console + $ sudo apt remove docker-desktop + ``` -```console -$ rm -r $HOME/.docker/desktop -$ sudo rm /usr/local/bin/com.docker.cli -$ sudo apt purge docker-desktop -``` + This removes the Docker Desktop package itself but doesn’t delete all of its files or settings. -Remove the `credsStore` and `currentContext` properties from `$HOME/.docker/config.json`. Additionally, you must delete any edited configuration files manually. +2. Manually remove leftover file. + + ```console + $ rm -r $HOME/.docker/desktop + $ sudo rm /usr/local/bin/com.docker.cli + $ sudo apt purge docker-desktop + ``` + + This removes configuration and data files at `$HOME/.docker/desktop`, the symlink at `/usr/local/bin/com.docker.cli`, and purges the remaining systemd service files. + +3. Clean up Docker config settings. In `$HOME/.docker/config.json`, remove the `credsStore` and `currentContext` properties. + + These entries tell Docker where to store credentials and which context is active. If they remain after uninstalling Docker Desktop, they may conflict with a future Docker setup. {{< /tab >}} {{< tab name="Fedora" >}} -To remove Docker Desktop for Fedora, run: +To uninstall Docker Desktop for Fedora: -```console -$ sudo dnf remove docker-desktop -``` +1. Remove the Docker Desktop application. Run: + + ```console + $ sudo dnf remove docker-desktop + ``` -For a complete cleanup, remove configuration and data files at `$HOME/.docker/desktop`, the symlink at `/usr/local/bin/com.docker.cli`, and purge -the remaining systemd service files. + This removes the Docker Desktop package itself but doesn’t delete all of its files or settings. -```console -$ rm -r $HOME/.docker/desktop -$ sudo rm /usr/local/bin/com.docker.cli -``` +2. Manually remove leftover file. + + ```console + $ rm -r $HOME/.docker/desktop + $ sudo rm /usr/local/bin/com.docker.cli + $ sudo apt purge docker-desktop + ``` -Remove the `credsStore` and `currentContext` properties from `$HOME/.docker/config.json`. Additionally, you must delete any edited configuration files manually. + This removes configuration and data files at `$HOME/.docker/desktop`, the symlink at `/usr/local/bin/com.docker.cli`, and purges the remaining systemd service files. + +3. Clean up Docker config settings. In `$HOME/.docker/config.json`, remove the `credsStore` and `currentContext` properties. + + These entries tell Docker where to store credentials and which context is active. If they remain after uninstalling Docker Desktop, they may conflict with a future Docker setup. {{< /tab >}} {{< tab name="Arch" >}} -To remove Docker Desktop for Arch, run: +To uninstall Docker Desktop for Arch: -```console -$ sudo pacman -R docker-desktop -``` +1. Remove the Docker Desktop application. Run: -For a complete cleanup, remove configuration and data files at `$HOME/.docker/desktop`, the symlink at `/usr/local/bin/com.docker.cli`, and purge -the remaining systemd service files. + ```console + $ sudo pacman remove docker-desktop + ``` -```console -$ rm -r $HOME/.docker/desktop -$ sudo rm /usr/local/bin/com.docker.cli -$ sudo pacman -Rns docker-desktop -``` + This removes the Docker Desktop package itself but doesn’t delete all of its files or settings. + +2. Manually remove leftover file. + + ```console + $ rm -r $HOME/.docker/desktop + $ sudo rm /usr/local/bin/com.docker.cli + $ sudo apt purge docker-desktop + ``` + + This removes configuration and data files at `$HOME/.docker/desktop`, the symlink at `/usr/local/bin/com.docker.cli`, and purges the remaining systemd service files. + +3. Clean up Docker config settings. In `$HOME/.docker/config.json`, remove the `credsStore` and `currentContext` properties. -Remove the `credsStore` and `currentContext` properties from `$HOME/.docker/config.json`. Additionally, you must delete any edited configuration files manually. + These entries tell Docker where to store credentials and which context is active. If they remain after uninstalling Docker Desktop, they may conflict with a future Docker setup. {{< /tab >}} {{< /tabs >}}