mirror of
https://github.com/Termix-SSH/Termix.git
synced 2026-10-28 06:05:24 +00:00
chore: simplify plugin readmes, changelogs and manifest descriptions
This commit is contained in:
1 parent
7423e33184
commit
8043d6dbdd
96 files changed
+1147
-722
No files matched your search
@@ -2,4 +2,6 @@
|
||||
|
||||
## 1.0.0
|
||||
|
||||
Bundled with Termix 2.9.0.
|
||||
First release, bundled with Termix 2.9.0.
|
||||
|
||||
Lets you browse devices on your tailnet and pick one when adding a host. Also shows the Tailscale SSH sign-in check when a host asks for it.
|
||||
+24
-14
@@ -1,22 +1,32 @@
|
||||
# Tailscale
|
||||
|
||||
Browse and connect to tailnet devices, manage the Tailscale API key, and show the Tailscale SSH re-authentication dialog.
|
||||
Browse and connect to devices on your tailnet, and handle Tailscale SSH sign-in checks.
|
||||
|
||||
Bundled with Termix and enabled by default.
|
||||
## Features
|
||||
|
||||
## Layout
|
||||
- Browse the devices on your Tailscale or Headscale tailnet.
|
||||
- Pick a device when adding a host to fill in its address.
|
||||
- Shows the Tailscale SSH sign-in check when a host asks for it.
|
||||
- Adds a Tailscale tool to Host Metrics.
|
||||
|
||||
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
|
||||
## Settings
|
||||
|
||||
## Commands
|
||||
### Admin
|
||||
|
||||
npm run build bundle into dist/
|
||||
npm run test run this plugin's tests
|
||||
npm run typecheck
|
||||
- API key: a Tailscale or Headscale API key for your tailnet.
|
||||
- API base URL: leave empty for Tailscale, or point it at a Headscale instance.
|
||||
- Device list: check that the key works and see how many devices are reachable.
|
||||
|
||||
See packages/plugin-sdk/ARCHITECTURE.md for the contract this follows.
|
||||
## Permissions
|
||||
|
||||
- `tailscale.devices.view`: See the devices on the tailnet. Only admins have it by default.
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
npm run build # build into dist/
|
||||
npm run test # run this plugin's tests
|
||||
npm run typecheck # type-check this plugin
|
||||
```
|
||||
|
||||
See `packages/plugin-sdk/ARCHITECTURE.md` for the plugin contract.
|
||||
@@ -2,7 +2,7 @@
|
||||
"id": "tailscale",
|
||||
"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.",
|
||||
"description": "Browse and connect to devices on your tailnet, and handle Tailscale SSH sign-in checks.",
|
||||
"author": {
|
||||
"name": "Termix"
|
||||
},
|
||||
|
||||
Reference in new issue
Block a user