Lukas Wolfsteiner
519e391595
* feat(tailscale): add custom control URL configuration & handling w/ tests - Introduced TailscaleControlURL in the Config struct to allow configuration of the Tailscale control server. - Added RPC handlers for getting and setting the Tailscale control URL. - Updated TailscaleStatus to include controlURL, ensuring it reflects the configured or default value. - Enhanced parsing and normalization of the control URL to enforce valid formats. - Updated TailscaleCard component to manage and display the control server URL, allowing users to save changes. * docs: update README to include optional Tailscale networking feature Added a new section highlighting the built-in Tailscale status and control-server configuration, including support for custom Headscale-compatible endpoints. * docs: Extend DEVELOPMENT.md with Tailscale control server details * fix(tailscale): enhance error handling in rpcSetTailscaleControlURL - Updated the rpcSetTailscaleControlURL function to revert the TailscaleControlURL to its previous value if saving or applying the new URL fails. - Added a new test to ensure that the configuration is not saved when the apply command fails, verifying that the previous URL remains intact. - Adjusted existing tests to validate the order of operations during the URL setting process. Related to Review: https://github.com/jetkvm/kvm/pull/1312#pullrequestreview-3984856379 * refactor(tailscale): simplify control URL application logic and enhance error handling - Renamed the test function to better reflect its purpose and updated the test cases to ensure correct command execution. - Removed fallback logic for applying the Tailscale control URL, streamlining the error handling to return a clear error message when the "set" command fails. - Added a new test to verify behavior when the "set" command fails, ensuring proper error reporting. Related to Review https://github.com/jetkvm/kvm/pull/1312#pullrequestreview-3984856379 * refactor(tailscale): update control server configuration in UI & documentation - Updated the TailscaleCard component to allow users to select between default and custom control server URLs. - Improved state management for control server URL input based on the selected mode. - Revised DEVELOPMENT.md to clarify control server application logic and error handling. - Removed outdated example JSON-RPC payloads for clarity. Related to Review: https://github.com/jetkvm/kvm/pull/1312#discussion_r2980284611 * refactor(ui): use built-in components and i18n for TailscaleCard - Replace raw <select> with SelectMenuBasic component - Use SettingsItem with new SM size for control server setting - Use NestedSettingsGroup for indented custom URL input - Add tailscale_* i18n keys to all 14 locale files with translations - Add size prop (SM/MD) to SettingsItem for compact contexts --------- Co-authored-by: Adam Shiervani <adam.shiervani@gmail.com>
3.4 KiB
JetKVM is a high-performance, open-source KVM over IP (Keyboard, Video, Mouse) solution designed for efficient remote management of computers, servers, and workstations. Whether you're dealing with boot failures, installing a new operating system, adjusting BIOS settings, or simply taking control of a machine from afar, JetKVM provides the tools to get it done effectively.
Features
- Ultra-low Latency - 1080p@60FPS video with 30-60ms latency using H.264 encoding. Smooth mouse and keyboard interaction for responsive remote control.
- Free & Optional Remote Access - Remote management via JetKVM Cloud using WebRTC.
- Optional Tailscale Networking - Built-in Tailscale status and control-server configuration, including custom Headscale-compatible endpoints.
- Open-source software - Written in Golang on Linux. Easily customizable through SSH access to the JetKVM device.
Contributing
We welcome contributions from the community! Whether it's improving the firmware, adding new features, or enhancing documentation, your input is valuable. We also have some rules and taboos here, so please read this page and our Code of Conduct carefully.
I need help
The best place to search for answers is our Documentation. If you can't find the answer there, check our Discord Server.
I want to report an issue
If you've found an issue and want to report it, please check our Issues page. Make sure the description contains information about the firmware version you're using, your platform, and a clear explanation of the steps to reproduce the issue.
Development
JetKVM is written in Go & TypeScript. with some bits and pieces written in C. An intermediate level of Go & TypeScript knowledge is recommended for comfortable programming.
The project contains two main parts, the backend software that runs on the KVM device and the frontend software that is served by the KVM device, and also the cloud.
For comprehensive development information, including setup, testing, debugging, and contribution guidelines, see DEVELOPMENT.md.
For quick device development, use the ./dev_deploy.sh script. It will build the frontend and backend and deploy them to the local KVM device. Run ./dev_deploy.sh --help for more information.
Backend
The backend is written in Go and is responsible for the KVM device management, the cloud API and the cloud web.
Frontend
The frontend is written in React and TypeScript and is served by the KVM device. It has three build targets: device, development and production. Development is used for development of the cloud version on your local machine, device is used for building the frontend for the KVM device and production is used for building the frontend for the cloud.