Skip to content

Commit 088c702

Browse files
authored
Merge pull request docker#11587 from usha-mandya/engdocs-354
Remove Docker Toolbox docs
2 parents 7ce11ce + 3e97e66 commit 088c702

35 files changed

+179
-974
lines changed

_data/advisories.yaml

-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ texts:
1212
rc: "The Swarm mode feature included in Docker Engine 1.12 is a release candidate feature and might be subject to non backward-compatible changes. Some functionality may change before the feature becomes generally available."
1313
docker4mac-beta: "Docker Desktop for Mac is currently in public beta. Some functionality may change before the product becomes generally available."
1414
docker4win-beta: "Docker Desktop for Windows is currently in public beta. Some functionality may change before the product becomes generally available."
15-
toolbox: "**Legacy desktop solution.** Docker Toolbox is for older Mac and Windows systems that do not meet the requirements of [Docker Desktop for Mac](/docker-for-mac/) and [Docker Desktop for Windows](/docker-for-windows/). We recommend updating to the newer applications, if possible."
1615
kitematic: "**Legacy desktop solution.** Kitematic is a legacy solution, bundled with [Docker Toolbox](/toolbox/overview/). We recommend updating to [Docker Desktop for Mac](/docker-for-mac/) or [Docker Desktop for Windows](/docker-for-windows/) if your system meets the requirements for one of those applications."
1716
swarm: "See [Swarm mode overview](/engine/swarm/) for the orchestration features introduced in Docker Engine 1.12. Only refer to the Docker Swarm documents below for information on the standalone Swarm product."
1817
swarm-standalone: "**You are viewing docs for legacy standalone Swarm.** These topics describe standalone Docker Swarm. In Docker 1.12 and higher, [Swarm mode](/engine/swarm/) is integrated with Docker Engine. Most users should use integrated Swarm mode — a good place to start is [Getting started with swarm mode](/engine/swarm/swarm-tutorial/), [Swarm mode CLI commands](/engine/swarm/#swarm-mode-cli-commands), and the [Get started with Docker walkthrough](/get-started/)). Standalone Docker Swarm is not integrated into the Docker Engine API and CLI commands."

_data/glossary.yaml

+2-25
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,6 @@ aufs: |
88
base image: |
99
A **base image** has no parent image specified in its Dockerfile. It is created
1010
using a Dockerfile with the `FROM scratch` directive.
11-
boot2docker: |
12-
[boot2docker](http://boot2docker.io/) is a lightweight Linux distribution made
13-
specifically to run Docker containers. The boot2docker management tool for Mac
14-
and Windows was deprecated and replaced by [`docker-machine`](#machine) which
15-
you can install with the Docker Toolbox.
1611
btrfs: |
1712
btrfs (B-tree file system) is a Linux [filesystem](#filesystem) that Docker
1813
supports as a storage backend. It is a [copy-on-write](http://en.wikipedia.org/wiki/Copy-on-write)
@@ -81,8 +76,7 @@ Docker Desktop for Mac: |
8176
Mac application, Docker Desktop for Mac uses the macOS Hypervisor
8277
framework, networking, and filesystem. It's the best solution if you want
8378
to build, debug, test, package, and ship Dockerized applications on a
84-
Mac. Docker Desktop for Mac supersedes [Docker Toolbox](#toolbox) as
85-
state-of-the-art Docker on macOS.
79+
Mac.
8680
Docker Desktop for Windows: |
8781
[Docker Desktop for Windows](/docker-for-windows/) is an
8882
easy-to-install, lightweight Docker development environment designed
@@ -92,8 +86,7 @@ Docker Desktop for Windows: |
9286
2016, and gives you the ability to set up and run Windows containers as well as
9387
the standard Linux containers, with an option to switch between the two. Docker
9488
for Windows is the best solution if you want to build, debug, test, package, and
95-
ship Dockerized applications from Windows machines. Docker Desktop for Windows
96-
supersedes [Docker Toolbox](#toolbox) as state-of-the-art Docker on Windows.
89+
ship Dockerized applications from Windows machines.
9790
Docker Hub: |
9891
The [Docker Hub](https://hub.docker.com/) is a centralized resource for working with
9992
Docker and its components. It provides the following services:
@@ -150,11 +143,6 @@ image: |
150143
execution parameters for use within a container runtime. An image typically
151144
contains a union of layered filesystems stacked on top of each other. An image
152145
does not have state and it never changes.
153-
Kitematic: |
154-
A legacy GUI, bundled with [Docker Toolbox](#toolbox), for managing Docker
155-
containers. We recommend upgrading to [Docker Desktop for Mac](#docker_desktop_for_mac)
156-
or [Docker Desktop for Windows](#docker_desktop_for_windows), which have
157-
superseded Kitematic.
158146
layer: |
159147
In an image, a layer is modification to the image, represented by an instruction in the
160148
Dockerfile. Layers are applied in sequence to the base image to create the final image.
@@ -283,17 +271,6 @@ task: |
283271
containers.
284272
285273
![services diagram](/engine/swarm/images/services-diagram.png)
286-
Toolbox: |
287-
[Docker Toolbox](/toolbox/overview/) is a legacy
288-
installer for Mac and Windows users. It uses Oracle VirtualBox for
289-
virtualization.
290-
291-
For Macs running OS X El Capitan 10.11 and newer macOS releases, [Docker Desktop for
292-
Mac](/docker-for-mac/) is the better solution.
293-
294-
For Windows 10 systems that support Microsoft Hyper-V (Professional, Enterprise
295-
and Education), [Docker Desktop for
296-
Windows](/docker-for-windows/) is the better solution.
297274
Union file system: |
298275
Union file systems implement a [union
299276
mount](https://en.wikipedia.org/wiki/Union_mount) and operate by creating

_data/toc.yaml

+2-12
Original file line numberDiff line numberDiff line change
@@ -1154,8 +1154,6 @@ manuals:
11541154
title: User manual
11551155
- path: /docker-for-mac/kubernetes/
11561156
title: Deploy on Kubernetes
1157-
- path: /docker-for-mac/docker-toolbox/
1158-
title: Docker Desktop for Mac vs. Docker Toolbox
11591157
- path: /docker-for-mac/multi-arch/
11601158
title: Leveraging Multi-CPU architecture support
11611159
- path: /docker-for-mac/networking/
@@ -1182,8 +1180,6 @@ manuals:
11821180
title: Deploy on Kubernetes
11831181
- path: /docker-for-windows/networking/
11841182
title: Networking
1185-
- path: /docker-for-windows/docker-toolbox/
1186-
title: Migrate Docker Toolbox
11871183
- path: /docker-for-windows/troubleshoot/
11881184
title: Logs and troubleshooting
11891185
- path: /docker-for-windows/faqs/
@@ -1446,14 +1442,8 @@ manuals:
14461442
title: VMware vSphere
14471443
- path: /machine/migrate-to-machine/
14481444
title: Migrate from Boot2Docker to Machine
1449-
- sectiontitle: Docker Toolbox (legacy)
1450-
section:
1451-
- path: /toolbox/overview/
1452-
title: Toolbox overview
1453-
- path: /toolbox/toolbox_install_mac/
1454-
title: Install Toolbox on Mac
1455-
- path: /toolbox/toolbox_install_windows/
1456-
title: Install Toolbox on Windows
1445+
- path: /docker-for-windows/docker-toolbox/
1446+
title: Docker Toolbox (deprecated)
14571447
- sectiontitle: Kitematic
14581448
section:
14591449
- path: /kitematic/userguide/

compose/install.md

+4-10
Original file line numberDiff line numberDiff line change
@@ -51,24 +51,18 @@ Python package manager or installing Compose as a container.
5151

5252
### Install Compose on macOS
5353

54-
**Docker Desktop for Mac** and **Docker Toolbox** already include Compose along
54+
**Docker Desktop for Mac** includes Compose along
5555
with other Docker apps, so Mac users do not need to install Compose separately.
56-
Docker install instructions for these are here:
57-
58-
* [Get Docker Desktop for Mac](../docker-for-mac/install.md)
59-
* [Get Docker Toolbox](../toolbox/overview.md) (for older systems)
56+
For installation instructions, see [Install Docker Desktop on Mac](../docker-for-mac/install.md).
6057

6158
</div>
6259
<div id="windows" class="tab-pane fade" markdown="1">
6360

6461
### Install Compose on Windows desktop systems
6562

66-
**Docker Desktop for Windows** and **Docker Toolbox** already include Compose
63+
**Docker Desktop for Windows** includes Compose
6764
along with other Docker apps, so most Windows users do not need to
68-
install Compose separately. Docker install instructions for these are here:
69-
70-
* [Get Docker Desktop for Windows](../docker-for-windows/install.md)
71-
* [Get Docker Toolbox](../toolbox/overview.md) (for older systems)
65+
install Compose separately. For install instructions, see [Install Docker Desktop on Windows](../docker-for-windows/install.md).
7266

7367
If you are running the Docker daemon and client directly on Microsoft
7468
Windows Server, follow the instructions in the Windows Server tab.

compose/reference/envvars.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Supported values are: `TLSv1`, `TLSv1_1`, `TLSv1_2`.
8383
## COMPOSE\_CONVERT\_WINDOWS\_PATHS
8484

8585
Enable path conversion from Windows-style to Unix-style in volume definitions.
86-
Users of Docker Machine and Docker Toolbox on Windows should always set this. Defaults to `0`.
86+
Users of Docker Machine on Windows should always set this. Defaults to `0`.
8787
Supported values: `true` or `1` to enable, `false` or `0` to disable.
8888

8989
## COMPOSE\_PATH\_SEPARATOR

docker-for-mac/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ redirect_from:
1515
- /mackit/getting-started/
1616
- /docker-for-mac/osxfs/
1717
- /docker-for-mac/osxfs-caching/
18+
- /docker-for-mac/docker-toolbox/
1819
title: Docker Desktop for Mac user manual
1920
toc_min: 1
2021
toc_max: 2

docker-for-mac/install.md

+1-8
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,10 @@ By downloading Docker Desktop, you agree to the terms of the [Docker Software En
1313

1414
## What to know before you install
1515

16-
> README FIRST for Docker Toolbox and Docker Machine users
17-
>
18-
>If you are already running Docker on your machine, first read
19-
[Docker Desktop for Mac vs. Docker Toolbox](docker-toolbox.md) to understand the
20-
impact of this installation on your existing setup, how to set your environment
21-
for Docker Desktop on Mac, and how the two products can coexist.
22-
2316
**Relationship to Docker Machine**: Installing Docker Desktop on Mac does not affect machines you created with Docker Machine. You have the option to copy containers and images from your local `default` machine (if one exists) to the Docker Desktop [HyperKit](https://github.com/docker/HyperKit/) VM. When
2417
you are running Docker Desktop, you do not need Docker Machine nodes running locally (or anywhere else). With Docker Desktop, you have a new, native
2518
virtualization system running (HyperKit) which takes the place of the
26-
VirtualBox system. To learn more, see [Docker Desktop for Mac vs. Docker Toolbox](docker-toolbox.md).
19+
VirtualBox system.
2720

2821
## System requirements
2922

docker-for-mac/troubleshoot.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -222,23 +222,17 @@ in the Apple documentation, and Docker Desktop [Mac system requirements](install
222222
* If `docker` commands aren't working properly or as expected, you may need to
223223
unset some environment variables, to make sure you are not using the legacy
224224
Docker Machine environment in your shell or command window. Unset the
225-
`DOCKER_HOST` environment variable and related variables.
226-
227-
* If you use bash, use the following command: `unset ${!DOCKER_*}`
228-
229-
* For other shells, unset each environment variable individually as described
230-
in [Setting up to run Docker Desktop on Mac](docker-toolbox.md#setting-up-to-run-docker-desktop-on-mac)
231-
in [Docker Desktop on Mac vs. Docker Toolbox](docker-toolbox.md).
225+
`DOCKER_HOST` environment variable and related variables. If you use bash, use the following command: `unset ${!DOCKER_*}`
232226
233227
* Network connections fail if the macOS Firewall is set to "Block all incoming
234228
connections". You can enable the firewall, but `bootpd` must be allowed
235229
incoming connections so that the VM can get an IP address.
236230
237231
* For the `hello-world-nginx` example, Docker Desktop must be running to get to
238232
the web server on `http://localhost/`. Make sure that the Docker icon is
239-
displayed on the menu bar, and that you run the Docker commands in a shell that is connected to the Docker Desktop Engine (not Engine from Toolbox).
233+
displayed on the menu bar, and that you run the Docker commands in a shell that is connected to the Docker Desktop Engine.
240234
Otherwise, you might start the webserver container but get a "web page not
241-
available" error when you go to `localhost`. For more information on distinguishing between the two environments, see [Docker Desktop on Mac vs. Docker Toolbox](docker-toolbox.md).
235+
available" error when you go to `localhost`.
242236
243237
* If you see errors like `Bind for 0.0.0.0:8080 failed: port is already
244238
allocated` or `listen tcp:0.0.0.0:8080: bind: address is already in use`:

docker-for-windows/docker-toolbox.md

+155-11
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,61 @@
11
---
22
description: Docker Desktop for Windows and Docker Toolbox
33
keywords: windows, alpha, beta, toolbox, docker-machine, tutorial
4-
title: Migrate Docker Toolbox
4+
hide_from_sitemap: true
5+
title: Docker Toolbox
6+
redirect_from:
7+
- /toolbox/
8+
- /toolbox/overview/
9+
- /toolbox/toolbox_install_mac/
10+
- /toolbox/toolbox_install_windows/
11+
- /toolbox/faqs/
12+
- /toolbox/faqs/troubleshoot/
13+
- /docker-for-mac/docker-toolbox/
14+
toc_min: 1
15+
toc_max: 2
516
---
617

7-
This page explains how to migrate your Docker Toolbox disk image, or images if
8-
you have them, to Docker Desktop for Windows.
18+
>**Deprecated**
19+
>
20+
> Docker Toolbox has been deprecated and is no longer in active development. Please use Docker Desktop instead. See [Docker Desktop for Mac](../docker-for-mac/index.md) and [Docker Desktop for Windows](../docker-for-windows/index.md).
21+
{: .warning }
922

10-
## How to migrate Docker Toolbox disk images to Docker Desktop
23+
This page explains how to migrate your Docker Toolbox disk images to Docker Desktop. It also contains instructions on how to uninstall Docker Toolbox from Mac and Windows machines.
1124

12-
Docker Desktop does not propose Toolbox image migration as part of its
13-
installer since version 18.01.0. You can migrate existing Docker
14-
Toolbox images with the steps described below.
25+
## Migrate from Docker Toolbox to Docker Desktop on Mac
26+
27+
You can migrate existing Docker Toolbox images with the steps described below.
28+
29+
In a terminal, while running Toolbox, use `docker commit` to create an image snapshot
30+
from a container, for each container you wish to preserve:
31+
32+
```
33+
$ docker commit nginx
34+
sha256:1bc0ee792d144f0f9a1b926b862dc88b0206364b0931be700a313111025df022
35+
```
36+
37+
Next, export each of these images (and any other images you wish to keep):
38+
39+
```
40+
$ docker save -o nginx.tar sha256:1bc0ee792d144f0f9a1b926b862dc88b0206364b0931be700a313111025df022
41+
```
42+
43+
Next, when running Docker Desktop on Mac, reload all these images:
44+
45+
```
46+
$ docker load -i nginx.tar
47+
Loaded image ID: sha256:1bc0ee792d144f0f9a1b926b862dc88b0206364b0931be700a313111025df022
48+
```
49+
50+
Note these steps will not migrate any `docker volume` contents: these must
51+
be copied across manually.
52+
53+
Finally (optional), if you are done with Docker Toolbox, you can fully
54+
[uninstall](#uninstall-docker-toolbox-on-windows) Docker Toolbox using the instructions described in the following section.
55+
56+
## Migrate from Docker Toolbox to Docker Desktop on Windows
57+
58+
You can migrate existing Docker Toolbox images with the steps described below.
1559

1660
In a terminal, while running Toolbox, use `docker commit` to create an image snapshot
1761
from a container, for each container you wish to preserve:
@@ -37,8 +81,108 @@ Loaded image ID: sha256:1bc0ee792d144f0f9a1b926b862dc88b0206364b0931be700a313111
3781
Note these steps will not migrate any `docker volume` contents: these must
3882
be copied across manually.
3983

40-
## How to uninstall Docker Toolbox
84+
## Uninstall Docker Toolbox
85+
86+
Removing Toolbox involves removing all the Docker components it includes.
87+
88+
A full uninstall also includes removing the local and remote machines
89+
you created with Docker Machine. In some cases, you might want to keep
90+
machines created with Docker Machine. For example, if you plan to re-install Docker Machine as a part of Docker Desktop, you can continue to manage those machines through Docker. Or, if you have remote machines on a cloud provider and you plan to manage them using the provider, you wouldn't want to remove
91+
them. So, the step to remove machines is described here as optional.
92+
93+
### Uninstall Docker Toolbox on Mac
94+
95+
To uninstall Docker Toolbox on Mac:
96+
97+
1. List your machines.
98+
99+
```
100+
$ docker-machine ls
101+
NAME ACTIVE DRIVER STATE URL SWARM
102+
dev * virtualbox Running tcp://192.168.99.100:2376
103+
my-docker-machine virtualbox Stopped
104+
default virtualbox Stopped
105+
```
106+
107+
2. Optionally, remove each machine. For example:
108+
109+
```
110+
$ docker-machine rm my-docker-machine
111+
Successfully removed my-docker-machine
112+
```
113+
114+
This step is optional because if you plan
115+
to re-install Docker Machine as a part
116+
of [Docker Desktop for Mac](../docker-for-mac/index.md), you can import and
117+
continue to manage those machines through Docker.
118+
119+
3. In your "Applications" folder, remove the "Docker" directory,
120+
which contains "Docker Quickstart Terminal" and "Kitematic".
121+
122+
4. Run the following in a command shell to fully remove Kitematic:
123+
124+
```
125+
$ rm -fr ~/Library/Application\ Support/Kitematic
126+
```
127+
128+
5. Remove the `docker`, `docker-compose`, and `docker-machine` commands from
129+
the `/usr/local/bin` folder. Docker Desktop for Mac and Brew may also have
130+
installed them; in case of doubt leave them, or reinstall them via Brew, or
131+
rerun Docker Desktop for Mac (no need to reinstall it).
132+
133+
```
134+
$ rm -f /usr/local/bin/docker
135+
$ rm -f /usr/local/bin/docker-compose
136+
$ rm -f /usr/local/bin/docker-machine
137+
```
138+
139+
6. Optionally, remove the `~/.docker/machine` directory.
140+
141+
This directory stores some configuration and/or state, such as information
142+
about created machines and certificates.
143+
144+
7. Uninstall Oracle VirtualBox, which is installed as a part of the
145+
Toolbox install.
146+
147+
### Uninstall Docker Toolbox on Windows
148+
149+
To uninstall Toolbox on Windows:
150+
151+
1. List your machines.
152+
153+
```
154+
$ docker-machine ls
155+
NAME ACTIVE DRIVER STATE URL SWARM
156+
dev * virtualbox Running tcp://192.168.99.100:2376
157+
my-docker-machine virtualbox Stopped
158+
default virtualbox Stopped
159+
```
160+
161+
2. Optionally, remove each machine. For example:
162+
163+
```
164+
$ docker-machine rm my-docker-machine
165+
Successfully removed my-docker-machine
166+
```
167+
168+
This step is optional because if you plan to re-install Docker Machine as a
169+
part of [Docker Desktop for Windows](../docker-for-windows/index.md), you can
170+
import and continue to manage those machines through Docker.
171+
172+
3. Uninstall Docker Toolbox using Window's standard process for uninstalling programs through the control panel (programs and features).
173+
174+
>**Note**: This process does not remove the `docker-install.exe` file. You must delete that file yourself.
175+
176+
4. Optionally, remove the `C:\Users\<your-user>\.docker` directory.
177+
178+
If you want to remove Docker entirely, you
179+
can verify that the uninstall removed
180+
the `.docker` directory under your user path.
181+
If it is still there, remove it manually.
182+
This directory stores some Docker
183+
program configuration and state, such as
184+
information about created machines and
185+
certificates. You usually don't need to remove this directory.
41186
42-
Whether or not you migrate your Docker Toolbox images, you may decide to
43-
uninstall it. For details on how to perform a clean uninstall of Toolbox,
44-
see [How to uninstall Toolbox](../toolbox/toolbox_install_windows.md#how-to-uninstall-toolbox){: target="_blank" rel="noopener" class="_"}.
187+
5. Uninstall Oracle VirtualBox, which is
188+
installed as a part of the Toolbox install.

docker-for-windows/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ redirect_from:
1010
- /windows/started/
1111
- /winkit/
1212
- /winkit/getting-started/
13+
1314
title: Docker Desktop for Windows user manual
1415
toc_min: 1
1516
toc_max: 2

docker-for-windows/troubleshoot.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ consult the shell's documentation.
434434
For the `hello-world-nginx` example and others, Docker Desktop must be
435435
running to get to the webserver on `http://localhost/`. Make sure that the
436436
Docker whale is showing in the menu bar, and that you run the Docker commands in
437-
a shell that is connected to the Docker Desktop Engine (not Engine from Toolbox). Otherwise, you might start the webserver container but get a "web page
437+
a shell that is connected to the Docker Desktop Engine. Otherwise, you might start the webserver container but get a "web page
438438
not available" error when you go to `docker`.
439439
440440
### How to solve `port already allocated` errors

0 commit comments

Comments
 (0)