Browse code

Initial revisions to b2d doc, new screenshots.

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)

Final revisions to B2D doc.

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)

Fred Lifton authored on 2014/07/22 05:53:58
Showing 3 changed files
1 1
deleted file mode 100644
2 2
Binary files a/docs/sources/installation/images/osx-Boot2Docker-Start-app.png and /dev/null differ
3 3
Binary files a/docs/sources/installation/images/osx-installer.png and b/docs/sources/installation/images/osx-installer.png differ
... ...
@@ -7,13 +7,13 @@ page_keywords: Docker, Docker documentation, requirements, boot2docker, VirtualB
7 7
 > **Note:**
8 8
 > Docker is supported on Mac OS X 10.6 "Snow Leopard" or newer.
9 9
 
10
-The Docker Engine uses Linux-specific kernel features, so to run it on OS X
11
-we need to use a lightweight virtual machine (vm).  You use the OS X Docker client to
10
+Because the Docker Engine uses Linux-specific kernel features, you'll need to use a
11
+lightweight virtual machine (VM) to run it on OS X. You use the OS X Docker client to
12 12
 control the virtualized Docker Engine to build, run, and manage Docker containers.
13 13
 
14
-To make this process easier, we've designed a helper application called
15
-[Boot2Docker](https://github.com/boot2docker/boot2docker) that installs the
16
-virtual machine and runs the Docker daemon.
14
+To make this process easier, we've built a helper application called
15
+[Boot2Docker](https://github.com/boot2docker/boot2docker) that installs a
16
+virtual machine (using VirtualBox) that's all set up to run the Docker daemon.
17 17
 
18 18
 ## Demonstration
19 19
 
... ...
@@ -22,50 +22,67 @@ virtual machine and runs the Docker daemon.
22 22
 ## Installation
23 23
 
24 24
 1. Download the latest release of the [Docker for OS X Installer](
25
-   https://github.com/boot2docker/osx-installer/releases)
25
+   https://github.com/boot2docker/osx-installer/releases) (Look for the green
26
+   Boot2Docker-x.x.x.pkg button near the bottom of the page.)
26 27
 
27
-2. Run the installer, which will install VirtualBox and the Boot2Docker management
28
-   tool.
28
+2. Run the installer by double-clicking the downloaded package, which will install a
29
+VirtualBox VM, Docker itself, and the Boot2Docker management tool.
29 30
    ![](/installation/images/osx-installer.png)
30 31
 
31
-3. Run the `Boot2Docker` app in the `Applications` folder:
32
-   ![](/installation/images/osx-Boot2Docker-Start-app.png)
33
-
34
-   Or, to initialize Boot2Docker manually, open a terminal and run:
32
+3. Locate the `Boot2Docker` app in your `Applications` folder and run it.
33
+   Or, you can initialize Boot2Docker from the command line by running:
35 34
 
36 35
 	     $ boot2docker init
37 36
 	     $ boot2docker start
38 37
 	     $ export DOCKER_HOST=tcp://$(boot2docker ip 2>/dev/null):2375
39 38
 
39
+A terminal window will open and you'll see the virtual machine starting up. 
40 40
 Once you have an initialized virtual machine, you can control it with `boot2docker stop`
41 41
 and `boot2docker start`.
42 42
 
43
+> **Note:**
44
+> If you see a message in the terminal that looks something like this:
45
+>
46
+>    `To connect the Docker client to the Docker daemon, please set: export 
47
+DOCKER_HOST=tcp://192.168.59.103:2375`
48
+> 
49
+you can safely set the evironment variable as instructed.
50
+
51
+View the
52
+[Boot2Docker ReadMe](https://github.com/boot2docker/boot2docker/blob/master/README.md)
53
+for more information.
54
+
43 55
 ## Upgrading
44 56
 
45 57
 1. Download the latest release of the [Docker for OS X Installer](
46 58
    https://github.com/boot2docker/osx-installer/releases)
47 59
 
48
-2. Run the installer, which will update VirtualBox and the Boot2Docker management
49
-   tool.
60
+2. If Boot2Docker is currently running, stop it with `boot2docker stop`. Then, run
61
+the installer package, which will update Docker and the Boot2Docker management tool.
50 62
 
51
-3. To upgrade your existing virtual machine, open a terminal and run:
63
+3. To complete the upgrade, you also need to update your existing virtual machine. Open a
64
+terminal window and run:
52 65
 
53 66
         $ boot2docker stop
54 67
         $ boot2docker download
55 68
         $ boot2docker start
56 69
 
70
+This will download an .iso containing a fresh VM and start it up.
71
+
57 72
 ## Running Docker
58 73
 
59
-From your terminal, you can test that Docker is running with the small `hello-world` example image.
60
-Start the vm and then run:
74
+From your terminal, you can test that Docker is running with our small `hello-world`
75
+example image:
76
+Start the vm (`boot2docker start`) and then run:
61 77
 
62 78
     $ docker run hello-world
63 79
 
64
-This should download the very small `hello-world` image and print a `Hello from Docker.` message.
80
+This should download the `hello-world` image, which then creates a small
81
+container with an executable that prints a brief `Hello from Docker.` message.
65 82
 
66 83
 ## Container port redirection
67 84
 
68
-The latest version of `boot2docker` sets up a host only network adaptor which provides
85
+The latest version of `boot2docker` sets up a host-only network adaptor which provides
69 86
 access to the container's ports.
70 87
 
71 88
 If you run a container with an exposed port,
... ...
@@ -76,14 +93,16 @@ then you should be able to access that Nginx server using the IP address reporte
76 76
 
77 77
     $ boot2docker ip
78 78
 
79
-Typically, it is 192.168.59.103, but it could get changed by Virtualbox's DHCP
80
-implementation.
79
+Typically, it is 192.168.59.103:2375, but VirtualBox's DHCP implementation might change
80
+this address in the future.
81 81
 
82 82
 # Further details
83 83
 
84
-If you are curious, the username for the boot2docker default user is `docker` and the password is `tcuser`.
84
+If you are curious, the username for the boot2docker default user is `docker` and the
85
+password is `tcuser`.
85 86
 
86
-The Boot2Docker management tool provides several commands:
87
+The Boot2Docker management tool provides several additional commands for working with the
88
+VM and Docker:
87 89
 
88 90
     $ ./boot2docker
89 91
     Usage: ./boot2docker [<options>]