JetKVM - Control any computer remotely
kvm
Go to file
Adam Shiervani 8268b20f32
refactor: Update WebRTC connection handling and overlays (#320)
* refactor: Update WebRTC connection handling and overlays

* fix: Update comments for WebRTC connection handling in KvmIdRoute

* chore: Clean up import statements in devices.$id.tsx
2025-04-03 19:32:14 +02:00
.devcontainer fix(devcontainer): Map local ssh keys to container (#180) 2025-02-20 21:39:25 +01:00
.github/workflows chore: move smoketest to private repo 2025-03-25 18:42:26 +01:00
bin Release 202412292127 2024-12-29 21:27:42 +01:00
cmd Chore: Fix up various linting issues 2025-03-11 18:22:45 +01:00
internal/usbgadget fix(usb_mass_storage): should use path instead of configPath 2025-03-19 17:43:19 +01:00
resource Release 202412292127 2024-12-29 21:27:42 +01:00
ui refactor: Update WebRTC connection handling and overlays (#320) 2025-04-03 19:32:14 +02:00
.gitignore Release 202412292127 2024-12-29 21:27:42 +01:00
.golangci.yml chore: Enable more linters 2025-03-26 18:41:09 +01:00
CODE_OF_CONDUCT.md Release 202412292127 2024-12-29 21:27:42 +01:00
LICENSE Release 202412292127 2024-12-29 21:27:42 +01:00
Makefile Merge branch 'main' into dev 2025-03-19 18:30:30 +01:00
README.md chore: Update README Discord Link 2025-03-29 21:13:59 +00:00
block_device.go Logging cleanup 2025-03-11 18:47:49 +01:00
cloud.go feat(cloud): add metrics for cloud connections 2025-04-03 19:06:21 +02:00
config.go Fix more linter issues. 2025-03-11 18:35:12 +01:00
dev_deploy.sh feat(dev): Add option to skip frontend build in dev_deploy.sh (#183) 2025-02-25 16:12:04 +01:00
display.go Chore: Enable golangci-lint 2025-03-11 18:35:12 +01:00
fuse.go Cleanup logging 2025-03-11 16:53:54 +01:00
go.mod Chore: Enable golangci-lint 2025-03-11 18:35:12 +01:00
go.sum Chore: Enable golangci-lint 2025-03-11 18:35:12 +01:00
hw.go Chore: Fix up various linting issues 2025-03-11 18:22:45 +01:00
jiggler.go Fix more linter issues. 2025-03-11 18:35:12 +01:00
jsonrpc.go feat: relative mouse (#246) 2025-03-19 11:47:15 +01:00
log.go Fix more linter issues. 2025-03-11 18:35:12 +01:00
main.go chore: skip websocket client if net isn't up or time sync hasn't complete 2025-04-03 18:16:41 +02:00
native.go Fix more linter issues. 2025-03-11 18:35:12 +01:00
network.go Chore: Enable golangci-lint 2025-03-11 18:35:12 +01:00
ntp.go chore: skip websocket client if net isn't up or time sync hasn't complete 2025-04-03 18:16:41 +02:00
ota.go Cleanup logging 2025-03-11 16:53:54 +01:00
prometheus.go chore: Enable more linters 2025-03-26 18:41:09 +01:00
publish_source.sh Release 202412292127 2024-12-29 21:27:42 +01:00
remote_mount.go Chore: Fix up various linting issues 2025-03-11 18:22:45 +01:00
serial.go chore: Enable more linters 2025-03-26 18:41:09 +01:00
terminal.go Chore: Fix up various linting issues 2025-03-11 18:22:45 +01:00
usb.go feat: relative mouse (#246) 2025-03-19 11:47:15 +01:00
usb_mass_storage.go fix(usb_mass_storage): should use path instead of configPath 2025-03-19 17:43:19 +01:00
video.go Cleanup logging 2025-03-11 16:53:54 +01:00
web.go chore: Enable more linters 2025-03-26 18:41:09 +01:00
web_tls.go chore: Enable more linters 2025-03-26 18:41:09 +01:00
webrtc.go Cleanup logging 2025-03-11 16:53:54 +01:00
wol.go Chore: Fix up various linting issues 2025-03-11 18:22:45 +01:00

README.md

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 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.