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.

Getting started overview

There are several ways to get started with GoQuorum. They range from using our wizard to generate a local network, to configuring and creating a full network from scratch.

GoQuorum Wizard

The easiest way to get a network up and running is by using the GoQuorum Wizard. This command-line tool creates a local GoQuorum network that can be started and be ready for use in minutes. The wizard provides options for configuring the network and generates all the resources to run either in containers using docker-compose, or locally through the use of bash scripts.

The wizard requires NodeJS and runs on Linux/Mac only.

npm install -g quorum-wizard
quorum-wizard

To explore the features of GoQuorum and deploy a private contract, 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.

k8s-logo GoQuorum on Kubernetes

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

You can use kind or Minikube for local development. For long running networks, use a cloud service (e.g. 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. Also includes examples ready to run on Kubernetes.

Creating a network from scratch

Creating a Network From Scratch provides a step-by-step walkthrough of how to create and configure a GoQuorum network suitable for either Raft or Istanbul 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