Skip to main content
Samba Shares
NetworkingSourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Open the shares panel with new terminalsbooleanfalseShow the shares panel beside every SSH terminal that has Samba on. You can still open and close it from the button on the right edge.
Shares panel sideselect"right"Where the shares panel sits next to a terminal.
Shares panel sizenumber380Width in pixels, or height when it is at the bottom. You can also drag its edge.
Show the panel buttonbooleantrueShow a small button on the right edge of a terminal that opens the shares 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
Samba sharesbooleanfalseShow the Samba Shares tab for this host in its menu.
Show shares panel in terminalsbooleantrueLet the shares panel open beside this host's SSH terminal.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
samba.useadmin, userManage Samba shares, users and permissions on hosts you can edit.

Actions​

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

ActionRuns onRiskInputs
samba.list-shares
List Samba shares
A hostRead only
samba.status
Samba
A hostRead only
samba.start
Start Samba
A hostChanges
samba.stop
Stop Samba
A hostDestructive
samba.restart
Restart Samba
A hostChanges
samba.reload
Reload Samba
A hostChanges

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.
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