Skip to main content
Audit Tools
Access & SecuritySourceAPIChangelog

Reference

Settings​

Admin​

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

SettingTypeDefaultWhat it does
Collector URLstringEvery audit entry is posted here as one line of JSON. Leave empty to turn forwarding off.
Bearer tokensecretSent with each entry in the Authorization header. Optional.
Alert when forwarding failsbooleantrueSend an alert to admins when the collector stops accepting entries, and again when it works.

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
AUDIT_LOG_FORWARD_URLCollector URL audit entries are posted to. The URL set in the plugin's settings wins over this.
AUDIT_LOG_FORWARD_TOKENBearer token sent with the entries. Only used when the URL comes from this variable.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
audit-tools.exportadminDownload the audit log as CSV or NDJSON.

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
audit:readMediumRead the audit log. It can see who did what and when.
network:outboundMediumReach the internet. It can send requests to outside services.
network:serveMediumAccept connections. It opens a port on the Termix server.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
kv:ownLowRemember small settings. Kept separate from other plugins.
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