Skip to main content

Hub

The hub facilitates a control plane. The hub is split into two parts: the hub server and the hub client. The hub server is a centralized service that nodes can connect to. The hub client is a service that runs on each node and connects to the hub server.

Hosting a hub server​

To host a hub server, you need to enable the hubServer section in the Config file

config.yaml
node:
  name: server
http:
  address: 127.0.0.1:8769

hubServer:
  authenticationByRequest:
    timeout: 5m

Connecting a node to the hub server​

On the node you want to connect to the hub server, run:

sudo np authenticate-by-request http://localhost:8769

Replace http://localhost:8769 with the actual HTTP address of the node hosting the hub server.

To approve the authentication request, on the node hosting the hub server run:

sudo np authentication-requests

A list of pending authentication requests will be displayed. Select the client and press ENTER to approve the request.

Connecting a Node to the Hub Server​

This process is split into two parts: initiating the request on the Node and approving it on the Hub.

Prerequisite

Ensure you have access to both the Node dashboard and the Hub server before proceeding.

Part 1: The Node​

On the Node device, follow these steps to send a connection request.

  1. Open Settings: Navigate to the Dashboard and click the Settings button on the left-hand sidebar.

    Settings button

  2. Initiate Connection: Click the Connect to Hub button. Connect to hub button

  3. Enter Host Address: Input the host address (IP or URL) of the Hub you want to join. request to join

Confirmation

After clicking the request button, you will see a notification on the screen confirming the request was sent: requested to join

Part 2: The Hub​

Once the request is sent, switch to the Hub interface to finalize the connection.

  1. Navigate to Nodes: Click the button on the left-hand side of the dashboard to enter the Nodes section.

  2. Locate the Request: You will see a pending request to join the hub in the list. Hub connection request

  3. Accept the Node: Click the Accept button.

Success

The new node will immediately appear in your Nodes Overview list. node overview