Skip to content

Commit 0b75a0a

Browse files
committed
more pages
1 parent 13ac79c commit 0b75a0a

14 files changed

+54
-91
lines changed
-58.1 KB
Binary file not shown.
-75.8 KB
Binary file not shown.
-71.1 KB
Binary file not shown.
-91.8 KB
Binary file not shown.
-7.1 KB
Binary file not shown.
-39.4 KB
Binary file not shown.
-114 KB
Binary file not shown.

content/manuals/desktop/use-desktop/_index.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,39 @@ In addition, the Docker Desktop Dashboard lets you:
2828
- Get to the [Docker Scout](../../scout/_index.md) dashboard.
2929
- Navigate to [Docker Extensions](/manuals/extensions/_index.md).
3030

31+
## Integrated terminal
32+
33+
From the Docker Dashboard footer, you can use the integrated terminal, on a running
34+
container, directly within Docker Desktop. You are able to quickly run commands
35+
within your container so you can understand its current state or debug when
36+
something goes wrong.
37+
38+
Using the integrated terminal is the same as running one of the following commands:
39+
40+
- `docker exec -it <container-id> /bin/sh`
41+
- `docker exec -it <container-id> cmd.exe` when accessing Windows containers
42+
- `docker debug <container-id>` when using debug mode
43+
44+
The integrated terminal:
45+
46+
- Persists your session and **Debug mode** setting if you navigate to another
47+
part of the Docker Desktop Dashboard and then return.
48+
- Supports copy, paste, search, and clearing your session.
49+
- When not using debug mode, it automatically detects the default user for a
50+
running container from the image's Dockerfile. If no user is specified, or
51+
you're using debug mode, it defaults to `root`.
52+
53+
#### Open the integrated terminal
54+
55+
To open the integrated terminal, either:
56+
57+
- Hover over your running container and under the **Actions** column, select the **Show container actions**
58+
menu. From the drop-down menu, select **Open in terminal**.
59+
- Or, select the **Terminal** icon located in the bottom-right corner, next to the version number.
60+
61+
To use your external terminal, navigate to the **General** tab in **Settings**
62+
and select the **System default** option under **Choose your terminal**.
63+
3164
## Quick search
3265

3366
Use Quick Search, which is located in the Docker Dashboard header, to search for:

content/manuals/desktop/use-desktop/builds.md

Lines changed: 10 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,22 @@ keywords: Docker Dashboard, manage, gui, dashboard, builders, builds
66
weight: 40
77
---
88

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

11-
12-
e **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).
13-
14-
The **Builds** view is a simple interface that lets you inspect your build
15-
history and manage builders using Docker Desktop.
16-
17-
Opening the **Builds** view in Docker Desktop displays a list of completed builds.
18-
By default, the list is sorted by date, showing the most recent builds at the top.
19-
You can switch to **Active builds** to view any ongoing builds.
20-
21-
![Build UI screenshot active builds](../images/build-ui-active-builds.webp)
11+
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.
2212

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

2717
## Show build list
2818

29-
Select the **Builds** view in the Docker Desktop Dashboard to open the build list.
19+
Open the **Builds** view from the Docker Dashboard to access:
3020

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

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

4026
### Builder settings
4127

@@ -50,7 +36,9 @@ Docker Desktop settings.
5036
The **Import builds** button lets you import build records for builds by other
5137
people, or builds in a CI environment. When you've imported a build record, it
5238
gives you full access to the logs, traces, and other data for that build,
53-
directly in Docker Desktop. The [build summary](/manuals/build/ci/github-actions/build-summary.md)
39+
directly in Docker Desktop.
40+
41+
The [build summary](/manuals/build/ci/github-actions/build-summary.md)
5442
for the `docker/build-push-action` and `docker/bake-action` GitHub Actions
5543
includes a link to download the build records, for inspecting CI jobs with
5644
Docker Desktop.
@@ -66,8 +54,6 @@ If you're inspecting a multi-platform build, the drop-down menu in the
6654
top-right of this tab lets you filter the information down to a specific
6755
platform:
6856

69-
![Platform filter](../images/build-ui-platform-menu.webp?w=400)
70-
7157
The **Source details** section shows information about the frontend
7258
[frontend](/manuals/build/buildkit/frontend.md) and, if available,
7359
the source code repository used for the build.
@@ -82,8 +68,6 @@ showing a breakdown of the build execution from various angles.
8268
- **Cache usage** shows the extent to which build operations were cached.
8369
- **Parallel execution** shows how much of the build execution time was spent running steps in parallel.
8470

85-
![Build timing charts](../images/build-ui-timing-chart.webp)
86-
8771
The chart colors and legend keys describe the different build operations. Build
8872
operations are defined as follows:
8973

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

174-
![Build error displayed inline in the Dockerfile](../images/build-ui-error.webp)
175-
176158
### Build logs
177159

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

199-
![Build history chart](../images/build-ui-history.webp)
200-
201181
You can navigate to and inspect a related build by selecting it in the chart,
202182
or using the **Past builds** list below the chart.
203183

204184
## Manage builders
205185

206-
The **Builder settings** view in the Docker Desktop settings lets you:
186+
The **Builder** tab in **Settings** lets you:
207187

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

213-
![Builder settings drop-down](../images/build-ui-manage-builders.webp)
214-
215193
For more information about managing builders, see [Change settings](/manuals/desktop/settings-and-maintenance/settings.md#builders)

content/manuals/desktop/use-desktop/container.md

Lines changed: 3 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ When you [inspect a container](#inspect-a-container), the **Stats** tab displays
3131

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

34-
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.
34+
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.
3535

3636
### Logs
3737

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

5454
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.
5555

56-
### Integrated terminal
57-
58-
From the **Exec** tab, you can use the integrated terminal, on a running
59-
container, directly within Docker Desktop. You are able to quickly run commands
60-
within your container so you can understand its current state or debug when
61-
something goes wrong.
62-
63-
Using the integrated terminal is the same as running one of the following commands:
64-
65-
- `docker exec -it <container-id> /bin/sh`
66-
- `docker exec -it <container-id> cmd.exe` when accessing Windows containers
67-
- `docker debug <container-id>` when using debug mode
68-
69-
The integrated terminal:
70-
71-
- Persists your session and **Debug mode** setting if you navigate to another
72-
part of the Docker Desktop Dashboard and then return.
73-
- Supports copy, paste, search, and clearing your session.
74-
- When not using debug mode, it automatically detects the default user for a
75-
running container from the image's Dockerfile. If no user is specified, or
76-
you're using debug mode, it defaults to `root`.
77-
78-
#### Open the integrated terminal
79-
80-
To open the integrated terminal, either:
81-
82-
- Hover over your running container and under the **Actions** column, select the **Show container actions**
83-
menu. From the drop-down menu, select **Open in terminal**.
84-
- Or, select the container and then select the **Exec** tab.
85-
86-
To use your external terminal, navigate to the **General** tab in **Settings**
87-
and select the **System default** option under **Choose your terminal**.
88-
89-
#### Open the integrated terminal in debug mode
56+
### Debug
9057

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

@@ -103,9 +70,7 @@ To open the integrated terminal in debug mode:
10370

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

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

0 commit comments

Comments
 (0)