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

+37 -28
View File
@@ -1,43 +1,52 @@
# Session Sharing
<div align="center">
Share a live terminal or remote desktop session by link or with another user, and present sessions in collaboration rooms.
<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />
<h1>Session Sharing</h1>
<p>Share live sessions and run meetings together</p>
</div>
<br />
## Overview
Session Sharing lets you share a live terminal or remote desktop session with someone else, and present sessions to a group in meeting rooms.
<br />
## Features
- Share a live terminal or remote desktop session by link or with one user.
- Pick read-only or read and write, and set when the share expires.
- Collaboration rooms where a presenter shows a session to a group and can hand control to a member.
- Guest links for people without a Termix account.
- The share button is in the terminal and remote desktop toolbars.
- Share terminal, RDP, VNC and Telnet sessions
- Share by link with anyone, or with a Termix user
- Read-only or read and write
- Links that expire or can be revoked
- Meeting rooms where a presenter shows a session and can hand over control
- Guest links for people without an account
## Settings
### Admin
- Allow Session Sharing: turn sharing on or off for everyone.
### Host
- Allow Session Sharing: allow sharing sessions on this host.
## Permissions
- `session-sharing.use`: Share sessions and join rooms. Admins and users have it by default.
<br />
## Services
Provides to other plugins:
- `sessions.sharing`: join a shared session or room from the terminal.
- `sessions.sharing`: join a shared session or room from the terminal
Uses from other plugins:
- `sessions.live` to reach live SSH, RDP, VNC and Telnet sessions.
- `sessions.live` to reach live SSH, RDP, VNC and Telnet sessions
## 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.