(DEB) Relay Nodes (Docker) Setup

🌐 BrinxAI Relay Node Installation Guide (AMD64 & ARM64)

IMPORTANT: You must register your Relay Node and obtain a node_UUID from the BrinxAI Dashboard before installation.

🔐 1. Register Your Relay Node

  1. Visit https://brinxai.com/dashboard

  2. Log in or create a new account.

  3. Go to the "Add Node" section.

  4. Enter a Node Name and click "Add Node".

  5. Copy the generated node_UUID – this is required for installation.

📡 2. Firewall Setup (Port 1194/UDP)

BrinxAI Relay Nodes use UDP port 1194, commonly used for VPN traffic.

# Check UFW status
sudo ufw status

# If not installed, install UFW
sudo apt-get install ufw

# Allow UDP port 1194
sudo ufw allow 1194/udp

# Enable firewall
sudo ufw enable

# Confirm the rule is active
sudo ufw status

🖥️ 3. Choose the Right Architecture

BrinxAI provides two separate installation scripts depending on your device’s architecture:

Architecture
Script URL

AMD64 (e.g. most desktops, servers)

install_brinxai_relay_amd64.sh

ARM64 (e.g. Raspberry Pi, ARM-based devices)

install_brinxai_relay_arm64.sh

⚙️ 4. Run the Installation Script

For AMD64:

# Download the script
wget https://raw.githubusercontent.com/admier1/BrinxAI-Relay-Nodes/refs/heads/main/install_brinxai_relay_amd64_deb.sh

# Make it executable
chmod +x install_brinxai_relay_amd64_deb.sh

# Run the script
./install_brinxai_relay_amd64_deb.sh

For ARM64:

# Download the script
wget https://raw.githubusercontent.com/admier1/BrinxAI-Relay-Nodes/refs/heads/main/install_brinxai_relay_arm64.sh

# Make it executable
chmod +x install_brinxai_relay_arm64.sh

# Run the script
./install_brinxai_relay_arm64.sh

During Script Execution:

  • Enter your node_UUID when prompted.

  • The script will:

    • Install required dependencies (Docker, curl, wget, etc.)

    • Configure environment variables and port settings

    • Generate .env and docker-compose.yml

    • Pull the latest Relay Node Docker image

    • Start the Relay container

    • Deploy Watchtower for auto-updates at 4 AM daily

🧪 5. Verify the Relay Node

Docker container name will depend on the type of script used. For instance running the AMD64 script, the container name would be brinxai_relay_amd64 .

# Check container status
docker ps -a --filter "name=brinxai_relay_amd64"

# If not running, check logs
docker logs brinxai_relay_amd64

📝 Notes

  • Make sure UDP traffic on port 1194 is allowed by your firewall and/or cloud provider.

  • The Relay Node includes Watchtower for automatic updates at 4 AM daily.

  • If you're using a cloud VM (e.g., AWS, DigitalOcean), also open UDP port 1194 in your provider’s network rules.

  • If issues occur, check Docker logs or refer to the GitHub Repository.

Would you like this turned into a downloadable PDF or an HTML page for easy internal sharing?

PreviousRelay Node SetupNextFAQ

Last updated