Add a collector

A telemetry collector reads a Starlink terminal on site and sends its readings to your Nexus Telemetry Fleet server. It connects outbound, so the site requires no inbound address and no open port. Owner and Admin can generate the enrolment token.

Enrolment token

Press Add telemetry collector, name the terminal, then press Generate Token. A blank name uses the host’s hostname, and the token is listed as Invitation with the date and time.

Setting Default Other values
Max uses 1 Above 1, the name applies to the invitation, and each terminal takes its host’s hostname
Expires 24 hours 1 hour, 48 hours, 7 days, 30 days
Group No group (Ungrouped) Any group, once one exists

Warning: the token is shown once. A lost token cannot be recovered. Generate another.

Copy the command for the host’s platform. The command includes the fleet server’s address, the token and the name. Token only copies the token by itself, for the Setup page on Windows and macOS.

Platform commands

Run the copied command on the host. The commands below have placeholders. The generated command has the real values.

Docker

Any operating system, update by pulling a new image

bash
docker run -d --pull always --name nf-collector --restart always --network host \
  -e NF_SERVER=<your-address> \
  -e NF_TOKEN=<token> \
  -e NF_SOURCES=starlink,connection,ping \
  -e NF_DEVICE_NAME='<terminal name>' \
  -v nf-data:/var/lib/nexus-fleet \
  registry.nexustelemetry.com/nf-collector:latest

Debian and Ubuntu

Signed apt repository, updates arrive through apt

bash
sudo apt-get install -y curl gpg
curl -fsSL https://nexustelemetry.com/nexustelemetry-public.asc | sudo gpg --dearmor --yes -o /usr/share/keyrings/nexustelemetry.gpg
echo "deb [signed-by=/usr/share/keyrings/nexustelemetry.gpg] https://fleet-downloads.nexustelemetry.com/apt stable main" | sudo tee /etc/apt/sources.list.d/nexustelemetry-fleet.list
sudo apt-get update && sudo apt-get install -y nf-collector
sudo nf-collector enrol --server <your-address> --token <token> --name '<terminal name>'

Windows

Signed installer, installs the collector service and the tray app

Download the installer and double-click it, then open the setup page from the tray icon and enter the address and the token. Or run the commands below from an elevated PowerShell. The hash must match the expected value in the generated command.

powershell
Invoke-WebRequest https://fleet-downloads.nexustelemetry.com/fleet/stable/<version>/NexusFleetCollector-<version>.msi -OutFile NexusFleetCollector-<version>.msi
Get-FileHash NexusFleetCollector-<version>.msi -Algorithm SHA256   # expect <sha256>
msiexec /i NexusFleetCollector-<version>.msi /qn
"C:\Program Files\NexusFleet\nf-collector.exe" enrol --server <your-address> --token <token> --name '<terminal name>'

macOS

Signed and notarised package, installs the daemon and the menu-bar app

Download the package and double-click it, then open the setup page from the menu bar icon and enter the address and the token. Or run the commands below. The hash must match the expected value in the generated command.

bash
curl -fsSLO https://fleet-downloads.nexustelemetry.com/fleet/stable/<version>/NexusFleetCollector-<version>.pkg
shasum -a 256 NexusFleetCollector-<version>.pkg   # expect <sha256>
sudo installer -pkg NexusFleetCollector-<version>.pkg -target /
sudo nf-collector enrol --server <your-address> --token <token> --name '<terminal name>'

RHEL and Fedora

Signed rpm repository, updates arrive through dnf

bash
sudo rpm --import https://nexustelemetry.com/nexustelemetry-public.asc
sudo tee /etc/yum.repos.d/nexustelemetry-fleet.repo <<'EOF'
[nexustelemetry-fleet]
name=Nexus Telemetry Fleet (stable)
baseurl=https://fleet-downloads.nexustelemetry.com/rpm/stable/
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://nexustelemetry.com/nexustelemetry-public.asc
EOF
sudo dnf install -y nf-collector
sudo nf-collector enrol --server <your-address> --token <token> --name '<terminal name>'

Terminal on the dashboard

The terminal appears on the dashboard once the collector connects, under its group if one was set. Its name is the one given with the token, or the host’s hostname if the name was left blank.

Cancel an invitation on Tokens. Next, read Dashboard.

← Account and fleet server Dashboard →