Skip to main content
The analytics role runs Plausible Community Edition for the fleet as one Docker Process named plausible. The analytics family changes the version that Process runs and stores the Stats API key the Gateway uses to read visits. node:role:add assigns the role and node:role:remove removes it. The Analytics role reference owns the storage Processes, the private dashboard, and what removal keeps. Instance analytics stats owns the read that uses the stored key.

​
Commands

Every command accepts --json. The caller must be the Gateway Node or hold an access grant to it.

​
orbit analytics:update

Pin another Plausible Community Edition version for the analytics role.
In a terminal the command asks for the version you left out. With --json or --no-interaction it refuses a missing version. The Gateway stores the version and converges the role again, which replaces the plausible Process. Plausible keeps no data in its container, and it migrates its PostgreSQL database each time it starts, so the replaced Process continues with the same data. When the new version does not converge, the Gateway stores the earlier version again and returns the error. It does not converge the earlier version again, so the plausible Process can stay failed. Converge the role again with orbit node:role:add NODE analytics --converge --postgres-process=ID --clickhouse-process=ID to restore it. Naming the version that already runs changes nothing. Human output names the Node, the version, and the previous version. JSON returns node_id, node_name, version, previous_version, and the request ID.

​
orbit analytics:credentials

Show whether the Gateway has a Plausible Stats API key, store one, or clear it.
The command never prints the key. Human output says whether a key is stored and names the driver plausible_ce. JSON returns configured, driver, and the request ID. Create the key in Plausible at https://analytics.orbit, then store it here. The Gateway sends it only to the fleet Plausible Stats API. --set and --unset together are refused. The Gateway stores the key even while no analytics role is assigned. The next stats read uses it.
  • node assigns and removes the analytics role.
  • process reads the logs of the plausible Process and restarts it.
  • instance:analytics publishes a tracking host.