Installation Guide

# Run as root or with sudo
curl -fsSL https://api.net-flux.com/install.sh | sudo bash -s -- \
  --token      YOUR_JOIN_TOKEN     \
  --network    YOUR_NETWORK_ID     \
  --controller https://api.net-flux.com

# Expected output:
  · Detecting OS: Ubuntu 22.04 (x86_64)
  · Installing WireGuard...
  · Connecting to nearest planet: Frankfurt (8ms)
  · Joining network...
  ✓ Connected! Virtual IP: 10.10.0.2

# Check status
systemctl status netflux

# View live logs
journalctl -u netflux -f

# Restart after config change
sudo systemctl restart netflux

# Uninstall
curl -fsSL https://api.net-flux.com/install.sh | sudo bash -s -- --uninstall

# Same command as Linux — works on RPi OS Bullseye and Bookworm
curl -fsSL https://api.net-flux.com/install.sh | sudo bash -s -- \
  --token      YOUR_JOIN_TOKEN     \
  --network    YOUR_NETWORK_ID     \
  --controller https://api.net-flux.com

docker run -d \
  --name        netflux-agent   \
  --privileged                   \
  --network     host             \
  --restart     unless-stopped   \
  -e NETFLUX_TOKEN=YOUR_JOIN_TOKEN    \
  -e NETFLUX_NETWORK=YOUR_NETWORK_ID  \
  -e NETFLUX_CONTROLLER=https://api.net-flux.com \
  ghcr.io/alicia-bots/netflux-agent:latest

# docker-compose.yml
services:
  netflux:
    image: ghcr.io/alicia-bots/netflux-agent:latest
    privileged: true
    network_mode: host
    restart: unless-stopped
    environment:
      - NETFLUX_TOKEN=YOUR_JOIN_TOKEN
      - NETFLUX_NETWORK=YOUR_NETWORK_ID
      - NETFLUX_CONTROLLER=https://api.net-flux.com

# In Windows PowerShell (run as Administrator)
wsl --install -d Ubuntu-22.04

# Then open WSL Ubuntu and run the standard install command
curl -fsSL https://api.net-flux.com/install.sh | sudo bash -s -- \
  --token      YOUR_JOIN_TOKEN   \
  --network    YOUR_NETWORK_ID   \
  --controller https://api.net-flux.com

curl -s -X POST https://api.net-flux.com/api/v1/networks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Network", "ip_pool": "10.10.0.0/24"}'

# Response:
{
  "network_id":  "c935163e6bac957e",
  "name":        "My Network",
  "ip_pool":     "10.10.0.0/24",
  "join_token":  "5487c2cb89979873..."
}

# Create a new join token for a network
curl -s -X POST https://api.net-flux.com/api/v1/networks/NETWORK_ID/tokens \
  -H "Authorization: Bearer YOUR_API_KEY"

{"join_token": "7a26797531929275..."}

curl -fsSL https://api.net-flux.com/netflux -o /usr/local/bin/netflux && chmod +x /usr/local/bin/netflux

sudo netflux join YOUR_NETWORK_ID --token YOUR_JOIN_TOKEN

# Optional: set a display name for this device
sudo netflux join YOUR_NETWORK_ID --token YOUR_JOIN_TOKEN --name "Warehouse Robot 3"

# Expected output:
  · WireGuard found
  · Joining network abc123...
  · Starting interface...
  ╔════════════════════════════════════════╗
  ║   NetFlux connected!                   ║
  ╚════════════════════════════════════════╝

  Virtual IP:  10.10.0.3
  Peers:       2 connected
  Network:     YOUR_NETWORK_ID

# Show virtual IP and WireGuard tunnel
netflux status
NetFlux status:
interface: rnet0
  public key: abc123...
  listening port: 51820
Virtual IP: 10.10.0.3

# List peers on your network
netflux peers
  2 peer(s):
  · 10.10.0.1    warehouse-robot-1    Online
  · 10.10.0.2    dev-laptop           14s ago

# Ping another device
ping 10.10.0.1
64 bytes from 10.10.0.1: icmp_seq=0 ttl=64 time=12.3 ms

# SSH into another device on the network
ssh user@10.10.0.1

# Set on every ROS2 machine in the network
export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp
export ROS_DOMAIN_ID=42
export ROS_IP=10.10.0.X   # your NetFlux virtual IP

# Tell CycloneDDS to discover peers by IP, not multicast
export CYCLONEDDS_URI='<CycloneDDS><Domain><Discovery><Peers>
  <Peer address="10.10.0.1"/>
  <Peer address="10.10.0.2"/>
</Peers></Discovery></Domain></CycloneDDS>'

# Test it
ros2 topic list
/cmd_vel
/odom
/scan
/tf

# Run the watchdog node alongside your robot control stack
ros2 run netflux watchdog \
  --ros-args \
  -p timeout_ms:=500          \
  -p monitored_peer:=10.10.0.1 \
  -p cmd_vel_topic:=/cmd_vel

# Output when link drops:
[netflux_watchdog]: Link to 10.10.0.1 lost (523ms) — publishing STOP

systemctl status netflux
journalctl -u netflux -n 50

# Check the WireGuard interface is up
ip addr show rnet0

# Check peers are configured
sudo wg show rnet0

# Check there's a route
ip route show | grep rnet0