Skip to main content

Installation overview

You can get started with GoQuorum in multiple ways. They range from using the quickstart to generate a local network, to creating and configuring a full network from scratch.

Quorum Dev Quickstart

The easiest way to get a network up and running is by using the Quorum Dev Quickstart. This command-line tool creates a local GoQuorum network that can be started and be ready for use in minutes.

The quickstart provides options for configuring the network and generates all the resources to run in containers using docker-compose.

The quickstart requires:

To start the quickstart, run:

npx quorum-dev-quickstart

To explore the features of GoQuorum and deploy private contracts, follow the instructions on Interacting with the Network

GoQuorum examples sample network

GoQuorum examples provides the means to quickly create a pre-configured sample GoQuorum network that can be run either in a virtual-machine environment using Vagrant, in containers using docker-compose, or locally through the use of bash scripts to automate creation of the network.

GoQuorum on Kubernetes

Use kubernetes to run configurable GoQuorum and Tessera networks on Kubernetes.

For local development, use kind or Minikube. For long running networks, use a cloud service (for example Google GKE, Azure AKS, AWS EKS) or a self-hosted Kubernetes cluster.

Creating a network from scratch

Follow the step-by-step walk-through to create and configure GoQuorum networks for QBFT, IBFT, and Raft consensus. It also shows how to enable privacy and add/remove nodes as required.

Creating a network deployed in the cloud

Quorum Terraform provides an example of how a GoQuorum network can be run on a cloud platform on either AWS or Azure