Skip to content

Commit

Permalink
Merge "FAB-5034 provide clearer directions"
Browse files Browse the repository at this point in the history
  • Loading branch information
hacera-jonathan authored and Gerrit Code Review committed Jun 29, 2017
2 parents 294b374 + 3c3cd03 commit b93fb81
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
6 changes: 6 additions & 0 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ you have all the :doc:`prereqs` installed on the platform(s)
on which you'll be developing blockchain applications and/or operating
Hyperledger Fabric.

Install Binaries and Docker Images
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
While we work on developing real installers for the Hyperledger Fabric
binaries, we provide a script that will :ref:`binaries` to your system.
The script also will download the Docker images to your local registry.

Hyperledger Fabric Samples
^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
15 changes: 12 additions & 3 deletions docs/source/samples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,19 @@ execute the following commands:
git clone https://github.com/hyperledger/fabric-samples.git
cd fabric-samples
.. _binaries:

Download Platform-specific Binaries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Next, we will install the Hyperledger Fabric platform-specific binaries.
To do this, execute the following command:
This process was designed to complement the Hyperledger Fabric Samples
above, but can be used independently. If you are not installing the
samples above, then simply create and enter a directory into which to
extract the contents of the platform-specific binaries.

Please execute the following command from within the directory into which
you will extract the platform-specific binaries:

.. code:: bash
Expand All @@ -47,14 +55,15 @@ created above. It retrieves four platform-specific binaries:
* ``configtxlator``, and
* ``peer``

and places them in the ``fabric-samples/bin`` directory.
and places them in the ``bin`` sub-directory of the current working
directory.

You may want to add that to your PATH environment variable so that these
can be picked up without fully qualifying the path to each binary. e.g.:

.. code:: bash
export PATH=<path to fabric-samples>/bin:$PATH
export PATH=<path to download location>/bin:$PATH
Finally, the script will download the Hyperledger Fabric docker images from
`DockerHub <https://hub.docker.com/u/hyperledger/>`__ into
Expand Down

0 comments on commit b93fb81

Please sign in to comment.