Skip to content
You are reading GoQuorum development version documentation and some displayed features may not be available in the stable release. You can switch to stable version using the version box at screen bottom.

Updated on September 1, 2021

Getting started 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 (Qubernetes)

Use qubernetes to run configurable N node GoQuorum networks on Kubernetes.

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

Qubernetes supports Raft and Istanbul consensus algorithms, multiple versions, and networks with an arbitrary number of nodes. The Qubernetes repository includes examples ready to run on Kubernetes.

Creating a network from scratch

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

Creating a network deployed in the cloud

Quorum Cloud provides an example of how a GoQuorum network can be run on a cloud platform. It uses Terraform to create a 7 node GoQuorum network deployed on AWS using AWS ECS Fargate, S3 and an EC2.

ConsenSys has acquired Quorum from J.P. Morgan. Please read the FAQ.
Questions or feedback? You can discuss issues and obtain free support on GoQuorum Slack channel.
For paid professional support by ConsenSys, contact us at quorum@consensys.net.