Reference
Settings
User
Each person sets these for themselves in Settings.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Simultaneous File Transfers | number | 4 | How many files the side by side local/remote manager uploads or downloads at the same time. Lower this if your server limits SFTP channels. |
| Confirm before moving files to trash | boolean | true | Ask before moving remote files to trash. Permanent deletion still requires confirmation. |
| Open these file types outside Termix | string | Desktop app only. File endings, like psd, jpg, pdf, that open in your external editor, or the system app when none is chosen, when you open them. Separate them with commas, or use * for every file. | |
| Open the files panel with new terminals | boolean | false | Show the files panel beside every SSH terminal when it opens. You can still open and close it from the button on the right edge. |
| Files panel side | select | "right" | Where the files panel sits next to a terminal. |
| Files panel size | number | 380 | Width in pixels, or height when it is at the bottom. You can also drag its edge. |
| Show the panel button | boolean | true | Show a small button on the right edge of a terminal that opens the files panel. |
| Follow the terminal folder | boolean | true | Move the files panel to the folder your terminal is in. You can switch this off in the panel. |
| Folder check interval | number | 3 | How often, in seconds, the files panel checks which folder the terminal is in. |
| Folder history size | number | 20 | How many folders the files panel remembers for each host. |
Host
Set per host in the host editor, on the plugin's tab. Host defaults can set them for many hosts at once.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Enable File Manager | boolean | true | Browse and edit files on this host over SFTP. |
| Default Path | string | ||
| SCP Legacy Mode | boolean | ||
| Show files panel in terminals | boolean | true | Let the files panel open beside this host's SSH terminal. |
Permissions
Give these to roles in Settings, Roles.
| Permission | Who has it at first | What it allows |
|---|---|---|
file-manager.use | admin, user | Browse, edit and transfer files over SFTP. |
Actions
Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.
| Action | Runs on | Risk | Inputs |
|---|---|---|---|
file-manager.list-filesList files | A host | Read only | path |
file-manager.path-infoFile info | A host | Read only | path |
file-manager.make-folderMake folder | A host | Changes | path |
file-manager.delete-pathDelete file or empty folder | A host | Destructive | path |
Capabilities
What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.
| Capability | Risk | What it means |
|---|---|---|
credentials:read | Critical | See your passwords and keys. It can read the stored secret for any host you can reach. |
ssh:connect | High | Run commands on your servers. Any command, on hosts you connect it to, with your access. |
users:impersonate | High | Act as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log. |
desktop:local | High | Use this computer. Can read and change files, run a shell and open local ports on this computer. Only in the Termix desktop app. |
network:sockets | High | Open its own network connections. It can listen on ports and connect to any address directly, without Termix checking each connection. |
credentials:use | Medium | Connect to your servers. It cannot see your passwords or keys. |
network:serve | Medium | Accept connections. It opens a port on the Termix server. |
events:core | Medium | Watch everything happening. Including activity from other users, not just yours. |
operations:provide | Medium | Offer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them. |
hosts:read | Low | See your host list. Names and addresses for hosts you can already see. |
db:own | Low | Store its own data. Kept in its own tables, separate from other plugins. |
ui:surface | Low | Add its own screens. Tabs, panels and settings you can hide later. |
kv:own | Low | Remember small settings. Kept separate from other plugins. |
files:own | Low | Store its own files. In its own folder on disk, separate from other plugins. |
Services
Services are how plugins call each other. Plugin authors can use these.
| Provides | Version | Permission |
|---|---|---|
files.sftp | 1.0.0 | file-manager.use |
API
The plugin's HTTP routes are in the API reference.
Platforms
Linux, Windows, macOS