Giter Club home page Giter Club logo

willianpatrick / drex-hyperledger-besu-deployer Goto Github PK

View Code? Open in Web Editor NEW

This project forked from pedrosgmagalhaes/drex-hyperledger-besu-deployer

0.0 0.0 0.0 41 KB

The `drex-hyperledger-besu-deployer` is a tool designed to streamline the process of building and deploying nodes for a Hyperledger Besu network. This tool is inspired by Drex, a Central Bank Digital Currency (CBDC) infrastructure from Brazil. It enables users to deploy a similar network in seconds.

Shell 95.42% Dockerfile 4.58%

drex-hyperledger-besu-deployer's Introduction

drex-hyperledger-besu-deployer

Overview

The drex-hyperledger-besu-deployer is a tool designed to streamline the process of building and deploying nodes for a Hyperledger Besu network. This tool is inspired by Drex, a Central Bank Digital Currency (CBDC) infrastructure from Brazil. It enables users to deploy a similar network in seconds.

Docker e Docker Compose: Tutorial em Português

Requirements

  • Docker
  • Docker Compose
  • A bash shell environment for running scripts (available on Linux, Mac, and Windows via Git Bash or similar)

Features

  • Fast setup and deployment of Hyperledger Besu nodes.
  • User-friendly interface for specifying the number of nodes.
  • Automatic key generation for each node.

Getting Started

  1. Ensure Docker and Docker Compose are installed on your machine.
  2. Clone this repository.
  3. Navigate to the cloned directory and run the setup script.

Installation

Docker and Docker Compose Installation

Windows:

  1. Download and install Docker Desktop from Docker Hub.
  2. Docker Compose comes integrated with Docker Desktop.

Mac:

  1. Download and install Docker Desktop from Docker Hub.
  2. Docker Compose is included with Docker Desktop.

Linux:

  1. Install Docker using the package manager of your distribution. For example, on Ubuntu:

    sudo apt-get update
    sudo apt-get install docker-ce docker-ce-cli containerd.io
  2. Install Docker Compose by running the following commands:

    sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
    sudo chmod +x /usr/local/bin/docker-compose

Getting started

To install the drex-hyperledger-besu-deployer, follow these steps:

  1. Download or clone the repository.
  2. Open a Linux, Mac, or Windows terminal (Windows users can use Git Bash or a similar bash shell).
  3. Navigate to the directory containing the install.sh script.
  4. Run the installation script with the following command:
    sh install.sh

This script will set up everything you need to get started.

Dockerfile

FROM hyperledger/besu:latest

# Copy necessary scripts or configuration files
COPY qbftConfigFile.json /qbftConfigFile.json

# Set the entrypoint to Besu
ENTRYPOINT ["/opt/besu/bin/besu"]

## Setup Script
```bash
#!/bin/bash

# Check for Docker installation and running status
if ! command -v docker &> /dev/null; then
    echo "Error: Docker is not installed. Please install Docker and retry."
    exit 1
fi

if ! docker info &> /dev/null; then
    echo "Error: Docker is not running. Please start Docker and retry."
    exit 1
fi

echo "Success: Docker is installed and running."

# Define a function to generate keys with Besu
generate_keys() {
    # Additional script commands go here...
}

# Main script to configure and set up nodes
# Additional setup commands go here...

echo "Setup Complete: All configuration files have been created."

Configuration

Adjust the genesis.json file and other necessary settings to align with your specific network requirements. This step is crucial for tailoring the deployment to your desired Hyperledger Besu network configuration.

Usage

Once the setup is complete, you can launch your Hyperledger Besu network with the following command:

docker-compose up -d

Tutorial em Português

Para um guia passo a passo em Português sobre como instalar e configurar o Docker e Docker Compose, assista ao seguinte vídeo tutorial no YouTube:

Docker e Docker Compose: Tutorial em Português

Be a Node - CBDC Simulator

By using this setup, you can emulate the operation of a node in a CBDC (Central Bank Digital Currency) network. This provides an immersive and educational experience, closely mirroring the functionality of the Drex infrastructure.

Author

Pedro Magalhães - GitHub Profile

Contributing

Contributions are welcome and greatly appreciated. If you have any suggestions for improvements or notice any issues, please feel free to submit pull requests or open issues on the repository. For more of my work and contributions, visit my GitHub.

License

This project is licensed under the MIT License. For more information, see the LICENSE file in the repository.

drex-hyperledger-besu-deployer's People

Contributors

pedrosgmagalhaes avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.