Bladeren bron

Fix typos, add links, streamline content of #2592

Andy Rothfusz 11 jaren geleden
bovenliggende
commit
9a9d3239e1
3 gewijzigde bestanden met toevoegingen van 20 en 25 verwijderingen
  1. 3 6
      docs/sources/examples/example_header.inc
  2. 2 1
      docs/sources/examples/hello_world.rst
  3. 15 18
      docs/sources/use/basics.rst

+ 3 - 6
docs/sources/examples/example_header.inc

@@ -1,10 +1,7 @@
 
 
 .. note::
 .. note::
     
     
-    This example assumes you have Docker running in daemon mode. For more information please see :ref:`running_examples`
+    * This example assumes you have Docker running in daemon mode. For
+      more information please see :ref:`running_examples`.
+    * **If you don't like sudo** then see :ref:`dockergroup`
 
 
-.. note::
-
-   These examples use ``sudo`` before each ``docker`` command you could also
-   add your current ``<username>`` to docker's group and get rid of ``sudo``.
-   You just need to type: ``$ sudo usermod -a -G docker <username>``

+ 2 - 1
docs/sources/examples/hello_world.rst

@@ -131,7 +131,8 @@ Attach to the container to see the results in real-time.
 
 
 - **"docker attach**" This will allow us to attach to a background
 - **"docker attach**" This will allow us to attach to a background
   process to see what is going on.
   process to see what is going on.
-- **"-sig-proxy=true" Proxify all received signal to the process (even in non-tty mode)
+- **"-sig-proxy=true"** Proxify all received signal to the process
+  (even in non-tty mode)
 - **$CONTAINER_ID** The Id of the container we want to attach too.
 - **$CONTAINER_ID** The Id of the container we want to attach too.
 
 
 Exit from the container attachment by pressing Control-C.
 Exit from the container attachment by pressing Control-C.

+ 15 - 18
docs/sources/use/basics.rst

@@ -53,39 +53,36 @@ Running an interactive shell
 
 
 .. _dockergroup:
 .. _dockergroup:
 
 
-Why ``sudo``?
--------------
+sudo and the docker Group
+-------------------------
 
 
 The ``docker`` daemon always runs as root, and since ``docker``
 The ``docker`` daemon always runs as root, and since ``docker``
 version 0.5.2, ``docker`` binds to a Unix socket instead of a TCP
 version 0.5.2, ``docker`` binds to a Unix socket instead of a TCP
 port. By default that Unix socket is owned by the user *root*, and so,
 port. By default that Unix socket is owned by the user *root*, and so,
 by default, you can access it with ``sudo``.
 by default, you can access it with ``sudo``.
 
 
-Starting in version 0.5.3, if you create a Unix group called *docker*
-and add users to it, then the ``docker`` daemon will make the
-ownership of the Unix socket read/writable by the *docker* group when
-the daemon starts. The ``docker`` daemon must always run as root, but
-if you run the ``docker`` client as a user in the *docker* group then
-you don't need to add ``sudo`` to all the client commands.
+Starting in version 0.5.3, if you (or your Docker installer) create a
+Unix group called *docker* and add users to it, then the ``docker``
+daemon will make the ownership of the Unix socket read/writable by the
+*docker* group when the daemon starts. The ``docker`` daemon must
+always run as root, but if you run the ``docker`` client as a user in
+the *docker* group then you don't need to add ``sudo`` to all the
+client commands.
 
 
-Alternative to ``sudo``?
--------------
-
-You can add your current ``<username>`` to docker's group and get rid of
-``sudo`` before each ``docker`` command. You just need to type:
-``$ sudo usermod -a -G docker <username>``
+**Example:**
 
 
 .. code-block:: bash
 .. code-block:: bash
 
 
-  # Add the docker group
+  # Add the docker group if it doesn't already exist.
   sudo groupadd docker
   sudo groupadd docker
 
 
-  # Add the ubuntu user to the docker group
+  # Add the user "ubuntu" to the docker group.
+  # Change the user name to match your preferred user.
   # You may have to logout and log back in again for
   # You may have to logout and log back in again for
-  # this to take effect
+  # this to take effect.
   sudo gpasswd -a ubuntu docker
   sudo gpasswd -a ubuntu docker
 
 
-  # Restart the docker daemon
+  # Restart the docker daemon.
   sudo service docker restart
   sudo service docker restart
 
 
 .. _bind_docker:
 .. _bind_docker: