Superminaren
/
kvm
mirror of https://github.com/jetkvm/kvm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Muhammad Daud Nasir 2025-05-27 19:16:46 +04:00 committed by GitHub
parent 1f7c5c94d8
commit d649cf70ef
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 23 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -1,48 +1,36 @@
<div align="center">
<img alt="JetKVM logo" src="https://jetkvm.com/logo-blue.png" height="28">
JetKVM
<div align="center"> <img alt="JetKVM logo" src="https://jetkvm.com/logo-blue.png" height="28"> </div>
### KVM
Links
Discord | Website | Issues | Docs
[Discord](https://jetkvm.com/discord) | [Website](https://jetkvm.com) | [Issues](https://github.com/jetkvm/cloud-api/issues) | [Docs](https://jetkvm.com/docs)
About JetKVM
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 troubleshooting boot failures, installing a new operating system, adjusting BIOS settings, or simply taking control of a machine remotely, JetKVM provides the tools to get the job done.
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/jetkvm.svg?style=social&label=Follow%20%40JetKVM)](https://twitter.com/jetkvm)
Features
Ultra-low Latency – 1080p@60FPS video with 30-60ms latency using H.264 encoding, ensuring smooth mouse and keyboard interaction.
[![Go Report Card](https://goreportcard.com/badge/github.com/jetkvm/kvm)](https://goreportcard.com/report/github.com/jetkvm/kvm)
Free & Optional Remote Access – Manage your device remotely via JetKVM Cloud using WebRTC.
</div>
Open-source Software – Written in Golang for Linux, allowing easy customization through SSH access.
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.
Contributing
We welcome contributions from the community! Whether it's improving the firmware, adding new features, or enhancing documentation, your input is valuable. Please review our Code of Conduct before contributing.
## Features
Getting Help
For answers to common questions, check out our Documentation. If you need additional support, join our Discord Server.
- **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.
Reporting Issues
If you've found a bug, please report it via our Issues page. Be sure to include your firmware version, platform details, and clear steps to reproduce the issue.
## Contributing
Development
JetKVM is written in Go and TypeScript, with some components in C. An intermediate level of Go and TypeScript knowledge is recommended for 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](/CODE_OF_CONDUCT.md) carefully.
The project consists of two main parts:
## I need help
Backend Software – Runs on the KVM device, manages device functionality and cloud API.
The best place to search for answers is our [Documentation](https://jetkvm.com/docs). If you can't find the answer there, check our [Discord Server](https://jetkvm.com/discord).
Frontend Software – Built with React and TypeScript, served by the KVM device and cloud.
## I want to report an issue
If you've found an issue and want to report it, please check our [Issues](https://github.com/jetkvm/kvm/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 most of local device development, all you need is to 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.
Development Setup
For local development, use the ./dev_deploy.sh script to build and deploy the frontend and backend to your KVM device. Run ./dev_deploy.sh --help for more details.