Install
Put the binary on a machine, give it the address it reports under, and start the service, in that order.
In this section
- Install on LinuxFour commands take a server from nothing to a service that reports under the host's own address.
- Install on WindowsFour PowerShell commands, run as one account, leave a service that reports under the machine's own address.
- Bind the HostThe step that gives a machine the address it reports under, and the reason root needs to keep your environment.
- The Sensor ServiceEvery verb, both units, the files they write, and the ceilings declared where you can read them.
- Upgrade and RemoveMove a host to a newer binary without losing its address, take the service off, or take the machine off entirely.
Install Documentation
Bringing a host up is four steps on either platform, and they are separate on purpose: the binary, your key, the host's identity, then the service. Leave the third out and the service installs, runs, and drops everything it collects.
A host that finished all four answers like this:
systemctl status whisper-sensor
whisper-sensor: active (running)
Work through Install on Linux or Install on Windows from the top; each ends with the commands that prove the sensor is reporting. Bind the host is worth reading on its own, because it decides whether anything the sensor collects ever leaves the machine, and because it is the reason root needs sudo -E rather than plain sudo.
The sensor service is the reference for the verbs, the two units, the files each one writes, and the ceilings declared on the unit. Upgrade and remove covers a newer binary in place, taking the service off a host, and taking the host off altogether, which also gives up its address.