React Guacamole client written in Typescript.
guacamole-client is a React web application implementing
guacamole-common-js
to provide a modern interface for remote desktop.
As the client communicates to the guacd server using the
Guacamole protocol,
any protocol that Guacamole supports can be used, e.g. VNC, RDP, SSH and Telnet.
Note
Guacamole Server already provides a web application for "clientless" remote desktop.
This project aims to provide an application for other Guacamole-compatible servers, such as guacamole-lite.
Default configuration can be set in src/config.ts.
Once you have a guacd and guacamole-lite
server running, build the project or start the development server:
- Build:
npm run build - Development:
npm run dev
Please note that token generation relies on the Web Crypto API, which is only available in secure contexts.
Documentation can be generated with TypeDoc, which can
be invoked by npm run docs.
For Guacamole-specific information, see the official manual.
- guacamole-common-js - Guacamole protocol client
- react - web framework
- react-error-boundary - error handling
- @fontsource/roboto - fonts
- @mui/icons-material - icons
- @mui/material - component library
guacamole-client is licensed under the MIT Licence for everyone to use, modify and share freely.
This project is distributed in the hope that it will be useful, but without any warranty.
If you found this project useful, please consider donating. Any amount is greatly appreciated! Thank you 😃
