OriginTrail
  • Get started with OriginTrail
  • OriginTrail Ecosystem — Call for Papers (Coming Soon)
  • Key Concepts
    • Decentralized Knowledge Graph (DKG)
    • DKG key concepts
  • Build with DKG
    • Quickstart (test drive the DKG in 5 mins)
      • Quickstart with Node.js
      • Quickstart with Python
    • ChatDKG builder toolkit
      • DKG SDK
        • Development environment setup
        • DKG Javascript SDK (dkg.js)
          • Interact with DKG paranets
          • Knowledge submission & curation
          • Paranet's incentives pool implementation
        • DKG Python SDK (dkg.py)
      • DKG paranets
        • Deploying a DKG paranet
        • Building with DKG paranets
        • Syncing a DKG Paranet
        • Initial Paranet Offerings (IPOs)
          • IPO specification
          • Launching your IPO
          • Paranet's incentives pool
          • IPO voting
      • AI agents
        • ElizaOS DKG agent
        • Custom DKG Python agent
        • Custom DKG JavaScript agent
    • DKG Edge Node
      • DKG Edge Node architecture
      • Get started with the Edge Node boilerplate
        • Automated setup with the installer
        • Manual setup
        • Usage example
      • Customize & build with the Edge Node
      • Knowledge Mining and dRAG examples
      • Deploy your Edge Node based project
        • Automated deployment with installer
      • DKG Edge Node inception program
      • DKG Edge Node API documentation
    • DKG Core Node
      • Run a V8 Core Node on testnet
        • Preparation for V8 DKG Core Node deployment
        • V8 DKG Core Node installation
      • Run a V8 Core Node on mainnet
        • Preparation for V8 DKG Core Node deployment
        • V8 DKG Core Node installation
  • Delegated staking
    • Delegated staking—Introduction
      • Step-by-step staking
      • Redelegating stake
  • Integrated Blockchains
    • Base blockchain
      • Connect to Base
    • Gnosis chain
      • Connect to Gnosis
    • NeuroWeb
    • Teleport instructions - NeuroWeb
    • Bridging to Moonbeam
    • Deployed smart contracts
  • Bounties & rewards
    • General bug bounty
    • Code contributions & V8 bug bounty
  • Whitepapers & RFCs
    • OriginTrail whitepaper
    • OriginTrail RFCs
  • Useful Resources
    • What's new with OriginTrail V8
    • DKG V8 guidebook
      • Protocol updates
      • Feature roadmap
      • How to upgrade to V8?
    • Public nodes
    • Tutorials
    • Test token faucet
    • Development principles
    • Community created resources
    • Linked data & knowledge graphs
    • Available networks, network details and RPCs
    • OT Node Engine implementation details
      • Modules
      • Command Executor
    • Contribution guidelines
      • Guidelines for automated test contributions
    • Explore the OriginTrail ecosystem
Powered by GitBook
On this page
  • Supported operating systems
  • 1. Pre-installation Requirements
  • 2. Download the OriginTrail DKG Edge Node installer
  • 3. Configure the environment (.env)
  • 4. Run installation:
  • Exploring Edge Node Capabilities
  • Need help?

Was this helpful?

Edit on GitHub
  1. Build with DKG
  2. DKG Edge Node
  3. Get started with the Edge Node boilerplate

Automated setup with the installer

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

PreviousGet started with the Edge Node boilerplateNextManual setup

Last updated 10 days ago

Was this helpful?

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:

  • (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. To check your wallets funds on Neuroweb testnet, use .

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 - Create .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 - Populate .env file:

To simplify the development setup, we’ve provided the env-setup.js script. This script will automatically generate and populate all required .env parameters, including:

  • Management keys

  • Operational keys

  • Publishing keys (for all supported chains)

  • Node name (same across all chains)

To populate your .env file, run:

We assume that Node.js is already installed on your system to run the env-setup.js script. If Node.js is not installed or you're setting up on a fresh system, we recommend using NVM to install Node.js version 20 along with npm.

Once Node.js and npm are successfully installed, you can use the following command to populate your .env file:

npm install ethers && node env-setup.js

3.3 Funding your keys:

Once the .env file is populated with the mandatory parameters, you will have to fund the keys (wallets) which were added to the .env file.

  1. Open your .env file using nano or any text editor.

  2. Locate the following wallet entries for each blockchain:

    • OPERATIONAL_KEY_PUBLIC_ADDRESS

    • MANAGEMENT_KEY_PUBLIC_ADDRESS

    • PUBLISH_WALLET_01_PUBLIC_KEY

    1. Neuroweb: TRAC and NEURO

    2. Gnosis Chiado: TRAC and xDai

OPERATIONAL_KEY_PUBLIC_ADDRESS and MANAGEMENT_KEY_PUBLIC_ADDRESS require a small amount of native token (e.g., NEURO, ETH, xDAI) while PUBLISH_WALLET_01_PUBLIC_KEY requires both native and TRAC token in order to be able to publish Knowledge Assets.

It’s important to ensure that your node creates its profile on the blockchain specified in DEFAULT_PUBLISH_BLOCKCHAIN parameter.

For Neuroweb, first use the faucet to acquire NEURO in order to initiate your wallet, and then request TRAC, otherwise the TRAC funding transaction will fail.

3.4 - Configure LLM functionality:

Edge Node components require a large language model (LLM) to operate. To ensure full functionality, you must provide at least one of the supported external API keys below:

🔐 Ensure that the API keys have the necessary usage quotas and permissions based on your expected workload. Always keep them secure and never share them publicly.

Optional .env parameters:

The Edge Node supports additional external services and tools that can be configured via the .env file before running the installer. Below is a list of supported services represented as configuration 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=""

4. Run installation:

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: 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:

  • 3001 - Authentication service

  • 3002 - API (backend)

  • 5002 - dRAG

  • 5005 - Knowledge mining

  • 8900 - OT Node

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

Need help?

Follow our official channels for updates:

Fund wallets for at least one blockchain in the .env file using our faucet. Instructions on how to use the Faucet can be found on the . Our faucet can provide you with the testnet tokens as follows:

Base Sepolia: TRAC (ETH for Base Sepolia can be received via the faucets provided in the official Base )

API Key – Used to access OpenAI’s GPT models. Example: sk-4hsR2exampleXv29NSHtDyzt0NlFgk1LXj6zS7

API Key – Used to access Anthropic’s Claude models. Example: claude-56a8e5eexamplef27b5b6e47b1

UI will be available on

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 section to learn how to interact with the node and understand what it can do.

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

Git
Homebrew
Subscan explorer
Faucet documentation page
documentation
OpenAI
Anthropic
http://localhost
Usage Example
Discord
X
Medium
Telegram