Skip to main content
Tmux Monitor
TerminalSourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the tmux panel with a terminalbooleanfalseShow the tmux panel when a terminal opens on a host that has it.
Tmux panel sideselect"right"Where the panel sits next to the terminal.
Tmux panel sizenumber300Width, or height at the bottom, in pixels.
Tmux 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
Enable Tmux MonitorbooleanfalseWatch and attach to tmux sessions running on this host.
Enable tmux mouse supportbooleantrueOn (default): tmux handles the mouse (pane clicking, tmux copy mode), a mouse selection stays highlighted and copied until you click, and on Linux and macOS hosts the selection keys are rebound for the whole tmux server until it restarts. Off: select and copy text normally and the wheel scrolls tmux history. Applies the next time you attach.
Panel beside the terminalbooleantrueOffer a tmux panel next to this host's SSH terminal.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
tmux-monitor.useadmin, userBrowse and control tmux sessions, windows and panes on hosts with the monitor enabled.

Actions​

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

ActionRuns onRiskInputs
tmux-monitor.list-sessions
List tmux sessions
A hostRead only
tmux-monitor.session-count
Count tmux sessions
A hostRead only
tmux-monitor.kill-session
End tmux session
One item on a hostDestructive

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
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
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.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

Services​

Services are how plugins call each other. Plugin authors can use these.

ProvidesVersionPermission
tmux.sessions1.0.0tmux-monitor.use

API​

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

Platforms​

Linux, Windows, macOS