https://github.com/yann39/hyperledger-explorer-docker
A running Hyperledger Fabric network integrated with Hyperledger Explorer
https://github.com/yann39/hyperledger-explorer-docker
blockchain docker hyperledger hyperledger-explorer hyperledger-fabric postgresql
Last synced: about 1 month ago
JSON representation
A running Hyperledger Fabric network integrated with Hyperledger Explorer
- Host: GitHub
- URL: https://github.com/yann39/hyperledger-explorer-docker
- Owner: Yann39
- License: gpl-3.0
- Created: 2024-02-05T11:42:32.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-08T19:08:45.000Z (over 2 years ago)
- Last Synced: 2025-03-09T00:42:00.939Z (over 1 year ago)
- Topics: blockchain, docker, hyperledger, hyperledger-explorer, hyperledger-fabric, postgresql
- Language: Dockerfile
- Homepage:
- Size: 83 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hyperledger Explorer setup
**Windows 10** 64 bits **Hyperledger Explorer** setup using **Docker**.
---
# Table of Contents
* [Prerequisites](#prerequisites)
* [Cleaning](#cleaning)
* [Network](#network)
* [Usage](#usage)
* [PostGreSQL database](#postgresql-database)
* [License](#license)
# Prerequisites
A running **Hyperledger Fabric** network.
I used Hyperledger Fabric **v1.2**.
See [Hyperledger Fabric documentation](https://hyperledger-fabric.readthedocs.io/en/release-1.2/).
I included the configuration for an example network (_app/config/configtx.yaml_ and _app/config/crypto-config.yaml_ files).
Also don't forget to configure **Git** for Windows :
Check _autocrlf_ :
```bash
git config --get core.autocrlf
```
if `null` or `true`, set it to `false` :
```bash
git config --global core.autocrlf false
```
Check _longpaths_ :
```bash
git config --get core.longpaths
```
if `null` or `false`, set it to `true` :
```bash
git config --global core.longpaths true
```
# Cleaning
In case you already set up the environment, here are some useful cleanup commands
1. Clean containers and volumes
```bash
docker-compose down
```
2. Clean all containers containing "blockchain-explorer" in their name
```bash
docker stop $(docker ps -a --filter="name=blockchain-explorer")
docker rm $(docker ps -a --filter="name=blockchain-explorer")
```
3. Clean all images with name starting with "hyperledger-blockchain-explorer" or "dev-peer"
```bash
docker rmi $(docker images hyperledger-blockchain-explorer* -q)
```
4. Prune networks and volumes
```bash
docker network prune
docker volume prune
```
5. Remove crypto materials
```bash
rm -rf app/config/crypto-config/
```
# Network
The **Hyperledger network** in which I ran this example is composed of :
- 2 organizations :
* myorg1
* myorg2
- 2 peers per organization :
* myorg1 : peer0.myorg1.ch and peer1.myorg1.ch
* myorg2 : peer0.myorg2.ch and peer1.myorg2.ch
- peer0 from both organizations have been defined as anchor peer
- all peers use _CouchDB_ as ledger state database
- 1 user (identity) per peer (in addition to _Admin_ user)
- 1 orderer (use its own channel _orderer-channel_) with _kafka_ consensus
- 1 channel _my-channel_ joined by both peer0 from both organizations
- 1 Go chaincode
- 4 Kafka nodes and 3 Zookeeper (as recommended)
- 2 Certification authorities (one per organization)
See _app/config/configtx.yaml_ and _app/config/crypto-config.yaml_ for example configuration
and [Hyperledger Fabric documentation](https://hyperledger-fabric.readthedocs.io/en/release-1.2/) for the setup.
# Usage
I have built a **custom setup**, that I think is simpler than the mentioned steps (from the [official repository](https://github.com/hyperledger/blockchain-explorer) _readme_ file)
which consist of downloading the whole repository and then modify the files.
Instead of downloading the repository locally and doing the modification in the sources,
I get the repository directly from a **Docker** container and then link local configuration files to it using volumes.
I used the **release-3.5** branch.
You may change the `EXPLORER_BRANCH` argument in the _docker-compose.yml_ file if you want to use a different branch (may requires other modifications).
I have implemented a **Compose** file (_docker-compose.yaml_) that builds the images/containers for the application and the database.
The containers will be attached to the existing Docker network of our Fabric network.
> [!WARNING]
> Make sure you use the same Docker network as your existing Hyperledger Fabric network in the _docker-compose.yaml_ file. Mine is `config_mynw`.
The Application will attach to the database once it is ready (I used a `wait.sh` script to wait for the database to be up).
The initialization scripts are retrieved from the official repository in the **PostGreSQL Dockerfile**.
All that you need is in the _config_ directory :
1. _config.json_ : file representing the network configuration
2. _crypto-config_ : folder containing the network certificates
So just adapt the _config.json_ file and copy the _crypto-config_ folder from the one generated during your **Fabric** setup.
You can regenerate the cryptographic materials from the _app/config/configtx.yaml_ and _app/config/crypto-config.yaml_ files if needed.
Then simply run :
```bash
docker-compose up
```
This will run 2 containers :
- `hyperledger_explorer_app` : the application
- `hyperledger_explorer_postgresql` : the PostGreSQL database
You should be able to reach http://localhost:8092
For **Swagger** API endpoint, go to http://localhost:8092/api-docs/
# PostGreSQL database
If you need to enter the **PostGreSQL** database manually, here are some useful commands :
Get into the container :
```bash
winpty docker exec -it hyperledger_explorer_postgresql sh
```
Connect to PostGreSQL as `postgres` user :
```bash
su postgres
psql
```
or :
```bash
psql -U postgres
```
List all databases :
```bash
\list
```
Connect to the `fabricexplorer` database :
```bash
\connect fabricexplorer
```
Select data :
```bash
select * from peer;
```
Quit :
```bash
\q
```
# License
[General Public License (GPL) v3](https://www.gnu.org/licenses/gpl-3.0.en.html)
This program is free software: you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not,
see .