Merge pull request #16241 from jaxgeller/fix-installation-docs

fix typo and cleanup docs for installation.
This commit is contained in:
Sven Dowideit 2015-09-14 09:23:33 +10:00
commit 21cc0ac2c6
2 changed files with 73 additions and 73 deletions

View File

@ -21,7 +21,7 @@ You install Docker using Docker Toolbox. Docker Toolbox includes the following D
* Docker Compose for running the `docker-compose` binary
* Kitematic, the Docker GUI
* a shell preconfigured for a Docker command-line environment
* Oracle VM VirtualBox
* Oracle VM VirtualBox
Because the Docker daemon uses Linux-specific kernel features, you can't run
Docker natively in OS X. Instead, you must use `docker-machine` to create and
@ -62,7 +62,7 @@ practice, work through the exercises on this page.
### Installation
If you have VirtualBox running, you must shut it down before running the
installer.
installer.
1. Go to the [Docker Toolbox](https://www.docker.com/toolbox) page.
@ -72,38 +72,38 @@ installer.
and choosing "Open" from the pop-up menu.
The installer launches the "Install Docker Toolbox" dialog.
![Install Docker Toolbox](/installation/images/mac-welcome-page.png)
4. Press "Continue" to install the toolbox.
The installer presents you with options to customize the standard
installation.
installation.
![Standard install](/installation/images/mac-page-two.png)
By default, the standard Docker Toolbox installation:
* installs binaries for the Docker tools in `/usr/local/bin`
* makes these binaries available to all users
* installs binaries for the Docker tools in `/usr/local/bin`
* makes these binaries available to all users
* installs VirtualBox; or updates any existing installation
Change these defaults by pressing "Customize" or "Change
Install Location."
Install Location."
5. Press "Install" to perform the standard installation.
The system prompts you for your password.
![Password prompt](/installation/images/mac-password-prompt.png)
6. Provide your password to continue with the installation.
When it completes, the installer provides you with some information you can
use to complete some common tasks.
![All finished](/installation/images/mac-page-finished.png)
7. Press "Close" to exit.
@ -111,7 +111,7 @@ and choosing "Open" from the pop-up menu.
To run a Docker container, you:
* create a new (or start an existing) Docker virtual machine
* create a new (or start an existing) Docker virtual machine
* switch your environment to your new VM
* use the `docker` client to create, load, and manage containers
@ -134,10 +134,10 @@ There are two ways to use the installed tools, from the Docker Quickstart Termin
* points the terminal environment to this VM
Once the launch completes, the Docker Quickstart Terminal reports:
![All finished](/installation/images/mac-success.png)
Now, you can run `docker` commands.
Now, you can run `docker` commands.
3. Verify your setup succeeded by running the `hello-world` container.
@ -186,20 +186,20 @@ different shell such as C Shell but the commands are the same.
To see how to connect Docker to this machine, run: docker-machine env default
This creates a new `default` VM in VirtualBox.
![default](/installation/images/default.png)
The command also creates a machine configuration in the
`~/.docker/machine/machines/default` directory. You only need to run the
`create` command once. Then, you can use `docker-machine` to start, stop,
query, and otherwise manage the VM from the command line.
2. List your available machines.
$ docker-machine ls
NAME ACTIVE DRIVER STATE URL SWARM
default * virtualbox Running tcp://192.168.99.101:2376
default * virtualbox Running tcp://192.168.99.101:2376
If you have previously installed the deprecated Boot2Docker application or
run the Docker Quickstart Terminal, you may have a `dev` VM as well. When you
created `default` VM, the `docker-machine` command provided instructions
@ -212,9 +212,9 @@ different shell such as C Shell but the commands are the same.
export DOCKER_HOST="tcp://192.168.99.101:2376"
export DOCKER_CERT_PATH="/Users/mary/.docker/machine/machines/default"
export DOCKER_MACHINE_NAME="default"
# Run this command to configure your shell:
# Run this command to configure your shell:
# eval "$(docker-machine env default)"
4. Connect your shell to the `default` machine.
$ eval "$(docker-machine env default)"
@ -246,9 +246,9 @@ this older VM, you can migrate it.
2. Type the following command.
$ docker-machine create -d virtualbox --virtualbox-import-boot2docker-vm boot2docker-vm docker-vm
3. Use the `docker-machine` command to interact with the migrated VM.
3. Use the `docker-machine` command to interact with the migrated VM.
The `docker-machine` subcommands are slightly different than the `boot2docker`
subcommands. The table below lists the equivalent `docker-machine` subcommand
and what it does:
@ -280,7 +280,7 @@ To verify this, run the following commands:
$ docker-machine ls
NAME ACTIVE DRIVER STATE URL SWARM
default * virtualbox Running tcp://192.168.99.100:2376
default * virtualbox Running tcp://192.168.99.100:2376
The `ACTIVE` machine, in this case `default`, is the one your environment is pointing to.
@ -298,7 +298,7 @@ The `ACTIVE` machine, in this case `default`, is the one your environment is poi
2. Display your running container with `docker ps` command
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
5fb65ff765e9 nginx:latest "nginx -g 'daemon of 3 minutes ago Up 3 minutes 0.0.0.0:49156->443/tcp, 0.0.0.0:49157->80/tcp web
5fb65ff765e9 nginx:latest "nginx -g 'daemon of 3 minutes ago Up 3 minutes 0.0.0.0:49156->443/tcp, 0.0.0.0:49157->80/tcp web
At this point, you can see `nginx` is running as a daemon.
@ -392,7 +392,7 @@ To upgrade Docker Toolbox, download an re-run [the Docker Toolbox
installer](https://docker.com/toolbox/).
## Uninstall Docker Toolbox
## Uninstall Docker Toolbox
To uninstall, do the following:
@ -400,15 +400,15 @@ To uninstall, do the following:
$ docker-machine ls
NAME ACTIVE DRIVER STATE URL SWARM
dev * virtualbox Running tcp://192.168.99.100:2376
my-docker-machine virtualbox Stopped
default virtualbox Stopped
dev * virtualbox Running tcp://192.168.99.100:2376
my-docker-machine virtualbox Stopped
default virtualbox Stopped
2. Remove each machine.
$ docker-machine rm dev
Successfully removed dev
Removing a machine deletes its VM from VirtualBox and from the
`~/.docker/machine/machines` directory.
@ -417,16 +417,16 @@ To uninstall, do the following:
4. Remove the `docker`, `docker-compose`, and `docker-machine` commands from the `/usr/local/bin` folder.
$ rm /usr/local/bin/docker
5. Delete the `~/.docker` folder from your system.
## Learning more
## Learning more
Use `docker-machine help` to list the full command line reference for Docker Machine. For more
information about using SSH or SCP to access a VM, see [the Docker Machine
documentation](https://docs.docker.com/machine/).
You can continue with the [Docker User Guide](/userguide). If you are
interested in using the Kitematic GUI, see the [Kitermatic user
interested in using the Kitematic GUI, see the [Kitematic user
guide](/kitematic/userguide/).

View File

@ -20,7 +20,7 @@ You install Docker using Docker Toolbox. Docker Toolbox includes the following D
* Docker Engine for running the `docker` binary
* Kitematic, the Docker GUI
* a shell preconfigured for a Docker command-line environment
* Oracle VM VirtualBox
* Oracle VM VirtualBox
Because the Docker daemon uses Linux-specific kernel features, you can't run
Docker natively in Windows. Instead, you must use `docker-machine` to create and attach to a Docker VM on your machine. This VM hosts Docker for you on your Windows system.
@ -36,24 +36,24 @@ Your machine must be running Windows 7, 8/8.1 or newer to run Docker. Windows 10
1. Right click the Windows Start Menu and choose **System**.
![Which version](/installation/images/win_ver.png)
If you are using an unsupported version of Windows, you should consider
upgrading your operating system in order to try out Docker.
2. Make sure your CPU supports [virtualization technology](https://en.wikipedia.org/wiki/X86_virtualization)
2. Make sure your CPU supports [virtualization technology](https://en.wikipedia.org/wiki/X86_virtualization)
and virtualization support is enabled in BIOS and recognized by Windows.
#### For Windows 8 or 8.1
Choose **Start > Task Manager** and navigate to the **Performance** tab.
Choose **Start > Task Manager** and navigate to the **Performance** tab.
Under **CPU** you should see the following:
![Release page](/installation/images/virtualization.png)
If virtualization is not enabled on your system, follow the manufacturer's instructions for enabling it.
#### For Windows 7
Run the <a
href="http://www.microsoft.com/en-us/download/details.aspx?id=592"
target="_blank"> Microsoft® Hardware-Assisted Virtualization Detection
@ -80,7 +80,7 @@ Docker container using standard localhost addressing such as `localhost:8000` or
In an Windows installation, the `docker` daemon is running inside a Linux virtual
machine. You use the Windows Docker client to talk to the Docker host VM. Your
Docker containers run inside this host.
Docker containers run inside this host.
![Windows Architecture Diagram](/installation/images/win_docker_host.svg)
@ -93,7 +93,7 @@ practice, work through the exercises on this page.
### Installation
If you have VirtualBox running, you must shut it down before running the
installer.
installer.
1. Go to the [Docker Toolbox](https://www.docker.com/toolbox) page.
@ -102,15 +102,15 @@ installer.
3. Install Docker Toolbox by double-clicking the installer.
The installer launches the "Setup - Docker Toolbox" dialog.
![Install Docker Toolbox](/installation/images/win-welcome.png)
4. Press "Next" to install the toolbox.
The installer presents you with options to customize the standard
installation. By default, the standard Docker Toolbox installation:
* installs executables for the Docker tools in `C:\Program Files\Docker Toolbox`
* installs executables for the Docker tools in `C:\Program Files\Docker Toolbox`
* install VirtualBox; or updates any existing installation
* adds a Docker Inc. folder to your program shortcuts
* updates your `PATH` environment variable
@ -121,23 +121,23 @@ installer.
5. Press "Next" until you reach the "Ready to Install" page.
The system prompts you for your password.
![Install](/installation/images/win-page-6.png)
6. Press "Install" to continue with the installation.
When it completes, the installer provides you with some information you can
use to complete some common tasks.
![All finished](/installation/images/windows-finish.png)
7. Press "Finish" to exit.
## Running a Docker Container
To run a Docker container, you:
* create a new (or start an existing) Docker virtual machine
* create a new (or start an existing) Docker virtual machine
* switch your environment to your new VM
* use the `docker` client to create, load, and manage containers
@ -157,7 +157,7 @@ There are several ways to use the installed tools, from the Docker Quickstart Te
* creates a `default` VM if it doesn't exist, and starts the VM after
* points the terminal environment to this VM
Once the launch completes, you can run `docker` commands.
Once the launch completes, you can run `docker` commands.
3. Verify your setup succeeded by running the `hello-world` container.
@ -194,12 +194,12 @@ There are several ways to use the installed tools, from the Docker Quickstart Te
1. Launch a Windows Command Prompt (cmd.exe).
The `docker-machine` command requires `ssh.exe` in your `PATH` environment
variable. This `.exe` is in the MsysGit `bin` folder.
variable. This `.exe` is in the MsysGit `bin` folder.
2. Add this to the `%PATH%` environment variable by running:
set PATH=%PATH%;"c:\Program Files (x86)\Git\bin"
3. Create a new Docker VM.
docker-machine create --driver virtualbox my-default
@ -213,20 +213,20 @@ There are several ways to use the installed tools, from the Docker Quickstart Te
`C:\USERS\USERNAME\.docker\machine\machines` directory. You only need to run the `create`
command once. Then, you can use `docker-machine` to start, stop, query, and
otherwise manage the VM from the command line.
4. List your available machines.
C:\Users\mary> docker-machine ls
NAME ACTIVE DRIVER STATE URL SWARM
my-default * virtualbox Running tcp://192.168.99.101:2376
my-default * virtualbox Running tcp://192.168.99.101:2376
If you have previously installed the deprecated Boot2Docker application or
run the Docker Quickstart Terminal, you may have a `dev` VM as well.
run the Docker Quickstart Terminal, you may have a `dev` VM as well.
5. Get the environment commands for your new VM.
C:\Users\mary> docker-machine env --shell cmd my-default
6. Connect your shell to the `my-default` machine.
C:\Users\mary> eval "$(docker-machine env my-default)"
@ -242,21 +242,21 @@ There are several ways to use the installed tools, from the Docker Quickstart Te
2. Add `ssh.exe` to your PATH:
PS C:\Users\mary> $Env:Path = "${Env:Path};c:\Program Files (x86)\Git\bin"
3. Create a new Docker VM.
PS C:\Users\mary> docker-machine create --driver virtualbox my-default
4. List your available machines.
C:\Users\mary> docker-machine ls
NAME ACTIVE DRIVER STATE URL SWARM
my-default * virtualbox Running tcp://192.168.99.101:2376
my-default * virtualbox Running tcp://192.168.99.101:2376
5. Get the environment commands for your new VM.
C:\Users\mary> docker-machine env --shell powershell my-default
6. Connect your shell to the `my-default` machine.
C:\Users\mary> eval "$(docker-machine env my-default)"
@ -289,9 +289,9 @@ this older VM, you can migrate it.
2. Type the following command.
$ docker-machine create -d virtualbox --virtualbox-import-boot2docker-vm boot2docker-vm docker-vm
3. Use the `docker-machine` command to interact with the migrated VM.
3. Use the `docker-machine` command to interact with the migrated VM.
The `docker-machine` subcommands are slightly different than the `boot2docker`
subcommands. The table below lists the equivalent `docker-machine` subcommand
and what it does:
@ -347,7 +347,7 @@ uses. You can do this with
[puttygen](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html):
1. Open `puttygen.exe` and load ("File"->"Load" menu) the private key from
%USERPROFILE%\.docker\machine\machines\<name_of_your_machine>
2. Click "Save Private Key".
@ -363,5 +363,5 @@ delete that file yourself.
## Learn more
You can continue with the [Docker User Guide](/userguide). If you are
interested in using the Kitematic GUI, see the [Kitermatic user
interested in using the Kitematic GUI, see the [Kitematic user
guide](/kitematic/userguide/).