Skip to content

ENGDOCS-2515b #22378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 8, 2025
Merged

ENGDOCS-2515b #22378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53017bc
ENGDOCS-2515b
aevesdocker Apr 7, 2025
1518740
edits
aevesdocker Apr 7, 2025
06893d2
review edits
aevesdocker Apr 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion content/manuals/desktop/images/notifications.svg
View file
Open in desktop

This file was deleted.

37 changes: 22 additions & 15 deletions content/manuals/desktop/settings-and-maintenance/backup-and-restore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
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
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]
>
Expand All @@ -18,37 +18,44 @@ 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.

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 <my-backup-image>
```

- If you saved a `.tar` file:

```console
$ docker image load -i images.tar
```
Comment on lines +44 to +56
Copy link
Contributor

@sarahsanders-docker sarahsanders-docker Apr 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nothing to change here, just such a good improvement! much more straightforward

Copy link
Contributor Author

@aevesdocker aevesdocker Apr 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️


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).
33 changes: 18 additions & 15 deletions content/manuals/desktop/settings-and-maintenance/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@

- **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 `<Tab>` 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).

Expand All @@ -44,6 +46,12 @@
- {{< 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
Expand All @@ -54,12 +62,6 @@

- {{< 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]
Expand Down Expand Up @@ -88,7 +90,7 @@

- **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.

Expand Down Expand Up @@ -128,7 +130,7 @@

- **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.

Expand Down Expand Up @@ -429,8 +431,6 @@
- **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.

Expand Down Expand Up @@ -499,12 +499,15 @@
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

Expand All @@ -520,8 +523,8 @@
```
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).

Check warning on line 526 in content/manuals/desktop/settings-and-maintenance/settings.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.RecommendedWords] Consider using 'let' instead of 'Allow'

Raw Output:
{"message": "[Docker.RecommendedWords] Consider using 'let' instead of 'Allow'", "location": {"path": "content/manuals/desktop/settings-and-maintenance/settings.md", "range": {"start": {"line": 526, "column": 5}}}, "severity": "INFO"}

- **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).

Check warning on line 528 in content/manuals/desktop/settings-and-maintenance/settings.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.RecommendedWords] Consider using 'let' instead of 'Allow'

Raw Output:
{"message": "[Docker.RecommendedWords] Consider using 'let' instead of 'Allow'", "location": {"path": "content/manuals/desktop/settings-and-maintenance/settings.md", "range": {"start": {"line": 528, "column": 5}}}, "severity": "INFO"}

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).
7 changes: 3 additions & 4 deletions content/manuals/desktop/troubleshoot-and-support/feedback.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

### 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.

Check failure on line 15 in content/manuals/desktop/troubleshoot-and-support/feedback.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Docker Team' instead of 'Docker team'.

Raw Output:
{"message": "[Vale.Terms] Use 'Docker Team' instead of 'Docker team'.", "location": {"path": "content/manuals/desktop/troubleshoot-and-support/feedback.md", "range": {"start": {"line": 15, "column": 146}}}, "severity": "ERROR"}

You can also use the `docker feedback` command to submit feedback directly from the command line.

Expand All @@ -23,8 +23,7 @@
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)

Expand All @@ -36,7 +35,7 @@
- [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
Expand Down
Loading