Automated setup with the installer

This page will guide you through the DKG Edge Node installation process for MacOS and Linux

Supported operating systems

• macOS

• Ubuntu 22.04 and Ubuntu 24.04

Edge node installer will detect your operating system automatically (MacOS or Linux) so no configuration related to this is required by the user.

1. Pre-installation Requirements

Before getting started with the installation, there are a few important preparations to make. The process requires certain inputs such as wallet addresses and funds. The following sections will walk you through each of these prerequisites step by step.

1.1. Software dependencies:

• Git

• Homebrew (macOS)

1.2. Edge node keys (wallets):

The Edge Node uses three types of keys: a management key, an operational key, and a publishing key. The management and operational keys need a small amount of the utility token based on the blockchain you will be using (NEURO, Base ETH, xDai) to sign transactions for certain operations, while publishing key requires both the utility and TRAC tokens to perform publishing operations.

1.3. Funding Edge node keys (wallets):

In order to fund your wallets, please refer to our faucet page.

In order to receive TRAC to on Neuroweb, first acquire NEURO via faucet to initiate your wallet.

Note: To check your wallets funds on Neuroweb testnet, use Subscan explorer.

2. Download the OriginTrail DKG Edge Node installer

Once you have your wallets funded and ready, you may proceed with cloning, configuring and running the Edge node installer by following the instructions provided below.

2.1 Clone the edge-node-installer repository using git:

git clone https://github.com/OriginTrail/edge-node-installer.git
cd edge-node-installer

3. Configure the environment (.env)

3.1 Prepare .env file using .env.example:

cp .env.example .env

The .env.example is used as a guide template, but is well documented and should help you understand what each of the variables mean.

3.2 Open .env file using nano or any editor of your choice:

nano .env

Refer to the section below which will help you prepare your Edge node configuration.

MADATORY PARAMETERS (.env)

• DEPLOYMENT_MODE (defaults to development) - The installer differentiates between two modes of operation - development and production, controlled by the DEPLOYMENT_MODE variable. Production mode enables persistency, by enabling and starting services. Production mode is currently only supported for systems with systemd.

• DB_USER - Set this to root

• DB_PASSWORD - used to connect to existing MySQL instance, or setup an authenticated connection on fresh installs.

If you already have a password for root user configured, pass it to the DB_PASSWORD variable in .env. and installer will use it to setup MySQL tables required for the Edge node services. If you do not have MySQL running locally, DB_PASSWORD that you provide will be set as your root password.

• DEFAULT_PUBLISH_BLOCKCHAIN and BLOCKCHAIN_ENVIRONMENT - By default, the Edge Node publishes to the Neuroweb testnet blockchain. You can change this behaviour by editing the DEFAULT_PUBLISH_BLOCKCHAIN and BLOCKCHAIN_ENVIRONMENT variables.

To prevent loss of funds, we recommend developing the Edge Node on the testnet environment at this stage since you are still getting familiar with the technology.

• PUBLISH_WALLET_01_PUBLIC_KEY and PUBLISH_WALLET_01_PRIVATE_KEY - Are keys used by the node to publish knowledge assets to the blockchain (using the default blockchain configuration mentioned above).

At least 1 key should be provided to the installer in order for the Edge node to be able to execute publish operations.

• NODE ENGINE PARAMETERS - This section of the .env file is related to passing management and operational keys for your Edge node as well as RPC endpoints which your node engine will use to communicate with the selected blockchain.

Populating NODE ENGINE PARAMETERS is required for at least 1 blockchain otherwise Edge node will not connect to any chain which will prevent services from properly operating.

RPC endpoints for Neuroweb blockchain are not required and are automatically passed to your node engine (Core node) while for Base and Gnosis, we have already added public ones. If you have your own, private RPC endpoint for Base or Gnosis, you can replace public ones.

• OPEN_AI_KEY or ANTHROPIC_API_KEY - Edge Node components rely on LLMs to function properly. To ensure full functionality, at least one of the two external services is required.

OPTIONAL PARAMETERS (.env)

Edge node supports multiple external services and tools which can be configured via .env before running the installer. The list of supported ones is presented below in the form of parameters:

# Unstructured.io - can be obtained from https://unstructured.io/api-key-free 
# (used by default for parsing PDF documents)
UNSTRUCTURED_API_URL=""

# HuggingFace - can be obtained from https://huggingface.co/settings/tokens 
# (used if you use vector search in your dRAG pipeline)
HUGGINGFACE_API_KEY=""

# Milvus (vector database) - Can be obtained from https://cloud.zilliz.com/ 
# (used if using vector search for the dRAG pipeline)
MILVUS_USERNAME=""
MILVUS_PASSWORD=""
MILVUS_URI=""

4. Execute the installer by running:

Once all the required parameters have been configured in the .env file, simply run the installer and wait for it to finish the Edge node setup.

bash edge-node-installer.sh

Edge node installer will deploy each component within the edge_node directory: airflow, drag-api, edge-node-auth-service, ka-mining-api, ot-node.

Edge node services will be available and listening on the following local ports upon installation:

• UI will be available on http://localhost
• 3001 - Authentication service

• 3002 - API (backend)

• 5002 - dRAG

• 5005 - Knowledge mining

• 8900 - OT Node

• 8008 - Airflow web-server

UI (Edge node interface) will be cloned and configured in the following paths:

• MacOS - /opt/homebrew/etc/nginx/servers/edge-node-ui

• Linux - /var/www/edge-node-ui

The default login credentials for the Edge node UI are as follows:

username: my_edge_node

password: edge_node_pass

Exploring Edge Node Capabilities

Once the Edge Node is up and running in your local environment, you’re ready to explore its features and capabilities. To get started, refer to the Usage Example section to learn how to interact with the node and understand what it can do.

Need help?

If you encounter any issues during the installation process or have questions about any of the topics above, jump into our official Discord and ask for assistance.

Follow our official channels for updates:

• X
• Medium
• Telegram