From 76eee50a67732ee18a678ebf54720b78370254df Mon Sep 17 00:00:00 2001 From: Solomon Hykes Date: Tue, 21 Jan 2014 02:58:04 +0000 Subject: [PATCH] docs: add standard 'check your docker install' paragraph to the 'hello world' examples. Docker-DCO-1.1-Signed-off-by: Solomon Hykes (github: shykes) --- docs/sources/examples/hello_world.rst | 26 +++++++++++--------------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/docs/sources/examples/hello_world.rst b/docs/sources/examples/hello_world.rst index aeb95881d2..57954a98ca 100644 --- a/docs/sources/examples/hello_world.rst +++ b/docs/sources/examples/hello_world.rst @@ -9,25 +9,23 @@ Hello World .. _running_examples: -Running the Examples -==================== +Check your docker install +------------------------- -All the examples assume your machine is running the ``docker`` daemon. To -run the ``docker`` daemon in the background, simply type: +This guide assumes you have a working installation of Docker. To check +your docker install, run the following command: .. code-block:: bash - sudo docker -d & + # Check that you have a working install + docker info -Now you can run Docker in client mode: by default all commands will be -forwarded to the ``docker`` daemon via a protected Unix socket, so you -must run as the ``root`` or via the ``sudo`` command. +If you get ``docker: command not found`` or something like +``/var/lib/docker/repositories: permission denied`` you may have an incomplete +docker installation or insufficient privileges to access docker on your machine. -.. code-block:: bash +Please refer to :ref:`installation_list` for installation instructions. - sudo docker help - ----- .. _hello_world: @@ -88,9 +86,7 @@ Hello World Daemon And now for the most boring daemon ever written! -This example assumes you have Docker installed and the Ubuntu -image already imported with ``docker pull ubuntu``. We will use the Ubuntu -image to run a simple hello world daemon that will just print hello +We will use the Ubuntu image to run a simple hello world daemon that will just print hello world to standard out every second. It will continue to do this until we stop it.