浏览代码

Merge pull request #1959 from charleswhchan/patch-1

Touch up documentation for Docker Compose.
moxiegirl 10 年之前
父节点
当前提交
f49fc1867c
共有 2 个文件被更改,包括 16 次插入21 次删除
  1. 8 12
      docs/index.md
  2. 8 9
      docs/install.md

+ 8 - 12
docs/index.md

@@ -74,7 +74,7 @@ Next, you'll want to make a directory for the project:
     $ mkdir composetest
     $ mkdir composetest
     $ cd composetest
     $ cd composetest
 
 
-Inside this directory, create `app.py`, a simple web app that uses the Flask
+Inside this directory, create `app.py`, a simple Python web app that uses the Flask
 framework and increments a value in Redis. Don't worry if you don't have Redis installed, docker is going to take care of that for you when we [define services](#define-services):
 framework and increments a value in Redis. Don't worry if you don't have Redis installed, docker is going to take care of that for you when we [define services](#define-services):
 
 
     from flask import Flask
     from flask import Flask
@@ -113,12 +113,12 @@ This tells Docker to:
 * Build an image starting with the Python 2.7 image.
 * Build an image starting with the Python 2.7 image.
 * Add the current directory `.` into the path `/code` in the image.
 * Add the current directory `.` into the path `/code` in the image.
 * Set the working directory to `/code`.
 * Set the working directory to `/code`.
-* Install your Python dependencies.
+* Install the Python dependencies.
 * Set the default command for the container to `python app.py`
 * Set the default command for the container to `python app.py`
 
 
 For more information on how to write Dockerfiles, see the [Docker user guide](https://docs.docker.com/userguide/dockerimages/#building-an-image-from-a-dockerfile) and the [Dockerfile reference](http://docs.docker.com/reference/builder/).
 For more information on how to write Dockerfiles, see the [Docker user guide](https://docs.docker.com/userguide/dockerimages/#building-an-image-from-a-dockerfile) and the [Dockerfile reference](http://docs.docker.com/reference/builder/).
 
 
-You can test that this builds by running `docker build -t web .`.
+You can build the image by running `docker build -t web .`.
 
 
 ### Define services
 ### Define services
 
 
@@ -135,18 +135,14 @@ Next, define a set of services using `docker-compose.yml`:
     redis:
     redis:
       image: redis
       image: redis
 
 
-This defines two services:
-
-#### web
+This template defines two services, `web` and `redis`. The `web` service:
 
 
 * Builds from the `Dockerfile` in the current directory.
 * Builds from the `Dockerfile` in the current directory.
 * Forwards the exposed port 5000 on the container to port 5000 on the host machine.
 * Forwards the exposed port 5000 on the container to port 5000 on the host machine.
-* Connects the web container to the Redis service via a link.
-* Mounts the current directory on the host to `/code` inside the container allowing you to modify the code without having to rebuild the image.
-
-#### redis
+* Mounts the current directory on the host to ``/code` inside the container allowing you to modify the code without having to rebuild the image.
+* Links the web container to the Redis service.
 
 
-* Uses the public [Redis](https://registry.hub.docker.com/_/redis/) image which gets pulled from the Docker Hub registry.
+The `redis` service uses the latest public [Redis](https://registry.hub.docker.com/_/redis/) image pulled from the Docker Hub registry.
 
 
 ### Build and run your app with Compose
 ### Build and run your app with Compose
 
 
@@ -163,7 +159,7 @@ Now, when you run `docker-compose up`, Compose will pull a Redis image, build an
 
 
 If you're using [Docker Machine](https://docs.docker.com/machine), then `docker-machine ip MACHINE_VM` will tell you its address and you can open `http://MACHINE_VM_IP:5000` in a browser.
 If you're using [Docker Machine](https://docs.docker.com/machine), then `docker-machine ip MACHINE_VM` will tell you its address and you can open `http://MACHINE_VM_IP:5000` in a browser.
 
 
-If you're not using Boot2docker and are on linux, then the web app should now be listening on port 5000 on your Docker daemon host. If http://0.0.0.0:5000 doesn't resolve, you can also try localhost:5000.
+If you're using Docker on Linux natively, then the web app should now be listening on port 5000 on your Docker daemon host. If http://0.0.0.0:5000 doesn't resolve, you can also try http://localhost:5000.
 
 
 You should get a message in your browser saying:
 You should get a message in your browser saying:
 
 

+ 8 - 9
docs/install.md

@@ -16,16 +16,11 @@ You can run Compose on OS X and 64-bit Linux.  It is currently not supported on
 the Windows operating system. To install Compose, you'll need to install Docker
 the Windows operating system. To install Compose, you'll need to install Docker
 first.
 first.
 
 
-Depending on how your system is configured, you may require `sudo` access to
-install Compose. If your system requires `sudo`, you will receive "Permission
-denied" errors when installing Compose. If this is the case for you, preface the
-install commands with `sudo` to install.
-
 To install Compose, do the following:
 To install Compose, do the following:
 
 
 1. Install Docker Engine version 1.7.1 or greater:
 1. Install Docker Engine version 1.7.1 or greater:
 
 
-     * <a href="https://docs.docker.com/installation/mac/" target="_blank">Mac OS X installation</a> (installs both Engine and Compose)
+     * <a href="https://docs.docker.com/installation/mac/" target="_blank">Mac OS X installation</a> (Toolbox installation includes both Engine and Compose)
 
 
      * <a href="https://docs.docker.com/installation/ubuntulinux/" target="_blank">Ubuntu installation</a>
      * <a href="https://docs.docker.com/installation/ubuntulinux/" target="_blank">Ubuntu installation</a>
 
 
@@ -33,9 +28,13 @@ To install Compose, do the following:
 
 
 2. Mac OS X users are done installing. Others should continue to the next step.
 2. Mac OS X users are done installing. Others should continue to the next step.
 
 
-3. Go to the <a href="https://github.com/docker/compose/releases" target="_blank">repository release page</a>.
+3. Go to the <a href="https://github.com/docker/compose/releases" target="_blank">Compose repository release page on GitHub</a>.
+
+4. Follow the instructions from the release page and run the `curl` command in your terminal.
 
 
-4. Enter the `curl` command in your terminal.
+     > Note: If you get a "Permission denied" error, your `/usr/local/bin` directory
+     probably isn't writable and you'll need to install Compose as the superuser. Run
+     `sudo -i`, then the two commands below, then `exit`.
 
 
      The command has the following format:
      The command has the following format:
 
 
@@ -69,7 +68,7 @@ to preserve) you can migrate them with the following command:
 
 
     $ docker-compose migrate-to-labels
     $ docker-compose migrate-to-labels
 
 
-Alternatively, if you're not worried about keeping them, you can remove them &endash;
+Alternatively, if you're not worried about keeping them, you can remove them.
 Compose will just create new ones.
 Compose will just create new ones.
 
 
     $ docker rm -f -v myapp_web_1 myapp_db_1 ...
     $ docker rm -f -v myapp_web_1 myapp_db_1 ...