Oriondocs
Get started
Docs›Guides›Add a server

Add a server

Install the Orion Node on a Linux or macOS machine so Core can watch it.

A server is a machine you want Orion to watch. You add it in the Console, then install the Node on it: a small program that reports the machine’s health, services and Docker containers to Core. It supports Linux (systemd) and macOS (launchd). Core needs to be running first, see Install Core.

Add the server

  1. In the Console, open Servers and choose Add server.
  2. Copy the install command. It carries a one-time token that lets the Node register.
  3. Run it on the machine you want to watch.

Install the Node

The command from the Console looks like this:

curl -fsSL https://github.com/sunday-studio/orion/releases/latest/download/orion-node-installer.sh | \
  ORION_ENROLLMENT_TOKEN=<token> bash -s -- --core-url https://orion.example.com

Use the address of your own Core. The machine you install on must be able to reach it. The installer prints its plan, downloads the Node, verifies every file against signed checksums, writes a config, registers the machine with Core and starts the service. The token is the one-time value from the Console, or ORION_ENROLLMENT_TOKEN from Core’s .env. The server appears under Servers within a minute.

Add --dry-run to preview without changing anything, or --user to install for the current user without root.

Paths

LinuxmacOS
Config/etc/orion/config.yaml/usr/local/etc/orion/config.yaml
State/var/lib/orion/state.db/usr/local/var/lib/orion/state.db
Log/var/log/orion/node.log/usr/local/var/log/orion/node.log
Service/etc/systemd/system/orion-node.servicelaunchd

Verify

orion-node status
orion-node doctor

doctor checks the config, the connection to Core, discovery, logs and the service, and prints the exact command that fixes anything wrong.

The installer asks no questions: when it finishes, CPU, memory, disk and network already report. orion-node setup is optional and lets you pick what else to monitor from what it found on the server.

Watch Docker containers on Linux

To watch containers, the orion user needs permission to read /var/run/docker.sock. Add it to the docker group and restart the Node.

Update, roll back, uninstall

orion-node update
orion-node update --version 0.3.0

To remove a server, run the installer with uninstall. Add --purge to delete its config and state too:

curl -fsSL https://github.com/sunday-studio/orion/releases/latest/download/orion-node-installer.sh | \
  sudo bash -s -- uninstall --yes

The server stays listed in the Console until you remove it there.

Recover a token

If the Node can no longer authenticate, apply a replacement token and restart.

orion-node token apply --token-file /secure/path/replacement-token
orion-node restart

Cloned machines

The Node keeps a machine-identity.json beside its state database. If you clone a VM or image, the hostname or machine id no longer matches, and the copy registers as a new, separate server rather than impersonating the original.

Was this page helpful? Thanks, noted.