feat: collapse plugin runtime to one tier behind a plugin SDK

This commit is contained in:
LukeGus committed 2026-09-22 14:11:50 -05:00
1 parent 6e058f6e9e
commit 4758016f41
96 files changed
+34631 -8551

No files matched your search

+43 -28
View File
@@ -3,19 +3,38 @@
"name": "AI Assistant",
"version": "1.0.0",
"description": "An AI assistant that can read your hosts, snippets, fleets, alerts and automations, and propose changes for you to approve.",
"author": { "name": "Termix" },
"author": {
"name": "Termix"
},
"license": "MIT",
"repository": "https://github.com/Termix-SSH/Termix",
"category": "Productivity",
"icon": "Sparkles",
"engine": { "termix": ">=2.9.0", "api": "1" },
"capabilities": {
"backend": true,
"frontend": true,
"electron": true,
"platforms": ["linux", "win32", "darwin"]
"engine": {
"termix": ">=2.9.0",
"api": "1"
},
"permissions": ["process:transport-owner"],
"capabilities": [
"hosts:read",
"hosts:write",
"credentials:use",
"ssh:connect",
"db:own",
"secrets:own",
"network:outbound",
"audit:read",
"ui:surface"
],
"dependencies": {
"automations": "^1.0.0"
},
"providesSecret": [
{
"key": "api-key",
"permission": "ai.secrets.share",
"descriptionKey": "ai.secrets.shareApiKey"
}
],
"contributes": {
"tabs": [
{
@@ -25,6 +44,17 @@
"openFrom": ["rail", "palette"]
}
],
"actions": [
{
"id": "ai.openWithContext",
"titleKey": "ai.assistant",
"handler": "openWithContext",
"icon": "Bot",
"permission": "ai.services.use",
"slot": "terminal.toolbar",
"kind": "button"
}
],
"permissionGroup": {
"group": "ai",
"permissions": [
@@ -37,25 +67,10 @@
"defaultForRole": {
"admin": ["ai.services.use"]
}
},
"actions": [
{
"id": "ai.openWithContext",
"titleKey": "ai.assistant",
"handler": "openWithContext",
"icon": "Bot",
"permission": "ai.services.use",
"slot": "terminal.toolbar",
"kind": "button"
}
]
},
"providesSecret": [
{
"key": "api-key",
"permission": "ai.secrets.share",
"descriptionKey": "ai.secrets.shareApiKey"
}
],
"sidecars": []
},
"backend": "backend/index.mjs",
"frontend": "frontend/index.mjs",
"locales": "locales",
"platforms": ["linux", "win32", "darwin"]
}
+21 -9
View File
@@ -3,18 +3,30 @@
"name": "Automations",
"version": "1.0.0",
"description": "Trigger-and-action automation engine: schedules, metric/status/docker-event triggers, and multi-step actions across managed hosts.",
"author": { "name": "Termix" },
"author": {
"name": "Termix"
},
"license": "MIT",
"repository": "https://github.com/Termix-SSH/Termix",
"category": "Infrastructure",
"icon": "Workflow",
"engine": { "termix": ">=2.9.0", "api": "1" },
"capabilities": {
"backend": true,
"frontend": true,
"electron": true,
"platforms": ["linux", "win32", "darwin"]
"engine": {
"termix": ">=2.9.0",
"api": "1"
},
"permissions": ["process:transport-owner"],
"sidecars": []
"capabilities": [
"hosts:read",
"hosts:write",
"credentials:use",
"ssh:connect",
"db:own",
"events:core",
"notify:send",
"network:outbound",
"ui:surface"
],
"backend": "backend/index.mjs",
"frontend": "frontend/index.mjs",
"locales": "locales",
"platforms": ["linux", "win32", "darwin"]
}
+68 -19
View File
@@ -45,17 +45,57 @@ interface SSHSession {
const activeSessions = new Map<string, SSHSession>();
const wss = new WebSocketServer({
host: "127.0.0.1",
port: 30009,
maxPayload: MAX_WS_MESSAGE_BYTES,
});
const CONSOLE_PORT = 30009;
wss.on("error", (error) => {
sshLogger.error("Docker console WebSocket server error", error, {
operation: "wss_error",
/**
* Created by startConsoleServer(), not at module load.
*
* Importing this file used to bind the port as a side effect, which meant the
* plugin could not be disabled and re-enabled: the module stays in the ESM
* cache, so the second activate() got a server that had already been closed.
*/
let wss: WebSocketServer | null = null;
function handleConnection(ws: WebSocket, req: import("http").IncomingMessage) {
void onConsoleConnection(ws, req);
}
/** Starts the console WebSocket server. Call from the plugin's activate(). */
export function startConsoleServer(): Promise<void> {
if (wss) return Promise.resolve();
return new Promise((resolve, reject) => {
const server = new WebSocketServer({
host: "127.0.0.1",
port: CONSOLE_PORT,
maxPayload: MAX_WS_MESSAGE_BYTES,
});
const onStartupError = (error: Error) => {
server.off("listening", onListening);
wss = null;
reject(error);
};
const onListening = () => {
server.off("error", onStartupError);
// Past startup an error is logged rather than fatal: one bad socket
// must not take the server down.
server.on("error", (error) => {
sshLogger.error("Docker console WebSocket server error", error, {
operation: "wss_error",
});
});
resolve();
};
server.once("error", onStartupError);
server.once("listening", onListening);
server.on("connection", handleConnection);
wss = server;
});
});
}
async function detectShell(
session: SSHSession,
@@ -296,7 +336,10 @@ async function createJumpHostChain(
return currentClient;
}
wss.on("connection", async (ws: WebSocket, req) => {
async function onConsoleConnection(
ws: WebSocket,
req: import("http").IncomingMessage,
) {
const token = extractWebSocketToken(req);
if (!token) {
@@ -824,12 +867,17 @@ wss.on("connection", async (ws: WebSocket, req) => {
cleanup();
});
});
}
/**
* Closes every live console session and the WebSocket server. Called by the
* plugin's deactivate() as well as SIGTERM, since disabling the docker
* plugin has to free port 30009 the same way process shutdown does.
* Closes every live console session and the WebSocket server, freeing port
* 30009. Called from the plugin's deactivate().
*
* There is deliberately no process signal handler here. Core owns shutdown:
* gracefulShutdown in src/backend/starter.ts calls shutdownPlugins(), which
* runs every plugin's deactivate. A plugin calling process.exit() itself
* skipped the rest of that sequence, including other plugins and the
* database flush.
*/
export function closeConsoleServer(): Promise<void> {
activeSessions.forEach((session) => {
@@ -841,9 +889,10 @@ export function closeConsoleServer(): Promise<void> {
activeSessions.clear();
return new Promise((resolve) => wss.close(() => resolve()));
}
const server = wss;
wss = null;
if (!server) return Promise.resolve();
process.on("SIGTERM", () => {
void closeConsoleServer().then(() => process.exit(0));
});
server.off("connection", handleConnection);
return new Promise((resolve) => server.close(() => resolve()));
}
+4 -3
View File
@@ -118,10 +118,11 @@ export async function activate(ctx) {
});
}
// Importing console.js binds its WebSocket server on port 30009 as a
// module-scope side effect -- unchanged from before the move, see that
// file's own header.
// Importing console.js no longer binds anything: the server is started
// here so disabling the plugin frees port 30009 and re-enabling can take
// it again, even though the module stays in the ESM cache.
consoleModule = await loadRelative("console");
await consoleModule.startConsoleServer();
ctx.log.info(`Docker plugin listening on ${port} (console on 30009)`);
}
+18 -9
View File
@@ -3,19 +3,25 @@
"name": "Docker",
"version": "1.0.0",
"description": "Container management over SSH: list, inspect, start, stop and view logs for Docker or Podman containers, plus an interactive container console.",
"author": { "name": "Termix" },
"author": {
"name": "Termix"
},
"license": "MIT",
"repository": "https://github.com/Termix-SSH/Termix",
"category": "Infrastructure",
"icon": "Box",
"engine": { "termix": ">=2.9.0", "api": "1" },
"capabilities": {
"backend": true,
"frontend": true,
"electron": true,
"platforms": ["linux", "win32", "darwin"]
"engine": {
"termix": ">=2.9.0",
"api": "1"
},
"permissions": ["process:transport-owner"],
"capabilities": [
"hosts:read",
"credentials:use",
"ssh:connect",
"network:serve",
"audit:read",
"ui:surface"
],
"contributes": {
"tabs": [
{
@@ -31,5 +37,8 @@
"editorTab": "docker"
}
},
"sidecars": []
"backend": "backend/index.mjs",
"frontend": "frontend/index.mjs",
"locales": "locales",
"platforms": ["linux", "win32", "darwin"]
}
+17 -9
View File
@@ -3,18 +3,26 @@
"name": "Fleets",
"version": "1.0.0",
"description": "Group hosts into fleets by static membership or tag rules, and run commands, package actions, and file transfers across every member at once.",
"author": { "name": "Termix" },
"author": {
"name": "Termix"
},
"license": "MIT",
"repository": "https://github.com/Termix-SSH/Termix",
"category": "Infrastructure",
"icon": "Boxes",
"engine": { "termix": ">=2.9.0", "api": "1" },
"capabilities": {
"backend": true,
"frontend": true,
"electron": true,
"platforms": ["linux", "win32", "darwin"]
"engine": {
"termix": ">=2.9.0",
"api": "1"
},
"permissions": ["process:transport-owner"],
"sidecars": []
"capabilities": [
"hosts:read",
"credentials:use",
"ssh:connect",
"db:own",
"ui:surface"
],
"backend": "backend/index.mjs",
"frontend": "frontend/index.mjs",
"locales": "locales",
"platforms": ["linux", "win32", "darwin"]
}
+19 -9
View File
@@ -3,19 +3,26 @@
"name": "Host Metrics",
"version": "1.0.0",
"description": "Live CPU, memory, disk, network and process metrics, plus host management (services, packages, firewall, cron, users, SSL, logs, WireGuard, Tailscale).",
"author": { "name": "Termix" },
"author": {
"name": "Termix"
},
"license": "MIT",
"repository": "https://github.com/Termix-SSH/Termix",
"category": "Monitoring",
"icon": "Activity",
"engine": { "termix": ">=2.9.0", "api": "1" },
"capabilities": {
"backend": true,
"frontend": true,
"electron": true,
"platforms": ["linux", "win32", "darwin"]
"engine": {
"termix": ">=2.9.0",
"api": "1"
},
"permissions": ["process:transport-owner"],
"capabilities": [
"hosts:read",
"credentials:use",
"ssh:connect",
"db:own",
"network:serve",
"events:core",
"ui:surface"
],
"contributes": {
"tabs": [
{
@@ -26,5 +33,8 @@
}
]
},
"sidecars": []
"backend": "backend/index.mjs",
"frontend": "frontend/index.mjs",
"locales": "locales",
"platforms": ["linux", "win32", "darwin"]
}
+11 -12
View File
@@ -3,19 +3,18 @@
"name": "Network Topology",
"version": "1.0.0",
"description": "Visualize hosts and their connections as an interactive graph, saved per user.",
"author": { "name": "Termix" },
"author": {
"name": "Termix"
},
"license": "MIT",
"repository": "https://github.com/Termix-SSH/Termix",
"category": "Infrastructure",
"icon": "Network",
"engine": { "termix": ">=2.9.0", "api": "1" },
"capabilities": {
"backend": true,
"frontend": true,
"electron": true,
"platforms": ["linux", "win32", "darwin"]
"engine": {
"termix": ">=2.9.0",
"api": "1"
},
"permissions": ["process:transport-owner"],
"capabilities": ["db:own", "ui:surface"],
"contributes": {
"tabs": [
{
@@ -24,10 +23,10 @@
"icon": "Network",
"openFrom": ["rail", "palette"]
}
],
"dashboardCards": [
{ "id": "network_graph", "titleKey": "dashboard.networkGraph" }
]
},
"sidecars": []
"backend": "backend/index.mjs",
"frontend": "frontend/index.mjs",
"locales": "locales",
"platforms": ["linux", "win32", "darwin"]
}
+18 -9
View File
@@ -3,19 +3,25 @@
"name": "Proxmox",
"version": "1.0.0",
"description": "Discover Proxmox VE guests over an existing SSH host, import them as Termix hosts, and keep them in sync.",
"author": { "name": "Termix" },
"author": {
"name": "Termix"
},
"license": "MIT",
"repository": "https://github.com/Termix-SSH/Termix",
"category": "Infrastructure",
"icon": "Server",
"engine": { "termix": ">=2.9.0", "api": "1" },
"capabilities": {
"backend": true,
"frontend": true,
"electron": true,
"platforms": ["linux", "win32", "darwin"]
"engine": {
"termix": ">=2.9.0",
"api": "1"
},
"permissions": ["process:transport-owner"],
"capabilities": [
"hosts:read",
"hosts:write",
"credentials:use",
"ssh:connect",
"db:own",
"ui:surface"
],
"contributes": {
"hostCapability": {
"key": "enableProxmox",
@@ -23,5 +29,8 @@
"editorTab": "proxmox"
}
},
"sidecars": []
"backend": "backend/index.mjs",
"frontend": "frontend/index.mjs",
"locales": "locales",
"platforms": ["linux", "win32", "darwin"]
}
+28 -11
View File
@@ -3,19 +3,25 @@
"name": "Remote Desktop",
"version": "1.0.0",
"description": "RDP, VNC and Telnet remote desktop sessions, with clipboard, drive redirection, session recording and session sharing.",
"author": { "name": "Termix" },
"author": {
"name": "Termix"
},
"license": "MIT",
"repository": "https://github.com/Termix-SSH/Plugin-RemoteDesktop",
"category": "Terminal",
"icon": "Monitor",
"engine": { "termix": ">=2.9.0", "api": "1" },
"capabilities": {
"backend": true,
"frontend": true,
"electron": true,
"platforms": ["linux", "win32", "darwin"]
"engine": {
"termix": ">=2.9.0",
"api": "1"
},
"permissions": ["process:transport-owner"],
"capabilities": [
"hosts:read",
"credentials:use",
"ssh:connect",
"network:serve",
"audit:read",
"ui:surface"
],
"contributes": {
"tabs": [
{
@@ -38,8 +44,16 @@
}
],
"hostCapability": [
{ "key": "enableRdp", "labelKey": "hosts.tabRdp", "editorTab": "rdp" },
{ "key": "enableVnc", "labelKey": "hosts.tabVnc", "editorTab": "vnc" },
{
"key": "enableRdp",
"labelKey": "hosts.tabRdp",
"editorTab": "rdp"
},
{
"key": "enableVnc",
"labelKey": "hosts.tabVnc",
"editorTab": "vnc"
},
{
"key": "enableTelnet",
"labelKey": "hosts.tabTelnet",
@@ -47,5 +61,8 @@
}
]
},
"sidecars": []
"backend": "backend/index.mjs",
"frontend": "frontend/index.mjs",
"locales": "locales",
"platforms": ["linux", "win32", "darwin"]
}
+17 -9
View File
@@ -3,19 +3,24 @@
"name": "SSH Terminal",
"version": "1.0.0",
"description": "Interactive SSH terminal sessions, with jump hosts, host key verification and session sharing.",
"author": { "name": "Termix" },
"author": {
"name": "Termix"
},
"license": "MIT",
"repository": "https://github.com/Termix-SSH/Termix",
"category": "Terminal",
"icon": "SquareTerminal",
"engine": { "termix": ">=2.9.0", "api": "1" },
"capabilities": {
"backend": true,
"frontend": true,
"electron": true,
"platforms": ["linux", "win32", "darwin"]
"engine": {
"termix": ">=2.9.0",
"api": "1"
},
"permissions": ["process:transport-owner"],
"capabilities": [
"hosts:read",
"credentials:use",
"ssh:connect",
"network:serve",
"ui:surface"
],
"contributes": {
"tabs": [
{
@@ -32,5 +37,8 @@
}
]
},
"sidecars": []
"backend": "backend/index.mjs",
"frontend": "frontend/index.mjs",
"locales": "locales",
"platforms": ["linux", "win32", "darwin"]
}
+73 -52
View File
@@ -5,6 +5,7 @@
import { Router } from "express";
import { AuthManager } from "../../../src/backend/utils/auth-manager.js";
import { PermissionManager } from "../../../src/backend/utils/permission-manager.js";
import { apiLogger } from "../../../src/backend/utils/logger.js";
import { fetchWithProxy } from "../../../src/backend/utils/proxy-agent.js";
import { createCurrentSettingsRepository } from "../../../src/backend/database/repositories/factory.js";
@@ -39,6 +40,16 @@ export const router = Router();
const authManager = AuthManager.getInstance();
const authenticateJWT = authManager.createAuthMiddleware();
/**
* Listing the tailnet uses the admin-stored API key, so it needs more than a
* session. Writing the key is already admin-only and reading it back is
* masked, but using it to enumerate every device was open to any logged-in
* user, which handed out an internal network inventory.
*/
const requireDeviceAccess = PermissionManager.getInstance().requirePermission(
"tailscale.devices.view",
);
function normalizeApiBase(raw: string | null): string {
const trimmed = (raw ?? "").trim().replace(/\/+$/, "");
return trimmed || DEFAULT_TAILSCALE_API_BASE;
@@ -49,12 +60,17 @@ function normalizeApiBase(raw: string | null): string {
* /tailscale/devices:
* get:
* summary: List Tailscale devices
* description: Returns the list of devices in the configured tailnet using the stored API key.
* description: >
* Returns the devices in the configured tailnet using the stored admin
* API key. Requires the tailscale.devices.view permission, because the
* response is a full inventory of the tailnet.
* tags:
* - Tailscale
* responses:
* 200:
* description: List of tailnet devices.
* 403:
* description: The caller lacks tailscale.devices.view.
* content:
* application/json:
* schema:
@@ -67,67 +83,72 @@ function normalizeApiBase(raw: string | null): string {
* 500:
* description: Failed to fetch Tailscale devices.
*/
router.get("/devices", authenticateJWT, async (_req, res) => {
try {
const settingsRepo = createCurrentSettingsRepository();
const apiKey = (await settingsRepo.get("tailscale_api_key")) ?? "";
if (!apiKey) {
return res.json({ devices: [], hasApiKey: false });
}
const apiBase = normalizeApiBase(
await settingsRepo.get("tailscale_api_base_url"),
);
router.get(
"/devices",
authenticateJWT,
requireDeviceAccess,
async (_req, res) => {
try {
const settingsRepo = createCurrentSettingsRepository();
const apiKey = (await settingsRepo.get("tailscale_api_key")) ?? "";
if (!apiKey) {
return res.json({ devices: [], hasApiKey: false });
}
const apiBase = normalizeApiBase(
await settingsRepo.get("tailscale_api_base_url"),
);
const url = `${apiBase}/tailnet/-/devices?fields=all`;
const response = await fetchWithProxy(url, {
headers: {
Authorization: `Bearer ${apiKey}`,
"User-Agent": "Termix/1.0",
},
});
if (!response.ok) {
apiLogger.warn("Tailscale API returned non-OK status", {
operation: "tailscale_devices",
status: response.status,
const url = `${apiBase}/tailnet/-/devices?fields=all`;
const response = await fetchWithProxy(url, {
headers: {
Authorization: `Bearer ${apiKey}`,
"User-Agent": "Termix/1.0",
},
});
if (response.status === 401 || response.status === 403) {
return res.status(401).json({
error: "Invalid Tailscale API key",
if (!response.ok) {
apiLogger.warn("Tailscale API returned non-OK status", {
operation: "tailscale_devices",
status: response.status,
});
if (response.status === 401 || response.status === 403) {
return res.status(401).json({
error: "Invalid Tailscale API key",
devices: [],
hasApiKey: true,
});
}
return res.status(502).json({
error: "Tailscale API error",
devices: [],
hasApiKey: true,
});
}
return res.status(502).json({
error: "Tailscale API error",
const data = (await response.json()) as { devices: TailscaleAPIDevice[] };
const devices: TailscaleDevice[] = (data.devices ?? []).map((d) => ({
id: d.id,
name: d.name,
hostname: d.hostname,
addresses: d.addresses ?? [],
os: d.os,
lastSeen: d.lastSeen,
}));
res.json({ devices, hasApiKey: true });
} catch (err) {
apiLogger.error("Failed to fetch Tailscale devices", err, {
operation: "tailscale_devices",
});
res.status(500).json({
error: "Failed to fetch Tailscale devices",
devices: [],
hasApiKey: true,
});
}
const data = (await response.json()) as { devices: TailscaleAPIDevice[] };
const devices: TailscaleDevice[] = (data.devices ?? []).map((d) => ({
id: d.id,
name: d.name,
hostname: d.hostname,
addresses: d.addresses ?? [],
os: d.os,
lastSeen: d.lastSeen,
}));
res.json({ devices, hasApiKey: true });
} catch (err) {
apiLogger.error("Failed to fetch Tailscale devices", err, {
operation: "tailscale_devices",
});
res.status(500).json({
error: "Failed to fetch Tailscale devices",
devices: [],
hasApiKey: true,
});
}
});
},
);
/** Called from activate(). Mounts this router at /tailscale via the shared
* dispatcher. */
+17 -9
View File
@@ -3,18 +3,26 @@
"name": "Tailscale",
"version": "1.0.0",
"description": "Browse and connect to tailnet devices, manage the Tailscale API key, and show the Tailscale SSH re-authentication dialog.",
"author": { "name": "Termix" },
"author": {
"name": "Termix"
},
"license": "MIT",
"repository": "https://github.com/Termix-SSH/Termix",
"category": "Networking",
"icon": "Network",
"engine": { "termix": ">=2.9.0", "api": "1" },
"capabilities": {
"backend": true,
"frontend": true,
"electron": true,
"platforms": ["linux", "win32", "darwin"]
"engine": {
"termix": ">=2.9.0",
"api": "1"
},
"permissions": ["process:transport-owner"],
"sidecars": []
"capabilities": ["settings:read-core", "network:outbound", "ui:surface"],
"contributes": {
"permissionGroup": {
"group": "tailscale",
"permissions": ["tailscale.devices.view"]
}
},
"backend": "backend/index.mjs",
"frontend": "frontend/index.mjs",
"locales": "locales",
"platforms": ["linux", "win32", "darwin"]
}
+16 -9
View File
@@ -3,19 +3,23 @@
"name": "Web Endpoint",
"version": "1.0.0",
"description": "Open a host's web UI in a tab or an isolated desktop window, directly or over an SSH tunnel.",
"author": { "name": "Termix" },
"author": {
"name": "Termix"
},
"license": "MIT",
"repository": "https://github.com/Termix-SSH/Plugin-WebEndpoint",
"category": "Networking",
"icon": "Globe",
"engine": { "termix": ">=2.9.0", "api": "1" },
"capabilities": {
"backend": true,
"frontend": true,
"electron": true,
"platforms": ["linux", "win32", "darwin"]
"engine": {
"termix": ">=2.9.0",
"api": "1"
},
"permissions": ["process:transport-owner"],
"capabilities": [
"hosts:read",
"credentials:use",
"ssh:connect",
"ui:surface"
],
"contributes": {
"tabs": [
{
@@ -31,5 +35,8 @@
"editorTab": "general"
}
},
"sidecars": []
"backend": "backend/index.mjs",
"frontend": "frontend/index.mjs",
"locales": "locales",
"platforms": ["linux", "win32", "darwin"]
}
+11 -9
View File
@@ -3,18 +3,20 @@
"name": "Workspaces",
"version": "1.0.0",
"description": "Save and restore named tab/split layouts per user.",
"author": { "name": "Termix" },
"author": {
"name": "Termix"
},
"license": "MIT",
"repository": "https://github.com/Termix-SSH/Termix",
"category": "Productivity",
"icon": "LayoutTemplate",
"engine": { "termix": ">=2.9.0", "api": "1" },
"capabilities": {
"backend": true,
"frontend": true,
"electron": true,
"platforms": ["linux", "win32", "darwin"]
"engine": {
"termix": ">=2.9.0",
"api": "1"
},
"permissions": ["process:transport-owner"],
"sidecars": []
"capabilities": ["db:own", "ui:surface"],
"backend": "backend/index.mjs",
"frontend": "frontend/index.mjs",
"locales": "locales",
"platforms": ["linux", "win32", "darwin"]
}