Setting up a Node

OriginTrail Decentralized Network is designed for scalability and enables anyone to run a node. Here, you can find all the resources and instructions for your setup. The network is currently in the test stage, enabling you to get familiar with the technology before the launch of the main network in Q1 2019.

VIDEO

Video 1: Quick setup

Video 1: Quick setup

Video 1: Quick setup

Requirements

Minimum requirements

2 GB RAM Memory and 5 GB HDD Free Disk Space

Install a Node

There are two ways to install ODN nodes: the express installation and manual installation. Both ways are explained below.

Express Installation via Docker - Recommended for non-advanced users

The fastest way to take ODN Testnet for a spin - install fast and edit settings afterwards. Docker is a free application that enables you to run software packages - you will get all the necessary commands in these instructions.

To install on Mac

1. Download and install Docker

Download the Docker app - community edition, stable version - and follow the installation instructions for your operating system.

Download

https://download.docker.com/mac/stable/Docker.dmg arrow-img

Minimum requirements: Docker for Mac works on OS X El Capitan 10.11 and newer macOS releases.

Having troubles? Here are the instructions

https://docs.docker.com/docker-for-mac/install/ arrow-img

For older versions use Docker Toolbox

https://docs.docker.com/toolbox/overview/ arrow-img

2. Start docker

Find Docker among your installed programs and start it. Wait for the green indicator that Docker is running.

3. Open Terminal (Mac) and Finish the Installation Process

Once you’ve installed a stable version of Docker for your operating system, open the “Terminal” application on Mac (cmd+space to search for it or find it in the Applications/Utilities folder) and input the commands below.

1. Run the below command once (copy-paste it in terminal)

docker run -it --name=otnode -p 8900:8900 -p 5278:5278 -p 3000:3000 --mount source=otnode-vol,destination=/ot-node --mount source=arango-vol,destination=/var/lib/arangodb -e INSTALLATION=local -e TRAVERSE_NAT_ENABLED=1 quay.io/origintrail/otnode:master

This command will download and start your node. It is only used when you install your node for the first time or when you want to completely reinstall your node. The instructions on how to reinstall you node can be found here: How to reinstall the node

Important: Be patient and do not close Terminal before the node is installed, it can take up to 20 minutes to install all the prerequisites (depending on your internet connection and computer hardware). This command will automatically install all necessary prerequisites needed to run a node on the ODN: Node.js, Arango.db, and Neo4j.

In order to further control your node after the installation, please follow the instructions below.

OTNODE STATUS

To check if it is running in Terminal, run the following command: docker ps

This command will show if your node is running.

STARTING OTNODE

1 - docker start otnode - This command will start your node as a background process.

2 - docker start -i otnode - This command will start your node in interactive mode and you will see the node’s process written in the terminal, but this command will not run your node as a background process, which means your node will stop if you close your Terminal/Console.

Note: By using this command, you will be able to see your Houston password in the terminal.

STOPPING OTNODE

You can stop your node in the following two ways:

1 - If you started your node with the docker start otnode command and you wish to stop it from running, use the following command in your terminal: docker stop otnode

2 - If you started your node by using the docker start -i otnode command, you can stop it either by closing the Terminal or simply by pressing the ctrl + c.

4. - Congratulations! You Have Just Installed an OriginTrail Node.

To interact easily with the node, go ahead and proceed with installing the UI for your node, called Houston. Note: When you install the node via Docker, a new Ethereum wallet address is automatically assigned to your node. You can change it at any time for your desired wallet via Houston.

Manually Install via Terminal

If you prefer to manually install each piece of software needed to run an ODN node, you can find detailed instructions in our technical documentation

OriginTrail Documentation arrow-img

To install on Windows

1. Download and install Docker

Download the Docker app - community edition, stable version - and follow the installation instructions for your operating system.

Create Account and Download

https://store.docker.com/editions/community/docker-ce-desktop-windows arrow-img

Minimum Requirements: Microsoft Windows 10 Professional or Enterprise 64-bit

Having trouble? Check out the instructions.

https://docs.docker.com/docker-for-windows/install/ arrow-img

For older versions use Docker Toolbox

https://docs.docker.com/toolbox/overview/ arrow-img

2. Start docker

Find Docker among your installed programs and start it. Wait for the green indicator that Docker is running.

3. Open Command Prompt (Windows) and finish Installation process

Once you’ve installed a stable version of Docker for your operating system, open the Command Prompt on Windows - search for it in the Start Menu - and input the commands below.

1. Run the command below once (copy-paste it into the command prompt):

docker run -it --name=otnode -p 8900:8900 -p 5278:5278 -p 3000:3000 --mount source=otnode-vol,destination=/ot-node --mount source=arango-vol,destination=/var/lib/arangodb -e INSTALLATION=local -e TRAVERSE_NAT_ENABLED=1 quay.io/origintrail/otnode:master

This command will download and start your node. It is only used when you install your node for the first time or when you want to completely reinstall your node. The instructions on how to reinstall you node can be found here: How to reinstall the node

Important: Be patient and do not close Command Prompt before the node is installed, it can take up to 20 minutes to install all the prerequisites (depending on your internet connection and computer hardware). This command will automatically install all the necessary prerequisites needed to run a node on the ODN: Node.js, Arango.db, and Neo4j.

In order to further control your node after the installation, please follow the instructions below.

OTNODE STATUS

To check if it is running in Terminal, run the following command: docker ps

This command will show if your node is running.

node-check-img

STARTING OTNODE

1 - docker start otnode - This command will start your node as a background process.

2 - docker start -i otnode - This command will start your node in interactive mode and you will see the node’s process written in the terminal, but this command will not run your node as a background process, which means your node will stop if you close your Terminal/Console.

Note: By using this command, you will be able to see your Houston password in the terminal.

STOPPING OTNODE

You can stop your node in the following two ways:

1 - If you started your node with the docker start otnode command and you wish to stop it from running, use the following command in your terminal: docker stop otnode

2 - If you started your node by using the docker start -i otnode command, you can stop it either by closing the Terminal or simply by pressing the ctrl + c.

4 - Congratulations! You Have Just Installed an OriginTrail Node.

To easily interact with the node, go ahead and proceed with installing the UI for your node, called Houston. Note: When you install the node via Docker, a new Ethereum wallet address is automatically assigned to your node. You can change it at any time for your desired wallet via Houston.

Manually Install via Terminal

If you prefer to manually install each piece of software needed to run an ODN node, you can find detailed instructions on our GitHub

See more on GitHub arrow-img

To install on Linux/Ubuntu

1. Download and install Docker

Download the Docker app - community edition, stable version - and follow the installation instructions for your operating system.

Download

https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/

Minimum requirements: 64-bit version of Bionic 18.04 (LTS), Artful 17.10. Xenial 16.04 (LTS), or Trusty 14.04 (LTS)

Having troubles? Here are the instructions

https://docs.docker.com/install/linux/docker-ce/ubuntu/

2. Start docker

Find Docker among your installed programs and start it. Wait for the green indicator that Docker is running.

3. Open Terminal (UBUNTU) and finish Installation process

Once you’ve installed a stable version of Docker for your operating system, open the “Terminal” application on Ubuntu and input the commands below.

1. Run the below command once (copy-paste it in terminal)

docker run -it --network host -d --name=otnode --mount source=otnode-vol,destination=/ot-node --mount source=arango-vol,destination=/var/lib/arangodb3 quay.io/origintrail/otnode:master

This command will download and start your node. It is only used when you install your node for the first time or when you want to completely reinstall your node. The instructions on how to reinstall you node can be found here: How to reinstall the node

Important: Be patient and do not close Command Prompt before the node is installed, it can take up to 20 minutes to install all the prerequisites (depending on your internet connection and computer hardware). This command will automatically install all the necessary prerequisites needed to run a node on the ODN: Node.js, Arango.db, and Neo4j.

In order to further control your node after the installation, please follow the instructions below.

OTNODE STATUS

To check if it is running in Terminal, run the following command: docker ps

This command will show if your node is running.

STARTING OTNODE

1 - docker start otnode - This command will start your node as a background process.

2 - docker start -i otnode - This command will start your node in interactive mode and you will see the node’s process written in the terminal, but this command will not run your node as a background process, which means your node will stop if you close your Terminal/Console.

Note: By using this command, you will be able to see your Houston password in the terminal.

STOPPING OTNODE

You can stop your node in the following two ways:

1 - If you started your node with the docker start otnode command and you wish to stop it from running, use the following command in your terminal: docker stop otnode

2 - If you started your node by using the docker start -i otnode command, you can stop it either by closing the Terminal or simply by pressing the ctrl + c.

4 - Congratulations! You Have Just Installed an OriginTrail Node.

To interact easily with the node, go ahead and proceed with installing the UI for your node, called Houston. Note: When you install the node via Docker, a new Ethereum wallet address is automatically assigned to your node. You can change it at any time for your desired wallet via Houston.

Manually Install via Terminal

If you prefer to manually install each piece of software needed to run an ODN node, you can find detailed instructions on our GitHub

See more on GitHub arrow-img

Step 2 - Install Houston app - User Interface for your Node

Houston is the visual user interface which makes operating a node easy for everyone

apple Install on Mac download-img

Version: Houston-0.8.3

windows Install on Windows download-img

Version: Houston-0.8.3

Tokens

With your beta node installation, you automatically receive some test TRAC tokens. If you need additional tokens, go to Faucet and follow the instructions.

Resources

Support Start here, if you experience problem with your installation

Discord Chat - Join our development community.