Skip to content

Commit

Permalink
BE-704 Online documentation-synchronizer
Browse files Browse the repository at this point in the history
Signed-off-by: nfrunza <nfrunza@gmail.com>
Change-Id: I9402769ea5eb1d9577412d33cbdc06364602e8f5
  • Loading branch information
nfrunza committed Nov 13, 2019
1 parent 9ed0963 commit 4fedc3a
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 11 deletions.
12 changes: 6 additions & 6 deletions docs/source/architecture/gateway.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ As of now Hyperledger Explorer is able to connect only to a single Hyperledger F
able to have more than one network connected.

In previous versions we had a single file
`config.json <https://github.com/hyperledger/blockchain-explorer/blob/v0.3.8/app/platform/fabric/config.json>`__ file that was used to configure
`config.json <https://github.com/hyperledger/blockchain-explorer/blob/master/app/platform/fabric/config.json>`__ file that was used to configure
Hyperledger Explorer, after the minimal configuration we divided in two parts, `config.json <https://github.com/hyperledger/blockchain-explorer/blob/master/app/platform/fabric/config.json>`__,
and `connection-profile <https://github.com/hyperledger/blockchain-explorer/blob/master/app/platform/fabric/connection-profile/first-network.json>`__, that described the network properties.

Expand All @@ -43,7 +43,7 @@ On another terminal:
cd blockchain-explorer/app/platform/fabric
Modify config.json to point to your first-network network `connection-profile <https://github.com/hyperledger/blockchain-explorer/blob/master/app/platform/fabric/connection-profile/first-network.json>`__:
Modify `config.json <https://github.com/hyperledger/blockchain-explorer/blob/master/app/platform/fabric/config.json>`__ to point to your first-network network `connection-profile <https://github.com/hyperledger/blockchain-explorer/blob/master/app/platform/fabric/connection-profile/first-network.json>`__:

.. code-block:: json
Expand All @@ -70,13 +70,13 @@ Modify config.json to point to your first-network network `connection-profile <h
/blockchain-explorer/app/platform/fabric/connection-profile/first-network.json
Provide the full disk path to the adminPrivateKey config option, it usually ends with "_sk", for example:

* "/fabric-path/fabric-samples/first-network/crypto-config/peerOrganizations/org1.example.com/users/Admin@org1.example.com/msp/keystore/aaacd899a6362a5c8cc1e6f86d13bfccc777375365bbda9c710bb7119993d71c_sk"
"/fabric-path/fabric-samples/first-network/crypto-config/peerOrganizations/org1.example.com/users/Admin@org1.example.com/msp/keystore/aaacd899a6362a5c8cc1e6f86d13bfccc777375365bbda9c710bb7119993d71c_sk"

* "adminUser" is the the admin user of the network, in this case it's fabric CA or an identity user.
"adminUser" is the the admin user of the network, in this case it's fabric CA or an identity user.

* "adminPassword" is the password for the admin user.
"adminPassword" is the password for the admin user.

* "enableAuthentication" is a flag to enable authentication using a login page, setting to false
"enableAuthentication" is a flag to enable authentication using a login page, setting to false
will skip authentication.


27 changes: 22 additions & 5 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@ Getting Started with Hyperledger Explorer

TODO

.. add an introduction on how to start using HLExplorer, short description with using images, and explanation what are the futures with notes on images
.. located in blockchain-explorer/docs/source/images

Hyperledger Explorer can run locally in your local environment or using docker. Minimum configuration allows you to get it setup up, and running
Hyperledger Explorer can run in your local environment or using docker. Minimum configuration allows you to get it setup up, and running
in short time.
There are well defined steps and `instructions <https://github.com/hyperledger/blockchain-explorer/blob/master/README.md>`__ how to get you setup and
run HL Explorer successfully. Along with the instructions you may find useful
Expand All @@ -19,14 +17,33 @@ by community through the `mail listings <https://lists.hyperledger.org/g/explore
`Rocket Chat <https://chat.hyperledger.org/channel/hyperledger-explorer>`__ hyperledger-explorer channel.


TODO


Following are the software dependencies required to install and run hyperledger explorer:

* `Node.js <https://nodejs.org/en/>`__ 8.11.x (Note that v9.x is not yet supported)
* `PostgreSQL 9.5 or greater <https://www.postgresql.org/>`__
* `jq <https://stedolan.github.io/jq>`__, a lightweight and flexible command-line JSON processor
* Linux-based operating system, such as `Ubuntu <https://ubuntu.com/>`__ or MacOS

Verified Docker versions supported:

* `Docker CE 18.09.2 or later <https://hub.docker.com/search/?type=edition&offering=community&operating_system=linux>`__
* `Docker Compose 1.14.0 <https://docs.docker.com/compose>`__

.. note::

See `Release Notes <https://github.com/hyperledger/blockchain-explorer/blob/master/README.md#10-release-notes---->`__ on supported Hyperledger Fabric and Explorer versions.


.. container:: content-tabs

.. tab-container:: local
:title: Run locally

Content for Running HL Explorer locally

Assuming that your environment has the required software dependencies, follow up `instructions <https://github.com/hyperledger/blockchain-explorer/blob/master/README.md>`__ on how to setup Hyperledger Explorer to run in your local environment


.. tab-container:: cloud
:title: Run in cloud
Expand Down

0 comments on commit 4fedc3a

Please sign in to comment.