chore: rework plugin readmes, json changelogs and standalone repo setup

This commit is contained in:
LukeGus committed 2026-10-04 21:25:16 -05:00
1 parent a8f383d2b3
commit 29a946d02e
500 files changed
+6729 -1250

No files matched your search

+21
View File
@@ -0,0 +1,21 @@
{
"extends": ["@commitlint/config-conventional"],
"rules": {
"type-enum": [
2,
"always",
[
"feat",
"fix",
"docs",
"style",
"refactor",
"perf",
"test",
"chore",
"revert"
]
],
"subject-case": [0]
}
}
+1
View File
@@ -0,0 +1 @@
custom: https://donate.termix.site/
+34
View File
@@ -0,0 +1,34 @@
# Overview
_Short summary of what this PR does_
- [ ] Added: ...
- [ ] Updated: ...
- [ ] Removed: ...
- [ ] Fixed: ...
# Changes Made
_Detailed explanation of changes (if needed)_
- ...
# Related Issues
_Link any issues this PR addresses_
- Closes #ISSUE_NUMBER
- Related to #ISSUE_NUMBER
# Screenshots / Demos
_(Optional: add before/after screenshots, GIFs, or console output)_
# Checklist
- [ ] Code follows project style guidelines
- [ ] Supports mobile and desktop UI/app (if applicable)
- [ ] Added the change to `CHANGELOG.json`
- [ ] `npm run test`, `npm run typecheck` and `npm run validate` pass
- [ ] I have read `CONTRIBUTING.md`
- [ ] This is not a translation request. See [docs](https://docs.termix.site/translations)
+9
View File
@@ -0,0 +1,9 @@
node_modules
dist
coverage
*.log
.env
*.tmxplug
*.tmxplug.sig
termix-plugin-signing.key
.termix-tables-*
+1
View File
@@ -0,0 +1 @@
npx --no -- commitlint --edit "$1"
+1
View File
@@ -0,0 +1 @@
npx lint-staged
+4
View File
@@ -0,0 +1,4 @@
dist
coverage
node_modules
package-lock.json
+9
View File
@@ -0,0 +1,9 @@
{
"semi": true,
"singleQuote": false,
"tabWidth": 2,
"trailingComma": "all",
"printWidth": 80,
"arrowParens": "always",
"endOfLine": "lf"
}
+30
View File
@@ -0,0 +1,30 @@
{
"$schema": "https://raw.githubusercontent.com/Termix-SSH/Termix/main/packages/plugin-sdk/schema/changelog.schema.json",
"releases": [
{
"version": "1.0.0",
"changes": [
{
"type": "added",
"text": "Start, stop, restart, pause and remove containers"
},
{
"type": "added",
"text": "Live CPU, memory, network and disk stats"
},
{
"type": "added",
"text": "Read and download container logs"
},
{
"type": "added",
"text": "Open a shell inside a container"
},
{
"type": "added",
"text": "Works with Docker and Podman"
}
]
}
]
}
-7
View File
@@ -1,7 +0,0 @@
# Changelog
## 1.0.0
First release, bundled with Termix 2.9.0.
Manages Docker and Podman containers over SSH. List, inspect, start, stop and remove containers, read their logs and open a console inside them.
+22
View File
@@ -0,0 +1,22 @@
# Contributing to Docker
## Development
```bash
npm run build # build into dist/
npm run test # run this plugin's tests
npm run typecheck # type-check this plugin
npm run validate # check manifest.json
npm run format # format the code with Prettier
```
## Settings
### Host
- **Enable Docker:** show the Docker tab for this host
- **Container Runtime:** Docker or Podman
## Permissions
- `docker.use`: open the Docker manager and container consoles on hosts with Docker turned on. Admins and users have it by default.
+36 -25
View File
@@ -1,37 +1,48 @@
# Docker
<div align="center">
Manage Docker and Podman containers over SSH, with logs and a container console.
<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />
<h1>Docker</h1>
<p>Manage Docker and Podman containers on your hosts</p>
</div>
<br />
## Overview
Docker manages the containers running on your hosts over SSH. It is not meant to replace Portainer or Dockge, just to handle the containers you already have.
<br />
## 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.
- Start, stop, restart, pause and remove containers
- Live CPU, memory, network and disk stats
- Read and download container logs
- Open a shell inside a container
- Works with Docker and Podman
## 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.
<br />
## Services
Provides to other plugins:
- `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.
- `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
## Development
<br />
```bash
npm run build # build into dist/
npm run test # run this plugin's tests
npm run typecheck # type-check this plugin
```
## Support
To report a bug or request a feature, open a [support ticket](https://github.com/Termix-SSH/Support/issues/new/choose). You need to be logged in to GitHub. Please be as detailed as possible, preferably in English.
For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) server.
<br />
## License
Distributed under the Apache License Version 2.0. See [LICENSE](https://github.com/Termix-SSH/Termix/blob/main/LICENSE) for more information.
+3 -3
View File
@@ -2,16 +2,16 @@
"id": "docker",
"name": "Docker",
"version": "1.0.0",
"description": "Manage Docker and Podman containers over SSH, with logs and a container console.",
"description": "Manage Docker and Podman containers on your hosts over SSH, with logs, stats and a console.",
"author": {
"name": "Termix"
},
"license": "MIT",
"license": "Apache-2.0",
"repository": "https://github.com/Termix-SSH/Termix",
"category": "Infrastructure",
"icon": "Box",
"engine": {
"termix": ">=2.9.0",
"termix": ">=26.10.0",
"api": "1"
},
"capabilities": [
+14 -1
View File
@@ -7,7 +7,10 @@
"build": "termix-plugin build",
"test": "termix-plugin test",
"typecheck": "tsc -p .",
"validate": "termix-plugin validate"
"validate": "termix-plugin validate",
"format": "prettier --write .",
"format:check": "prettier --check .",
"prepare": "husky || true"
},
"dependencies": {
"@xterm/addon-clipboard": "^0.2.0",
@@ -18,13 +21,18 @@
"react-xtermjs": "^1.0.10"
},
"devDependencies": {
"@commitlint/cli": "^21.2.2",
"@commitlint/config-conventional": "^21.2.0",
"@termix/plugin-sdk": "^1.0.0",
"@testing-library/dom": "^10.4.2",
"@testing-library/react": "^16.3.3",
"@types/node": "^26.2.0",
"@types/react": "^19.2.18",
"@types/react-dom": "^19.2.4",
"husky": "^9.1.7",
"jsdom": "^30.0.1",
"lint-staged": "^17.2.0",
"prettier": "3.9.9",
"vitest": "^4.1.11"
},
"peerDependencies": {
@@ -44,5 +52,10 @@
"react-xtermjs": {
"@xterm/xterm": "$@xterm/xterm"
}
},
"lint-staged": {
"*.{ts,tsx,js,jsx,mjs,cjs,json,css,md}": [
"prettier --write"
]
}
}