Adam Shiervani
d89231aeec
* chore: update Makefile for improved build process and add testing commands * chore: add git checks to dev_release for branch and status validation * chore: enhance dev_release with gh CLI checks and release creation * chore: update dev_release to use versioned tags for Git and GitHub releases * chore: refactor deploy script to use version argument and improve deployment process * chore: update Makefile to version 0.5.0 and enhance release process with confirmation prompts and version bumping * chore: enhance release process in Makefile with pre-release checks and user confirmation for production releases * chore: refactor build process in Makefile to streamline development builds with a dedicated inner target * chore: simplify build_release target in Makefile by removing frontend dependency * chore: enable automatic version bumping in Makefile by uncommenting git commands * chore: add pre-release testing prompts in Makefile for both development and production releases * chore: update Makefile and test_release_on_device.sh to implement a new testing flow for pre-release validation * chore: update Makefile to ensure consistent version handling in build and release processes
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.
- 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.