Regen Ledger Documentation

Install Regen

The regen binary serves as the node client and the application client. In other words, the regen binary can be used to both run a node and interact with it.

If you have not already, check out Command-Line Interface for an introduction.

Build From Source

The following instructions are for building and installing the regen binary from its source code. This is the recommended way for most users. If you do not have Git, Make, and Go installed, and you would prefer not to install them, you can install the regen binary using a pre-built package.

In the following examples we use the latest available version of Regen Ledger (v6.0.0), which is the same version used by node operators running Regen Mainnet and Regen Testnet.

Prerequisites

In order to build the regen binary from source, you'll need the following:

Note: If you are new to go and installing it for the first time, make sure you include the following PATH export in your bash profile: export PATH=$(go env GOPATH)/bin:$PATH.

Source Code

Clone the regen-ledger repository:

git clone https://github.com/regen-network/regen-ledger

Change to the regen-ledger directory:

cd regen-ledger

Check out the latest stable version:

git checkout v6.0.0

Build Only

The following command only builds the regen binary. After running the command, the built binary will be available in a build directory within the current directory.

Build the regen binary:

make build

Check to make sure the build was successful:

./build/regen version

You should see the following:

v6.0.0

Are you not seeing the above?

  • Check the version of your source code using git status and try rerunning git checkout to see if there are any errors that might point to the problem.

Build and Install

The following command builds and installs the regen binary using go install under the hood. After running the command, a separate built binary (separate from the binary in your build directory) will be available in your go bin directory and therefore available globally.

Build and install the regen binary:

make install

Check to make sure the installation was successful:

regen version

You should see the following:

v6.0.0

Are you not seeing the above?

  • Check the version of your source code using git status and try rerunning git checkout to see if there are any errors that might point to the problem.
  • You may have previously installed the regen binary and placed it within /usr/local/bin. To use the version in your go bin directory, remove the regen binary from this location.

Pre-Built Package

The following instructions are for installing the regen binary using a pre-built package. Packages for different operating systems are provided as release assets included with each release.

For Linux Distributions

Download the zip file:

curl -LO https://github.com/regen-network/regen-ledger/releases/download/v6.0.0/regen-ledger-6.0.0-linux-amd64.tar.gz

Verify the checksum:

sha256sum regen-ledger-6.0.0-linux-amd64.tar.gz

You should see the following:

b50f0bca044a06d7c9e6012c1297bce382ed97facb2dbba6a3a9d7e6399d8c86 regen-ledger-6.0.0-linux-amd64.tar.gz

Uncompress the tar.gz file:

mkdir regen-ledger-6.0.0-linux-amd64
tar -xzf regen-ledger-6.0.0-linux-amd64.tar.gz -C regen-ledger-6.0.0-linux-amd64

Move the binary to your local bin directory:

sudo mv regen-ledger-6.0.0-linux-amd64/regend /usr/local/bin/regen

Check if the installation was successful:

regen version

You should see the following:

v6.0.0

Additional Packages

Additional packages and checksums are available under "Assets" on the Release Pageopen in new window.