Skip to main content
Usage Statistics
MonitoringSourceAPIChangelog

Reference

Settings​

Admin​

Set by an admin in Settings, under the plugin's name. It applies to everyone.

SettingTypeDefaultWhat it does
Share anonymous usage statisticsbooleantrueSends a small anonymous summary once a day to help improve Termix. It never includes usernames, hostnames or credentials.
Include platform infobooleantrueThe operating system, CPU architecture, Node.js version, database type and how Termix is installed (Docker, desktop app or server).
Include feature usagebooleantrueHow many times each kind of tab was opened and how many SSH logins happened since the last report. Users can turn off their own part in their profile.
Include installed featuresbooleantrueWhich plugins are turned on and their versions. Used to count how many instances use each plugin.

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Include my feature usagebooleantrueCounts which kinds of tabs you open in the anonymous usage statistics. Nothing about you or your hosts is sent.

Environment variables​

Set these on the Termix server, for example under environment: in your compose file. See environment variables for the ones core and other plugins read.

VariableDefaultWhat it does
ENABLE_TELEMETRYtrue or false. Turns usage statistics on or off and locks the setting.
POSTHOG_API_KEYSend reports to your own PostHog project instead of the Termix one.
POSTHOG_HOSThttps://us.i.posthog.comPostHog server to send to.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
telemetry.manageadminSee what usage statistics are sent, send them now and reset the instance ID.

Capabilities​

What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.

CapabilityRiskWhat it means
db:core-refsHighRead core account tables. Can query users, roles and hosts directly from the database.
network:outboundMediumReach the internet. It can send requests to outside services.
network:serveMediumAccept connections. It opens a port on the Termix server.
events:coreMediumWatch everything happening. Including activity from other users, not just yours.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
kv:ownLowRemember small settings. Kept separate from other plugins.
plugins:readLowSee installed plugins. It can see which plugins are installed and running.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

API​

The plugin's HTTP routes are in the API reference.

Platforms​

Linux, Windows, macOS