Setup page

The collector serves the setup page on its own host, at http://127.0.0.1:41700. The page enrols the collector, then shows its status. It is reachable from that host only.

Enrol

  1. Open http://127.0.0.1:41700 on the collector’s host.
  2. Paste the fleet server address and the enrolment token from the dashboard’s Add telemetry collector window.
  3. Name the terminal, or leave the name blank to use the host’s hostname.
  4. Press Enrol this collector.

The collector restarts and the terminal appears on the dashboard. The page reports a bad or used token when the fleet server answers. An address that does not answer is retried for several minutes before the page reports it.

Position defaults to the terminal’s own GPS. Fixed coordinates or an NMEA receiver can be set on this page, or later on the dashboard. See Collector GPS.

Status

After enrolment the page is read-only. It shows the collector’s state, its version, its fleet server, its disk use and a link to the last lines of its log, with a support bundle to download. Naming, settings and retirement are on the dashboard. When the onboard status page is on, this page links to it.

On macOS and Windows the installer adds an app named Nexus Telemetry Fleet Collector to the menu bar or the tray. It opens the setup page and shows the collector’s status. Quitting it does not stop the collector.

Menu item Action
Open Settings… Opens the setup page in the browser
Open status page… Opens the onboard status page. Disabled while the page is off
Check for Updates Reports whether a newer version is available
Pause Collector Stops the collector service, after the operating system’s administrator prompt. The item becomes Resume Collector
Start at Login Whether the app opens when someone signs in to the host
Quit Closes the app. The collector keeps running

Port and default

setup_page in collector.toml turns the page on or off and sets its port, and NF_SETUP_PAGE in the environment overrides the file. A change takes effect at the next restart.

Value Effect
unset or 1 On, at 127.0.0.1:41700
a port number On, at that port on the loopback address
off, 0 or false Off
Platform Default
macOS and Windows On
Docker On
Debian, Ubuntu, RHEL and Fedora Off

With the page off, an unenrolled collector with no token stops and prints the nf-collector enrol command to run. See Command line for the command.

← Release channels Onboard status page →