Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 8 additions & 4 deletions content/manuals/desktop/features/gordon/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,15 +102,19 @@ Ask Gordon is not enabled by default. To enable the feature:

After signing in to your Docker Account, enable the Docker AI feature:

1. Open the **Settings** view in Docker Desktop.
2. Navigate to **Features in development**.
3. Check the **Enable Docker AI** checkbox.
1. Navigate to the **Features in development** tab in settings.
2. Under the **Experimental features** tab, select **Access experimental features**.
3. Select **Apply and restart**.
4. Quit and reopen Docker Desktop to ensure the changes take effect.
5. Open the **Settings** view in Docker Desktop.
6. Navigate to **Features in development**.
7. From the **Beta** tab, check the **Enable Docker AI** checkbox.

The Docker AI terms of service agreement is displayed. You must agree to the
terms before you can enable the feature. Review the terms and select **Accept
and enable** to continue.

4. Select **Apply & restart**.
8. Select **Apply & restart**.

## Using Ask Gordon

Expand Down
10 changes: 9 additions & 1 deletion content/manuals/desktop/features/model-runner.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,15 @@ The Docker Model Runner plugin lets you:

Models are pulled from Docker Hub the first time they're used and stored locally. They're loaded into memory only at runtime when a request is made, and unloaded when not in use to optimize resources. Since models can be large, the initial pull may take some time — but after that, they're cached locally for faster access. You can interact with the model using [OpenAI-compatible APIs](#what-api-endpoints-are-available).

Docker Model Runner is enabled by default in Docker Desktop.
## Enable Docker Model Runner

1. Navigate to the **Features in development** tab in settings.
2. Under the **Experimental features** tab, select **Access experimental features**.
3. Select **Apply and restart**.
4. Quit and reopen Docker Desktop to ensure the changes take effect.
5. Open the **Settings** view in Docker Desktop.
6. Navigate to **Features in development**.
7. From the **Beta** tab, check the **Enable Docker Model Runner** setting.

## Available commands

Expand Down
Binary file not shown.
Binary file removed content/manuals/desktop/images/build-ui-error.webp
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed content/manuals/desktop/images/builds-view.webp
Binary file not shown.
Binary file added content/manuals/desktop/images/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed content/manuals/desktop/images/dashboard.webp
Binary file not shown.
42 changes: 29 additions & 13 deletions content/manuals/desktop/use-desktop/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,48 @@ aliases:

When you open Docker Desktop, the Docker Desktop Dashboard displays.

![Docker Desktop Dashboard on Containers view](../images/dashboard.webp)
![Docker Desktop Dashboard on Containers view](../images/dashboard.png)

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](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 image vulnerabilities. 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](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](volumes.md).

The **Builds** view lets you inspect your build history and manage builders. By default, it displays a list of all your ongoing and completed builds. [Explore builds](builds.md).
It provides a centralized interface to manage your [containers](container.md), [images](images.md), [volumes](volumes.md), and [builds](builds.md).

In addition, the Docker Desktop Dashboard lets you:

- Use [Ask Gordon](/manuals/desktop/features/gordon/_index.md), a personal AI assistant embedded in Docker Desktop and the Docker CLI. It's designed to streamline your workflow and help you make the most of the Docker ecosystem.
- Navigate to the **Settings** menu to configure your Docker Desktop settings. Select the **Settings** icon in the Dashboard header.
- Access the **Troubleshoot** menu to debug and perform restart operations. Select the **Troubleshoot** icon in the Dashboard header.
- Be notified of new releases, installation progress updates, and more in the **Notifications center**. Select the bell icon in the bottom-right corner of the Docker Desktop Dashboard to access the notification center.
- Access the **Learning center** from the Dashboard header. It helps you get started with quick in-app walkthroughs and provides other resources for learning about Docker.

For a more detailed guide about getting started, see [Get started](/get-started/introduction/_index.md).
- Get to the [Docker Scout](../../scout/_index.md) dashboard.
- Check the status of Docker services.
- Access [Docker Hub](/manuals/docker-hub/_index.md) to search, browse, pull, run, or view details
of images.
- Get to the [Docker Scout](../../scout/_index.md) dashboard.
- Navigate to [Docker Extensions](/manuals/extensions/_index.md).

## Docker terminal

From the Docker Dashboard footer, you can use the integrated terminal directly within Docker Desktop.

The integrated terminal:

- Persists your session if you navigate to another
part of the Docker Desktop Dashboard and then return.
- Supports copy, paste, search, and clearing your session.

#### Open the integrated terminal

To open the integrated terminal, either:

- Hover over your running container and under the **Actions** column, select the **Show container actions**
menu. From the drop-down menu, select **Open in terminal**.
- Or, select the **Terminal** icon located in the bottom-right corner, next to the version number.

To use your external terminal, navigate to the **General** tab in **Settings**
and select the **System default** option under **Choose your terminal**.

## Quick search

From the Docker Desktop Dashboard you can use Quick Search, which is located in the Dashboard header, to search for:
Use Quick Search, which is located in the Docker Dashboard header, to search for:

- Any container or Compose application on your local system. You can see an overview of associated environment variables or perform quick actions, such as start, stop, or delete.

Expand All @@ -49,9 +65,9 @@ From the Docker Desktop Dashboard you can use Quick Search, which is located in

## The Docker menu

Docker Desktop also provides an easy-access tray icon that appears in the taskbar and is referred to as the Docker menu {{< inline-image src="../../assets/images/whale-x.svg" alt="whale menu" >}}.
Docker Desktop also includes a tray icon, referred to as the Docker menu {{< inline-image src="../../assets/images/whale-x.svg" alt="whale menu" >}} for quick access.

To display the Docker menu, select the {{< inline-image src="../../assets/images/whale-x.svg" alt="whale menu" >}} icon. It displays the following options:
Select the {{< inline-image src="../../assets/images/whale-x.svg" alt="whale menu" >}} icon in your taskbar to open options such as:

- **Dashboard**. This takes you to the Docker Desktop Dashboard.
- **Sign in/Sign up**
Expand Down
39 changes: 10 additions & 29 deletions content/manuals/desktop/use-desktop/builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,22 @@ keywords: Docker Dashboard, manage, gui, dashboard, builders, builds
weight: 40
---

![Builds view in Docker Desktop](../images/builds-view.webp)
The **Builds** view provides an interactive interface for inspecting build history, monitoring active builds, and managing builders directly in Docker Desktop.

The **Builds** view is a simple interface that lets you inspect your build
history and manage builders using Docker Desktop.

Opening the **Builds** view in Docker Desktop displays a list of completed builds.
By default, the list is sorted by date, showing the most recent builds at the top.
You can switch to **Active builds** to view any ongoing builds.

![Build UI screenshot active builds](../images/build-ui-active-builds.webp)
By default, the **Build history** tab displays a list of completed builds, sorted by date (newest first). Switch to the **Active builds** tab to view ongoing builds.

If you're connected to a cloud builder through [Docker Build Cloud](../../build-cloud/_index.md),
the Builds view also lists any active or completed cloud builds by other team members
connected to the same cloud builder.

## Show build list

Select the **Builds** view in the Docker Desktop Dashboard to open the build list.
Open the **Builds** view from the Docker Dashboard to access:

The build list shows your completed and ongoing builds. The **Build history**
tab shows completed historical builds, and from here you can inspect the build
logs, dependencies, traces, and more. The **Active builds** tab shows builds
that are currently running.
- **Build history**: Completed builds with access to logs, dependencies, traces, and more
- **Active builds**: Builds currently in progress

The list shows builds for your active, running builders. It doesn't list builds
for inactive builders: builders that you've removed from your system, or
builders that have been stopped.
Only builds from active, running builders are listed. Builds from removed or stopped builders are not shown.

### Builder settings

Expand All @@ -47,7 +36,9 @@ Docker Desktop settings.
The **Import builds** button lets you import build records for builds by other
people, or builds in a CI environment. When you've imported a build record, it
gives you full access to the logs, traces, and other data for that build,
directly in Docker Desktop. The [build summary](/manuals/build/ci/github-actions/build-summary.md)
directly in Docker Desktop.

The [build summary](/manuals/build/ci/github-actions/build-summary.md)
for the `docker/build-push-action` and `docker/bake-action` GitHub Actions
includes a link to download the build records, for inspecting CI jobs with
Docker Desktop.
Expand All @@ -63,8 +54,6 @@ If you're inspecting a multi-platform build, the drop-down menu in the
top-right of this tab lets you filter the information down to a specific
platform:

![Platform filter](../images/build-ui-platform-menu.webp?w=400)

The **Source details** section shows information about the frontend
[frontend](/manuals/build/buildkit/frontend.md) and, if available,
the source code repository used for the build.
Expand All @@ -79,8 +68,6 @@ showing a breakdown of the build execution from various angles.
- **Cache usage** shows the extent to which build operations were cached.
- **Parallel execution** shows how much of the build execution time was spent running steps in parallel.

![Build timing charts](../images/build-ui-timing-chart.webp)

The chart colors and legend keys describe the different build operations. Build
operations are defined as follows:

Expand Down Expand Up @@ -168,8 +155,6 @@ If the build failed, an **Error** tab displays instead of the **Source** tab.
The error message is inlined in the Dockerfile source,
indicating where the failure happened and why.

![Build error displayed inline in the Dockerfile](../images/build-ui-error.webp)

### Build logs

The **Logs** tab displays the build logs.
Expand All @@ -193,20 +178,16 @@ helping you identify patterns and shifts in build operations over time.
For instance, significant spikes in build duration or a high number of cache misses
could signal opportunities for optimizing the Dockerfile.

![Build history chart](../images/build-ui-history.webp)

You can navigate to and inspect a related build by selecting it in the chart,
or using the **Past builds** list below the chart.

## Manage builders

The **Builder settings** view in the Docker Desktop settings lets you:
The **Builder** tab in **Settings** lets you:

- Inspect the state and configuration of active builders
- Start and stop a builder
- Delete build history
- Add or remove builders (or connect and disconnect, in the case of cloud builders)

![Builder settings drop-down](../images/build-ui-manage-builders.webp)

For more information about managing builders, see [Change settings](/manuals/desktop/settings-and-maintenance/settings.md#builders)
56 changes: 16 additions & 40 deletions content/manuals/desktop/use-desktop/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@ linkTitle: Containers
weight: 10
---

The **Containers** view lists all your running containers and applications. You must have running or stopped containers and applications to see them listed.
The **Containers** view lists all running and stopped containers and applications. It provides a clean interface to manage the lifecycle of your containers, interact with running applications, and inspect Docker objects—including Docker Compose apps.

## Container actions

Use the **Search** field to search for any specific container.
Use the **Search** field to find a specific container by name.

From the **Containers** view you can perform the following actions:
- Pause/Resume
- Stop/Start/Restart
From the **Containers** view you can:
- Start, stop, pause, resume, or restart containers
- View image packages and CVEs
- Delete
- Delete containers
- Open the application in VS code
- Open the port exposed by the container in a browser
- Copy docker run. This lets you share container run details or modify certain parameters.
- Copy the `docker run` command for reuse or modification
- Use [Docker Debug](#execdebug)

## Resource usage

Expand All @@ -31,7 +31,7 @@ When you [inspect a container](#inspect-a-container), the **Stats** tab displays

You can obtain detailed information about the container when you select it.

From here, you can use the quick action buttons to perform various actions such as pause, resume, start or stop, or explore the **Logs**, **Inspect**, **Bind mounts**, **Exec**, **Files**, and **Stats** tabs.
From here, you can use the quick action buttons to perform various actions such as pause, resume, start or stop, or explore the **Logs**, **Inspect**, **Bind mounts**, **Debug**, **Files**, and **Stats** tabs.

### Logs

Expand All @@ -53,40 +53,18 @@ Select **Logs** to see logs from the container. You can also:

Select **Inspect** to view low-level information about the container. It displays the local path, version number of the image, SHA-256, port mapping, and other details.

### Integrated terminal
### Exec/Debug

From the **Exec** tab, you can use the integrated terminal, on a running
container, directly within Docker Desktop. You are able to quickly run commands
within your container so you can understand its current state or debug when
something goes wrong.
If you have not enabled Docker Debug in settings, the **Exec** tab displays. It lets you quickly run commands within your running container.

Using the integrated terminal is the same as running one of the following commands:
Using the **Exec** tab is the same as running one of the following commands:

- `docker exec -it <container-id> /bin/sh`
- `docker exec -it <container-id> cmd.exe` when accessing Windows containers
- `docker debug <container-id>` when using debug mode

The integrated terminal:
For more details, see the [`docker exec` CLI reference](/reference/cli/docker/exec/).

- Persists your session and **Debug mode** setting if you navigate to another
part of the Docker Desktop Dashboard and then return.
- Supports copy, paste, search, and clearing your session.
- When not using debug mode, it automatically detects the default user for a
running container from the image's Dockerfile. If no user is specified, or
you're using debug mode, it defaults to `root`.

#### Open the integrated terminal

To open the integrated terminal, either:

- Hover over your running container and under the **Actions** column, select the **Show container actions**
menu. From the drop-down menu, select **Open in terminal**.
- Or, select the container and then select the **Exec** tab.

To use your external terminal, navigate to the **General** tab in **Settings**
and select the **System default** option under **Choose your terminal**.

#### Open the integrated terminal in debug mode
If you have enabled Docker Debug in settings, or toggled on **Debug mode** to the right of the tab options, the **Debug** tab displays.

Debug mode requires a [Pro, Team, or Business subscription](/subscription/details/). Debug mode has several advantages, such as:

Expand All @@ -95,19 +73,17 @@ Debug mode requires a [Pro, Team, or Business subscription](/subscription/detail
- The ability to access containers that don't have a shell, for example, slim or
distroless containers.

To open the integrated terminal in debug mode:
To use debug mode:

1. Sign in to Docker Desktop with an account that has a Pro, Team, or Business
subscription.
2. After you're signed in, either:

- Hover over your running container and under the **Actions** column, select the **Show container actions**
menu. From the drop-down menu, select **Use Docker Debug**.
- Or, select the container and then select the **Debug** tab. If the
**Debug** tab isn't visible, select the **Exec** tab and then enable the
**Debug mode** setting.
- Or, select the container and then select the **Debug** tab.

To use debug mode by default when accessing the integrated terminal, navigate to
To use debug mode by default, navigate to
the **General** tab in **Settings** and select the **Enable Docker Debug by
default** option.

Expand Down
7 changes: 5 additions & 2 deletions content/manuals/desktop/use-desktop/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ linkTitle: Images
weight: 20
---


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 image vulnerabilities. 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](images.md).

The **Images** view 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 Hub images once you have signed in to Docker Hub. This allows you to collaborate with your team and manage your images directly through Docker Desktop.
Expand Down Expand Up @@ -87,10 +90,10 @@ To remove individual images, select the bin icon.

The **Images** view also allows you to manage and interact with images in Docker Hub repositories.
By default, when you go to **Images** in Docker Desktop, you see a list of images that exist in your local image store.
The **Local** and **Hub repositories** tabs near the top toggles between viewing images in your local image store,
The **Local** and **Docker Hub repositories** tabs near the top toggles between viewing images in your local image store,
and images in remote Docker Hub repositories that you have access to.

Switching to the **Hub repositories** tab prompts you to sign in to your Docker Hub account, if you're not already signed in.
Switching to the **Docker Hub repositories** tab prompts you to sign in to your Docker Hub account, if you're not already signed in.
When signed in, it shows you a list of images in Docker Hub organizations and repositories that you have access to.

Select an organization from the drop-down to view a list of repositories for that organization.
Expand Down
Loading