FuLink Worker Installation

FuLink can be run either from a docker container or via local installation. Running Fulink via a docker container simplifies the installation process and negates the need for a local installation. Therefore, it is recommended that you use docker for installation.

Docker install and update

1. Install Docker Engine

2. Pull the latest FuLink image.

3. docker pull fulink/fulink:latest

4. Create a directory in your host machine for later usage.

   cd /root
   
   mkdir fulink

5. Copy the keystore file of the Worker account to the host directory selected in step 3. The private file generated by FuLink Worker will also be stored in this directory.

   cp /root/geth-linux-amd64-1.10.23-d901d853/keystore/* /root/fulink

   Please ensure that this directory has 777 permissions:

   chmod -R 777 /root/fulink

Local Install

FuLink supports Python 3.9. If you don’t already have it, install Python.

apt install python3-pip

In order to isolate global system dependencies from fulink-specific dependencies, we highly recommend using python-virtualenv to install fulink inside a dedicated virtual environment.

For full documentation on virtualenv see:

pip install virtualenv

1. Create a Virtual Environment

   Create a virtual environment in a folder somewhere on your machine. This virtual environment is a self-contained directory tree that will contain a python installation for a particular version of Python, and various installed packages needed to run the node.

   virtualenv /root/fulink-venv

2. Activate the newly created virtual environment

   source /root/fulink-venv/bin/activate

3. Download built package or Download source package and install the Fulink package Download the python package:

   wget https://download.fulink.org/release/core/fulink-0.5.0-py3-none-any.whl

   Install the python package:

   pip install fulink-0.5.0-py3-none-any.whl

4. Verify Installation

   Before continuing, verify that your Fulink installation and entry points are functional.

   Activate your virtual environment, if not activated already:

   source /root/fulink-venv/bin/activate

   Next, verify fulink is importable. No response is successful, silence is golden:

   python -c "import fulink"

   Then, run the fulink --help command:

   fulink --help

   You will get this output:

   Usage: fulink [OPTIONS] COMMAND [ARGS]...
   
   
     Top level command for all things fulink.
   
   
   Options:
   
     --version       Echo the CLI version
   
     --config-path   Echo the configuration root directory path
   
     --logging-path  Echo the logging root directory path
   
     --help          Show this message and exit.
   
   
   Commands:
   
     alice     "Alice the Policy Authority" management commands.
   
     bob       "Bob management commands.
   
     bond      Bond an operator to a staking provider.
   
     contacts  Lightweight contacts utility to store public keys of known...
   
     enrico    "Enrico the Encryptor" management commands.
   
     porter    Porter management commands.
   
     status    Echo a snapshot of live FuLink Network metadata.
   
     unbond    Unbonds an operator from an authorized staking provider.
   
     ursula    "Ursula the Untrusted" PRE Re-encryption node management...