Relay Nodes Setup (Docker)

Firewall Setup

To ensure your Relay Node can communicate properly, you'll need to configure your firewall to allow traffic on the port (1194). Below are the instructions for setting up firewall rules on both Linux and Windows.

Linux (Ubuntu) Firewall Setup

1. Check if UFW (Uncomplicated Firewall) is installed:

   sudo ufw status

   If UFW is not installed, you can install it with:

   sudo apt-get install ufw

2. Allow the required port:

   To allow traffic on port 1194, run the following command:

   sudo ufw allow 1194/udp

3. Enable UFW:

   If UFW is not already enabled, enable it with:

   sudo ufw enable

4. Verify the UFW status:

   Ensure that the rule has been added and UFW is active:

   sudo ufw status

Windows Firewall Setup

1. Open Windows Firewall:

   • Press Win + R, type firewall.cpl, and press Enter.

   • In the Windows Firewall window, click on "Advanced settings" on the left side.

2. Create a new inbound rule:

   • In the "Windows Firewall with Advanced Security" window, click on "Inbound Rules" on the left pane.

   • Click on "New Rule…" on the right pane.

3. Rule Type:

   • Select "Port" and click "Next."

4. Protocol and Ports:

   • Choose "UDP."

   • Specify the port number (default: 1194).

   • Click "Next."

5. Action:

   • Choose "Allow the connection" and click "Next."

6. Profile:

   • Select when the rule applies (Domain, Private, Public). Generally, leave all selected.

   • Click "Next."

7. Name the Rule:

   • Give your rule a name, e.g., "BrinxAI Relay Node."

   • Click "Finish."

Installation on Linux & Windows

Step 1: Install Docker

To install Docker on your Linux Ubuntu system, please follow the instructions provided in the official Docker documentation by visiting Docker Engine Installation.

https://docs.docker.com/engine/install/ubuntu/

To install Docker on your Windows system, please follow the instructions provided in the official Docker documentation by visiting Docker Engine Installation.

https://docs.docker.com/desktop/install/windows-install/

Step 2: Run the Relay Image from Docker Hub

Run the following commands in your terminal: AMD64:

sudo docker run -d --name brinxai_relay --cap-add=NET_ADMIN -p 1194:1194/udp admier/brinxai_nodes-relay:latest

ARM64:

sudo docker run -d --name brinxai_relay --cap-add=NET_ADMIN -p 1194:1194/udp admier/brinxai_nodes-relay:arm64

Step 5: Register Your Relay Node

1. Go to workers.brinxai.com.

2. Create an account using your email and password.

3. Log in to your account.

4. Find your IP address by visiting What Is My IP Address or using the ifconfig command in the terminal.

5. Enter your Node Name (Any) and IP address in the Worker Dashboard and click "Add Node".