mirror of
https://github.com/Termix-SSH/Termix.git
synced 2026-10-29 06:35: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,15 +2,6 @@
|
||||
|
||||
## 1.0.0
|
||||
|
||||
Bundled with Termix 2.9.0.
|
||||
First release, bundled with Termix 2.9.0.
|
||||
|
||||
- Session recording moved out of core's `/session_logs` routes and now serves
|
||||
under `/plugin-api/session-recording` through core's connect pipeline.
|
||||
- Owns its data: core's `session_recordings` table is renamed to
|
||||
`p_session_recording_session_recordings` on first activation.
|
||||
- New `session-recording.view` permission, given to the admin and user roles.
|
||||
- Offers `recordings.writer` to other plugins: `open()`/`append()`/`persist()`
|
||||
for an incremental writer (ssh-terminal), `createFinished()` for a recording
|
||||
already written to disk (remote desktop's guacd recordings).
|
||||
- Retention days becomes an admin plugin setting; per-host recording becomes
|
||||
a host plugin setting.
|
||||
Records SSH terminal sessions so you can play them back, copy their text or download them. Old recordings are removed after a set number of days.
|
||||
@@ -1,24 +1,41 @@
|
||||
# Session Recording
|
||||
|
||||
Records terminal sessions and lets you play them back or download them.
|
||||
Record terminal sessions and play them back or download them later.
|
||||
|
||||
Bundled with Termix and enabled by default. It imports only
|
||||
`@termix/plugin-sdk`.
|
||||
## Features
|
||||
|
||||
## What it does
|
||||
- Records SSH terminal sessions as they happen.
|
||||
- Play a recording back, skip through it and copy its text.
|
||||
- Download a recording as a file or as plain text.
|
||||
- Removes recordings older than a set number of days.
|
||||
- Keeps recordings when a user is deleted, with the user's name removed.
|
||||
|
||||
- **Recording**: an SSH terminal session is recorded as an asciicast, written
|
||||
incrementally in 300ms batches as it happens (issue #1049).
|
||||
- **Playback**: view a recording inline, scrub through it, copy its plain
|
||||
text, or download it as a recording file or plain text.
|
||||
- **Retention**: an admin setting prunes recordings older than a configured
|
||||
number of days, checked at startup and every 24 hours.
|
||||
- **Per-host switch**: recording can be turned off for a host.
|
||||
- **`recordings.writer`**: a service other plugins consume. `open(meta)`
|
||||
starts an incremental recording (ssh-terminal); `createFinished(input)`
|
||||
inserts a row for a recording the caller already wrote to disk itself
|
||||
(remote desktop's guacd recordings).
|
||||
## Settings
|
||||
|
||||
Recordings outlive the account they were made under: deleting a user
|
||||
anonymizes their recordings rather than deleting them, since a recording is
|
||||
evidence about the host as much as about the person.
|
||||
### Admin
|
||||
|
||||
- Retention (days): remove recordings older than this. Checked at startup and once a day.
|
||||
|
||||
### Host
|
||||
|
||||
- Enable session recording: record sessions on this host.
|
||||
|
||||
## Permissions
|
||||
|
||||
- `session-recording.view`: View and download session recordings. Admins and users have it by default.
|
||||
|
||||
## Services
|
||||
|
||||
Provides to other plugins:
|
||||
|
||||
- `recordings.writer`: start a recording and add to it as a session runs, or save a recording that is already finished.
|
||||
|
||||
## 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": "session-recording",
|
||||
"name": "Session Recording",
|
||||
"version": "1.0.0",
|
||||
"description": "Records terminal sessions and lets you play them back or download them.",
|
||||
"description": "Record terminal sessions and play them back or download them later.",
|
||||
"author": {
|
||||
"name": "Termix"
|
||||
},
|
||||
|
||||
Reference in new issue
Block a user