Getting Started

Welcome to the GoChain documentation! This guide will help you get started with GoChain, a platform for orchestrating permissioned blockchain networks using Hyperledger Fabric technology.

Create your account

On the login page of GoChain, click on the "Sign Up" button on the top right corner to create your account. You will need to provide:

  1. Name
  2. Username
  3. Email
  4. Password

After creating your account, confirm your account with the code sent to your email. Now you can log in to GoFabric.

Your first onboarding

After logging in, you will be prompted to create your first organization. Click on the "Get Started" button to start the onboarding process.

When you first create your account you're allowed to create a single organization as part of the Starter Org plan. The Starter Org plan is free and allows you to create a single organization with a single peer and a single orderer. You can also be part of one Business Group. You can upgrade your plan at any time to expand your org features. To get more details on plans and upgrade options check the Pricing page.

Onboarding

Create an infrastructure

The first step is to create the infrastructure for your organization. You will need to choose between two provider options:

  1. External: This option allows you to create your infrastructure on your own servers.
  2. AWS: This option allows you to create your infrastructure on your Amazon Web Services, by informing your Access Key and Secret Key.
  3. GoLedger: This option will use GoLedger as a provider, so you don't need to manage any infrastructure. (Coming soon)

The Starter Plan allows External and GoLedger providers. The AWS provider is available on higher plans.

Creating an External infra provider

If you choose the External provider, you will need to inform the following information:

  1. Name: The name of your infrastructure

Then just click on the "Create Infra" button to create your infrastructure.

Creating External Infra

Now you can proceed to the next step, which is setting up your virtual machines (VMs).

To set up you VMs, you will need to inform the following information:

  1. SSH User: The user that will be used to connect to the VMs
  2. SSH Key: The SSH key that will be used to connect to the VMs
  3. IP Addresses: The IP addresses of the VMs that will be setup

Setting Up External VMs

During setup, you can see the progress of the VM configuration.

Creating an AWS infra provider

If you choose the AWS provider, you will need to inform the following information:

  1. Name: The name of your infrastructure
  2. Region: The AWS region where your infrastructure will be created
  3. Access Key: Your AWS Access Key
  4. Secret Key: Your AWS Secret Key
  5. Security Group Name: The name of the security group that will be created. This should not exist in your AWS account. GoInfra will the firewall rules for the blockchain resources.
  6. SSH Key Name: The name of the SSH key that will be created. This should not exist in your AWS account. GoInfra will create the SSH key to be used to connect to the VMs.

Then just click on the "Create Infra" button to create your infrastructure.

Creating AWS Infra

Now you can proceed to the next step, which is setting up your virtual machines (VMs).

To set up you VMs, you will need to inform the following information:

  1. Instance Type: The type of the VM that will be created
  2. SSH Key: The SSH key that will be used to connect to the VMs. This was created in the previous step.
  3. Instance name: The name of the VM that will be created
  4. Instance image: The image of the VM that will be created. Currently, only Ubuntu 20 is supported.
  5. Instance count: The number of VMs that will be created
  6. Storage size: The size of the storage that will be created
  7. Security Group Name: The name of the security group that will be used. This was created in the previous step.

Creating AWS VMs

During setup, you can see the progress of the VM configuration.

VM Success

You can also see the details of the VMs that were created on your AWS account.

After setting up your VMs, you can proceed to the next step, which is setting up your first organization.

Create your first organization

To create your first organization, you will need to inform the following information:

  1. Name: The name of your organization
  2. Domain: The domain of your organization
  3. Network API Host: The host of the network API. The network API is used by GoFabric for managing the organization.
  4. CA User: The user that will be used to connect to the CA
  5. CA Password: The password that will be used to connect to the CA
  6. CA Host: The host of the CA

Then just click on the "Create Organization" button to create your organization.

Creating Organization

After creating your organization, you can invite members to manage the organization with you. When the process is done you'll be met with the organization overview.

Organization Overview

Next Steps

Now that you have created your organization, you can start creating your nodes and business groups. Recommended next:

  1. Check the Node Guide section to learn how to create your first peer and orderer nodes.
  2. Check the Business Group Guide section to learn how to create your first business group and spin up you network.
  3. Check the Channel Guide section to learn how to create your first channel and add new members to it.
  4. Check the Chaincode Builder Guide section to learn how to create your first chaincode and deploy it to your network.
  5. Check the GoBesu Guide section to learn how to set up an Ethereum-based private network using GoBesu, a tool that helps in deploying Besu nodes and setting up a private network for your use case.