github.com/yacovm/fabric@v2.0.0-alpha.0.20191128145320-c5d4087dc723+incompatible/docs/source/install.rst (about)

     1  Install Samples, Binaries and Docker Images
     2  ===========================================
     3  
     4  While we work on developing real installers for the Hyperledger Fabric
     5  binaries, we provide a script that will download and install samples and
     6  binaries to your system. We think that you'll find the sample applications
     7  installed useful to learn more about the capabilities and operations of
     8  Hyperledger Fabric.
     9  
    10  
    11  .. note:: If you are running on **Windows** you will want to make use of the
    12  	  Docker Quickstart Terminal for the upcoming terminal commands.
    13            Please visit the :doc:`prereqs` if you haven't previously installed
    14            it.
    15  
    16            If you are using Docker Toolbox on Windows 7 or macOS, you
    17            will need to use a location under ``C:\Users`` (Windows 7) or
    18            ``/Users`` (macOS) when installing and running the samples.
    19  
    20            If you are using Docker for Mac, you will need to use a location
    21            under ``/Users``, ``/Volumes``, ``/private``, or ``/tmp``.  To use a different
    22            location, please consult the Docker documentation for
    23            `file sharing <https://docs.docker.com/docker-for-mac/#file-sharing>`__.
    24  
    25            If you are using Docker for Windows, please consult the Docker
    26            documentation for `shared drives <https://docs.docker.com/docker-for-windows/#shared-drives>`__
    27            and use a location under one of the shared drives.
    28  
    29  Determine a location on your machine where you want to place the `fabric-samples`
    30  repository and enter that directory in a terminal window. The
    31  command that follows will perform the following steps:
    32  
    33  #. If needed, clone the `hyperledger/fabric-samples <https://github.com/hyperledger/fabric-samples>`_ repository
    34  #. Checkout the appropriate version tag
    35  #. Install the Hyperledger Fabric platform-specific binaries and config files
    36     for the version specified into the /bin and /config directories of fabric-samples
    37  #. Download the Hyperledger Fabric docker images for the version specified
    38  
    39  Once you are ready, and in the directory into which you will install the
    40  Fabric Samples and binaries, go ahead and execute the command to pull down
    41  the binaries and images.
    42  
    43  .. note:: If you want the latest production release, omit all version identifiers.
    44  
    45  .. code:: bash
    46  
    47    curl -sSL http://bit.ly/2ysbOFE | bash -s
    48  
    49  .. note:: If you want a specific release, pass a version identifier for Fabric,
    50            Fabric-ca and thirdparty Docker images.
    51            The command below demonstrates how to download **Fabric v2.0.0 Alpha release v2.0.0-alpha**
    52  
    53  .. code:: bash
    54  
    55    curl -sSL http://bit.ly/2ysbOFE | bash -s -- <fabric_version> <fabric-ca_version> <thirdparty_version>
    56    curl -sSL http://bit.ly/2ysbOFE | bash -s -- 2.0.0-alpha 2.0.0-alpha 0.4.15
    57  
    58  .. note:: If you get an error running the above curl command, you may
    59            have too old a version of curl that does not handle
    60            redirects or an unsupported environment.
    61  
    62  	  Please visit the :doc:`prereqs` page for additional
    63  	  information on where to find the latest version of curl and
    64  	  get the right environment. Alternately, you can substitute
    65  	  the un-shortened URL:
    66  	  https://raw.githubusercontent.com/hyperledger/fabric/master/scripts/bootstrap.sh
    67  
    68  The command above downloads and executes a bash script
    69  that will download and extract all of the platform-specific binaries you
    70  will need to set up your network and place them into the cloned repo you
    71  created above. It retrieves the following platform-specific binaries:
    72  
    73    * ``configtxgen``,
    74    * ``configtxlator``,
    75    * ``cryptogen``,
    76    * ``discover``,
    77    * ``idemixgen``
    78    * ``orderer``,
    79    * ``peer``,
    80    * ``fabric-ca-client``
    81  
    82  and places them in the ``bin`` sub-directory of the current working
    83  directory.
    84  
    85  You may want to add that to your PATH environment variable so that these
    86  can be picked up without fully qualifying the path to each binary. e.g.:
    87  
    88  .. code:: bash
    89  
    90    export PATH=<path to download location>/bin:$PATH
    91  
    92  Finally, the script will download the Hyperledger Fabric docker images from
    93  `Docker Hub <https://hub.docker.com/u/hyperledger/>`__ into
    94  your local Docker registry and tag them as 'latest'.
    95  
    96  The script lists out the Docker images installed upon conclusion.
    97  
    98  Look at the names for each image; these are the components that will ultimately
    99  comprise our Hyperledger Fabric network.  You will also notice that you have
   100  two instances of the same image ID - one tagged as "amd64-1.x.x" and
   101  one tagged as "latest". Prior to 1.2.0, the image being downloaded was determined
   102  by ``uname -m`` and showed as "x86_64-1.x.x".
   103  
   104  .. note:: On different architectures, the x86_64/amd64 would be replaced
   105            with the string identifying your architecture.
   106  
   107  .. note:: If you have questions not addressed by this documentation, or run into
   108            issues with any of the tutorials, please visit the :doc:`questions`
   109            page for some tips on where to find additional help.
   110  
   111  .. Licensed under Creative Commons Attribution 4.0 International License
   112     https://creativecommons.org/licenses/by/4.0/