Termix/plugins/ssh-terminal/manifest.json

{
  "id": "ssh-terminal",
  "name": "SSH Terminal",
  "version": "1.0.0",
  "description": "SSH terminal sessions with jump hosts, host key checks, command history and a local terminal in the desktop app.",
  "author": {
    "name": "Termix"
  },
  "license": "MIT",
  "repository": "https://github.com/Termix-SSH/Termix",
  "category": "Terminal",
  "icon": "SquareTerminal",
  "engine": {
    "termix": ">=2.9.0",
    "api": "1"
  },
  "capabilities": [
    "hosts:read",
    "credentials:use",
    "credentials:read",
    "ssh:connect",
    "network:serve",
    "db:own",
    "events:core",
    "ui:surface"
  ],
  "provides": [
    {
      "service": "sessions.live",
      "version": "1.0.0",
      "permission": "ssh-terminal.sessions",
      "names": ["ssh"]
    },
    {
      "service": "terminal.history",
      "version": "1.0.0",
      "permission": "ssh-terminal.history"
    }
  ],
  "requires": [
    {
      "service": "tmux.sessions",
      "versionRange": "^1.0.0",
      "optional": true
    },
    {
      "service": "sessions.sharing",
      "versionRange": "^1.0.0",
      "optional": true
    },
    {
      "service": "recordings.writer",
      "versionRange": "^1.0.0",
      "optional": true
    }
  ],
  "contributes": {
    "tabs": [
      {
        "id": "terminal",
        "titleKey": "nav.terminal",
        "icon": "SquareTerminal",
        "openFrom": ["host-context-menu", "palette"]
      },
      {
        "id": "local-terminal",
        "titleKey": "nav.localTerminal",
        "icon": "Laptop",
        "openFrom": ["rail", "palette"]
      }
    ],
    "panels": [
      {
        "id": "history",
        "titleKey": "nav.history",
        "icon": "History"
      }
    ],
    "actionSlots": [
      {
        "id": "terminal.toolbar",
        "accepts": ["button"]
      },
      {
        "id": "terminal.toolbarStatus",
        "accepts": ["component"]
      },
      {
        "id": "terminal.sidePanel",
        "accepts": ["component"]
      },
      {
        "id": "terminal.overlay",
        "accepts": ["component"]
      }
    ],
    "permissions": [
      {
        "name": "sessions",
        "titleKey": "permissions.sessions.title",
        "descriptionKey": "permissions.sessions.description",
        "defaultRoles": ["admin", "user"]
      },
      {
        "name": "history",
        "titleKey": "permissions.history.title",
        "descriptionKey": "permissions.history.description",
        "defaultRoles": ["admin", "user"]
      }
    ],
    "settings": {
      "admin": [
        {
          "key": "sessionTimeoutMinutes",
          "type": "number",
          "labelKey": "settings.admin.sessionTimeoutMinutes.label",
          "descriptionKey": "settings.admin.sessionTimeoutMinutes.description",
          "group": "settings.admin.group.sessions",
          "min": 1,
          "max": 1440,
          "default": 30
        },
        {
          "key": "sessionPersistence",
          "type": "boolean",
          "labelKey": "settings.admin.sessionPersistence.label",
          "descriptionKey": "settings.admin.sessionPersistence.description",
          "group": "settings.admin.group.sessions",
          "default": true
        },
        {
          "key": "commandHistoryEnabled",
          "type": "boolean",
          "labelKey": "settings.admin.commandHistoryEnabled.label",
          "descriptionKey": "settings.admin.commandHistoryEnabled.description",
          "group": "settings.admin.group.sessions",
          "default": true
        },
        {
          "key": "commandHistoryForNewHosts",
          "type": "boolean",
          "labelKey": "settings.admin.commandHistoryForNewHosts.label",
          "descriptionKey": "settings.admin.commandHistoryForNewHosts.description",
          "default": true
        },
        {
          "key": "touchInput",
          "type": "custom",
          "component": "touchInput",
          "group": "settings.admin.group.touch"
        },
        {
          "key": "imageStorageMode",
          "type": "select",
          "labelKey": "settings.admin.imageStorageMode.label",
          "descriptionKey": "settings.admin.imageStorageMode.description",
          "group": "settings.admin.group.images",
          "options": [
            {
              "value": "auto",
              "labelKey": "settings.admin.imageStorageMode.auto"
            },
            {
              "value": "local",
              "labelKey": "settings.admin.imageStorageMode.local"
            },
            {
              "value": "remote-sftp",
              "labelKey": "settings.admin.imageStorageMode.remoteSftp"
            }
          ]
        },
        {
          "key": "imageLocalDir",
          "type": "secret",
          "labelKey": "settings.admin.imageLocalDir.label",
          "descriptionKey": "settings.admin.imageLocalDir.description",
          "group": "settings.admin.group.images"
        },
        {
          "key": "imageHostPath",
          "type": "string",
          "labelKey": "settings.admin.imageHostPath.label",
          "descriptionKey": "settings.admin.imageHostPath.description",
          "group": "settings.admin.group.images"
        },
        {
          "key": "imageTtlMs",
          "type": "number",
          "labelKey": "settings.admin.imageTtlMs.label",
          "descriptionKey": "settings.admin.imageTtlMs.description",
          "group": "settings.admin.group.images",
          "min": 0
        },
        {
          "key": "imageMaxCount",
          "type": "number",
          "labelKey": "settings.admin.imageMaxCount.label",
          "descriptionKey": "settings.admin.imageMaxCount.description",
          "group": "settings.admin.group.images",
          "min": 1
        },
        {
          "key": "imageMaxBytes",
          "type": "number",
          "labelKey": "settings.admin.imageMaxBytes.label",
          "descriptionKey": "settings.admin.imageMaxBytes.description",
          "group": "settings.admin.group.images",
          "min": 1048576
        },
        {
          "key": "imageStorageTest",
          "type": "custom",
          "component": "imageStorageTest",
          "group": "settings.admin.group.images"
        }
      ],
      "host": {
        "editorGroup": "ssh",
        "editorOrder": 12,
        "enableKey": "enableTerminal",
        "enableLabelKey": "settings.host.enableTerminal.label",
        "enableDescriptionKey": "settings.host.enableTerminal.description",
        "enableDefault": true,
        "fields": [
          {
            "key": "enableTerminalToolbar",
            "type": "boolean",
            "labelKey": "settings.host.enableTerminalToolbar.label",
            "descriptionKey": "settings.host.enableTerminalToolbar.description",
            "default": true
          },
          {
            "key": "terminalToolbarPosition",
            "type": "select",
            "labelKey": "settings.host.terminalToolbarPosition.label",
            "descriptionKey": "settings.host.terminalToolbarPosition.description",
            "requires": "enableTerminalToolbar",
            "default": "bottom",
            "options": [
              {
                "value": "bottom",
                "labelKey": "settings.host.terminalToolbarPosition.bottom"
              },
              {
                "value": "bottom-left",
                "labelKey": "settings.host.terminalToolbarPosition.bottomLeft"
              },
              {
                "value": "bottom-right",
                "labelKey": "settings.host.terminalToolbarPosition.bottomRight"
              },
              {
                "value": "top",
                "labelKey": "settings.host.terminalToolbarPosition.top"
              },
              {
                "value": "top-left",
                "labelKey": "settings.host.terminalToolbarPosition.topLeft"
              },
              {
                "value": "top-right",
                "labelKey": "settings.host.terminalToolbarPosition.topRight"
              }
            ]
          },
          {
            "key": "terminalToolbarStartState",
            "type": "select",
            "labelKey": "settings.host.terminalToolbarStartState.label",
            "descriptionKey": "settings.host.terminalToolbarStartState.description",
            "requires": "enableTerminalToolbar",
            "default": "expanded",
            "options": [
              {
                "value": "expanded",
                "labelKey": "settings.host.terminalToolbarStartState.expanded"
              },
              {
                "value": "collapsed",
                "labelKey": "settings.host.terminalToolbarStartState.collapsed"
              }
            ]
          },
          {
            "key": "terminalToolbarDisplay",
            "type": "select",
            "labelKey": "settings.host.terminalToolbarDisplay.label",
            "descriptionKey": "settings.host.terminalToolbarDisplay.description",
            "requires": "enableTerminalToolbar",
            "default": "remember",
            "options": [
              {
                "value": "remember",
                "labelKey": "settings.host.terminalToolbarDisplay.remember"
              },
              {
                "value": "icon",
                "labelKey": "settings.host.terminalToolbarDisplay.icon"
              },
              {
                "value": "labeled",
                "labelKey": "settings.host.terminalToolbarDisplay.labeled"
              },
              {
                "value": "expanded",
                "labelKey": "settings.host.terminalToolbarDisplay.expanded"
              }
            ]
          },
          {
            "key": "terminalToolbarShowStatus",
            "type": "boolean",
            "labelKey": "settings.host.terminalToolbarShowStatus.label",
            "descriptionKey": "settings.host.terminalToolbarShowStatus.description",
            "requires": "enableTerminalToolbar",
            "default": true
          },
          {
            "key": "terminalToolbarFade",
            "type": "boolean",
            "labelKey": "settings.host.terminalToolbarFade.label",
            "descriptionKey": "settings.host.terminalToolbarFade.description",
            "requires": "enableTerminalToolbar",
            "default": true
          },
          {
            "key": "enableCommandHistory",
            "type": "boolean",
            "labelKey": "settings.host.enableCommandHistory.label",
            "descriptionKey": "settings.host.enableCommandHistory.description",
            "default": true,
            "defaultFrom": "commandHistoryForNewHosts"
          }
        ]
      }
    }
  },
  "locales": "locales",
  "platforms": ["linux", "win32", "darwin"]
}