Ethica/Termix
1
0 Fork 0
mirror of https://github.com/Termix-SSH/Termix.git synced 2026-10-30 07:05:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

plugins/remote-desktop/README.md
+38 -53
View File
@@ -1,68 +1,53 @@
# Remote Desktop
<div align="center">
RDP, VNC and Telnet sessions in the browser, with clipboard, file transfer, recording and sharing.
<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />
<h1>Remote Desktop</h1>
<p>RDP, VNC and Telnet in your browser</p>
</div>
<br />
## Overview
Remote Desktop opens RDP, VNC and Telnet sessions in a tab, just like an SSH terminal.
<br />
## Features
- Connect to hosts over RDP, VNC or Telnet from any browser.
- Clipboard sync and file transfer through RDP drive redirection.
- Session recording and session sharing, when those plugins are on.
- Jump host support.
- Opens the Windows Remote Desktop client from the desktop app.
- RDP, VNC and Telnet from any browser
- Tabs and split screen like any other session
- Clipboard sync and file transfer through RDP drives
- Jump host support
- Session sharing and recording
- Open a host in the native Windows Remote Desktop client from the desktop app
## Setup
This plugin needs guacd, the Apache Guacamole proxy that speaks RDP, VNC and Telnet. The Docker compose file runs it as its own `guacamole/guacd` container. This plugin never starts guacd itself.
Set where guacd runs with the guacd URL admin setting. The `GUACD_URL`, or `GUACD_HOST` and `GUACD_PORT`, environment variables override that setting.
Other environment variables:
| Variable | What it sets |
| ------------------------------ | --------------------------------------------------------------------------------- |
| `GUACD_TUNNEL_HOST` | The name guacd uses to reach Termix for a jump host tunnel. Defaults to `termix`. |
| `GUACD_RECORDING_PATH` | Where guacd writes recordings, as guacd sees it. |
| `GUACD_RECORDING_BACKEND_PATH` | The same folder, as Termix sees it. |
| `GUACD_DRIVE_PATH` | The root of each user's RDP drive folder on the guacd host. |
| `GUACAMOLE_ENCRYPTION_KEY` | The connection token key. Made from `JWT_SECRET` when not set. |
## Settings
### Admin
- Enable Remote Desktop: turn remote desktop on or off.
- guacd URL: where guacd runs, as `host:port`. Changes apply without a restart.
### User
- RDP defaults: color depth, resize method, wallpaper, font smoothing, audio, printing, drive redirection and clipboard. A host's own values win over these.
### Host
- RDP, VNC and Telnet: turn each protocol on and set its port.
- RDP security mode and Ignore certificate errors.
- guacd settings: every other guacd option.
- Remote desktop toolbar: show the toolbar in the session.
## Permissions
- `remote-desktop.sessions`: Let session sharing and recording reach your remote desktop sessions. Admins and users have it by default.
<br />
## Services
Provides to other plugins:
- `sessions.live` as `rdp`, `vnc` and `telnet`: find a live session so it can be shared.
- `sessions.live` as `rdp`, `vnc` and `telnet`: find a live session so it can be shared
Uses from other plugins:
- `recordings.writer` to record sessions. Optional.
- `tunnels.access` for single-hop jump host tunnels. Optional.
- `recordings.writer` to record sessions. Optional
- `tunnels.access` for jump host tunnels. Optional
## 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.