Skip to main content
Notes
ProductivitySourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the notes panel with a terminalbooleanfalseShow the notes panel when a terminal opens on a host that has it.
Notes panel sideselect"right"Where the panel sits next to the terminal.
Notes panel sizenumber420Width, or height at the bottom, in pixels.
Notes panel edge buttonbooleantrueShow a small button on the terminal edge to open the panel.

Host​

Set per host in the host editor, on the plugin's tab. Host defaults can set them for many hosts at once.

SettingTypeDefaultWhat it does
NotesbooleantrueShow Notes for this host in its menu.
Panel beside the terminalbooleantrueOffer a notes panel next to this host's SSH terminal.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
notes.useadmin, userRead and write notes on hosts you can access and keep your own global notes.

Actions​

Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.

ActionRuns onRiskInputs
notes.list
List notes
A hostRead only
notes.get
Read a note
A hostRead onlynote
notes.create
Create a note
A hostChangestitle, body
notes.append
Add to a note
A hostChangesnote, text

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
events:coreMediumWatch everything happening. Including activity from other users, not just yours.
network:serveMediumAccept connections. It opens a port on the Termix server.
operations:provideMediumOffer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
hosts:readLowSee your host list. Names and addresses for hosts you can already see.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.

API​

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

Platforms​

Linux, Windows, macOS