chore: simplify plugin readmes, changelogs and manifest descriptions

This commit is contained in:
LukeGus committed 2026-09-27 00:24:48 -05:00
1 parent 7423e33184
commit 8043d6dbdd
96 files changed
+1147 -722

No files matched your search

+2 -17
View File
@@ -2,21 +2,6 @@
## 1.0.0
Bundled with Termix 2.9.0.
First release, bundled with Termix 2.9.0.
- Runs entirely through the plugin SDK: no imports from Termix core.
- Connects through Termix's one SSH pipeline, so TOTP, Warpgate, jump hosts
and proxies behave the same as in the terminal. A wrong TOTP code asks
again instead of ending the connect.
- Each host's Docker switch and container runtime are this plugin's host
settings now, moved over on upgrade. The host editor shows them in the
Plugins tab.
- The API lives at `/plugin-api/docker/` and the console at
`/plugin-ws/docker/console`. Disabling the plugin closes open consoles and
enabling it again works without a restart.
- New `docker.use` permission, given to the admin and user roles.
- Provides `docker.containers` (list containers, start, stop and the rest)
and `docker.events` (container state changes) for other plugins, which
Automations uses for its Docker step and trigger.
- The Docker homepage widget comes from this plugin.
- Downloaded logs are the plain log text.
Manages Docker and Podman containers over SSH. List, inspect, start, stop and remove containers, read their logs and open a console inside them.
+29 -24
View File
@@ -1,34 +1,39 @@
# Docker
Container management over SSH: list, inspect, start, stop and view logs for Docker or Podman containers, plus an interactive container console.
Manage Docker and Podman containers over SSH, with logs and a container console.
Bundled with Termix and enabled by default.
## Features
- List, inspect, start, stop, restart, pause and remove containers.
- Read and download container logs.
- Open an interactive console inside a container.
- Works with Docker or Podman.
- Adds a Docker widget to the homepage.
## Settings
### Host
- Enable Docker: show the Docker tab for this host.
- Container Runtime: Docker or Podman.
## Permissions
- `docker.use`: Use Docker. Admins and users have it by default.
## Services
- `docker.containers` 1.0.0: `listContainers(hostId, { all? })` and
`action(hostId, container, "start" | "stop" | "restart" | "pause" |
"unpause" | "remove")`, run over a pooled SSH connection as the caller.
- `docker.events` 1.0.0: `subscribe(hostId, listener)` calls the listener
with `{ hostId, container, event }` when a container exits, starts,
restarts or turns unhealthy, polled about once a minute as the caller.
Subscribing the same listener again is a no-op.
Provides to other plugins:
Both need `docker.use`.
- `docker.containers`: list containers and start, stop, restart, pause, unpause or remove them.
- `docker.events`: get notified when a container starts, exits, restarts or turns unhealthy.
## Layout
## Development
manifest.json id, capabilities and what this plugin contributes
src/backend/ activate(ctx) / deactivate(), plus the routes
src/frontend/ the UI it registers
locales/en.json its strings (English only; the rest are translated)
tests/backend/ vitest, node
tests/frontend/ vitest, jsdom
```bash
npm run build # build into dist/
npm run test # run this plugin's tests
npm run typecheck # type-check this plugin
```
## Commands
npm run build bundle into dist/
npm run test run this plugin's tests
npm run typecheck
See packages/plugin-sdk/ARCHITECTURE.md for the contract this follows.
See `packages/plugin-sdk/ARCHITECTURE.md` for the plugin contract.
+1 -1
View File
@@ -2,7 +2,7 @@
"id": "docker",
"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.",
"description": "Manage Docker and Podman containers over SSH, with logs and a container console.",
"author": {
"name": "Termix"
},