Head back to Documentation
Running a QRL node strengthens the network, supports the decentralization and further verifies transactions on the network. This is an essential function of the decentralized architecture QRL relies on.
This allows you to run a private secure node to communicate with the QRL blockchain.
You can use the node to connect the explorer, wallet, and ephemeral messaging features to the gRPC QRL functions.
There are various options available for connecting to the API and setup options for the node can be configured through a user set configuration file.
You can run QRL on most operating systems, though Ubuntu 16.04 is recommended.
Abridged instructions for installing QRL on Ubuntu:
# Update and Upgrade packages sudo apt update && sudo apt upgrade -y # Install Required dependencies sudo apt-get -y install swig3.0 python3-dev python3-pip build-essential cmake pkg-config libssl-dev libffi-dev libhwloc-dev libboost-dev # Make sure setuptools is the latest pip3 install -U setuptools # Install QRL pip3 install -U qrl
If things worked correctly you will now find the
package and the
qrl package. Adding the
--help flag to each will print the various function details.
Installing QRL is simple, and is possible on most modern operating systems. The install relies on
python3.5 or newer and the
pip3 python package install system.
Update and Dependencies
You will need to start with a fully updated system. You will also need a few additional packages depending on your setup. See the correct section for your OS and install all of the requirements.
Update your system ensuring you have the latest packages:
# Issue the following command to update software sudo apt update && sudo apt upgrade -y
Now install all the required dependencies:
# Install the required packages for QRL sudo apt-get -y install swig3.0 python3-dev python3-pip build-essential cmake pkg-config libssl-dev libffi-dev libhwloc-dev libboost-dev
# Update dnf update
# Install required packages dnf install swig cmake gcc gcc-c++ redhat-rpm-config python3-devel python-devel hwloc-devel boost-devel
To build in OSX Please install
brew if you have not already.
# Install brew with /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
This will prompt you through a few questions while it installs.
Having Issues? Please follow the instructions found at the brew main page: https://brew.sh/
# Update brew brew update brew install cmake python3 swig boost hwloc
Windows support in the current version is limited. An alternative is to install Ubuntu using the Linux Subsystem for Windows.
You can run a full node in Windows utilizing the Windows Subsystem for Linux. There are a ton of guides out there on setting this up. Here are a few links to get you going.
The Windows Subsystem for Linux (WSL) is a new Windows 10 feature that enables you to run native Linux command-line tools directly on Windows, alongside your traditional Windows desktop and modern store apps.
You can follow these instructions to install Ubuntu using Linux Subsystem,
Now that we have a freshly updated system, the installation of QRL is a breeze, QRL uses python3 to install. The install is the same for all operating systems after you have installed the requirements. Using the Python3 package installer pip3 we will install QRL.
Before we install QRL make sure setupTools is the latest.
pip3 install -U setupTools
After this completes install QRL with:
pip3 install -U qrl
This will install the QRL package and any required dependencies.
Now that we have QRL installed we can
start_qrl and begin syncing the node. This will begin the node in the foreground of the shell. If you would like to continue using the shell you can either pass the
--quiet flag or run the command in a
screen session ( you will need screen installed ).
This will print out the details of the running QRL processes. For a more verbose output you can pass the
-l option with
DEBUG, INFO,WARNING,ERROR,CRITICAL depending on the level of information you need.
start_qrl -l DEBUG
The node will sync the entire blockchain to your computer, make sure you have enough space. after syncing the chain you will begin seeing blocks added. Congrats, your QRL node is working.
If you would like to see all of the options you can pass along the command line simply add
--help to the end of the command above.
This will print all of the various options available.
By default when the node is started it will NOT mine any coins. You will have to enable using a configuration file in the
The configuration file is where you will change any options you want QRL to observe. You can grab a copy of the file and details about all of the settings in our Configuration Guide
The defaults can be used to run a QRL node, though you may need to change some of the directives for your use.