JetKVM - Control any computer remotely
kvm
Go to file
Adam Shiervani 4052b3d225
Move settings to modals & better modal handling (#194)
* feat(ui): Add other session handling route and modal

* feat(ui): Add dedicated update route and refactor update dialog state management

* feat(ui): Add local authentication route

* refactor(ui): Remove LocalAuthPasswordDialog component and clean up related code

* refactor(ui): Remove OtherSessionConnectedModal component

* feat(ui): Add dedicated mount route and refactor mount media dialog

* refactor(ui): Simplify Escape key navigation in device route

* refactor(ui): Add TODO comments for future URL-based state migration

* refactor(ui): Migrate settings and update routes to dedicated routes

This commit introduces a comprehensive refactoring of the UI routing and state management:
- Removed sidebar-based settings view
- Replaced global modal state with URL-based routing
- Added dedicated routes for settings, including general, security, and update sections
- Simplified modal and sidebar interactions
- Improved animation and transition handling using motion library
- Removed deprecated components and simplified route structure

* fix(ui): Add TODO comment for modal session interaction

* refactor(ui): Move USB configuration to new settings setup

This commit introduces several improvements to the USB configuration workflow:
- Refactored USB configuration dialog component
- Simplified USB config state management
- Moved USB configuration to hardware settings route
- Updated JSON-RPC type definitions
- Cleaned up unused imports and components
- Improved error handling and notifications

* refactor(ui): Replace react-router-dom navigation with custom navigation hook

This commit introduces a new custom navigation hook `useDeviceUiNavigation` to replace direct usage of `useNavigate` across multiple components:
- Removed direct `useNavigate` imports in various components
- Added `navigateTo` method from new navigation hook
- Updated navigation calls in ActionBar, MountPopover, UpdateInProgressStatusCard, and other routes
- Simplified navigation logic and prepared for potential future navigation enhancements
- Removed console logs and unnecessary comments

* refactor(ui): Remove unused react-router-dom import

Clean up unnecessary import of `useNavigate` from react-router-dom in device settings route

* feat(ui): Improve mobile navigation and scrolling in device settings

* refactor(ui): Reorganize device access and security settings

This commit introduces several changes to the device access and security settings:
- Renamed "Security" section to "Access" in settings navigation
- Moved local authentication routes from security to access
- Removed deprecated security settings route
- Added new route for device access settings with cloud and local authentication management
- Updated cloud URL and adoption logic to be part of the access settings
- Simplified routing and component structure for better user experience

* fix(ui): Update logout button hover state color

* fix(ui): Adjust device de-registration button size to small

* fix(ui): Update appearance settings section header and description

* refactor(ui): Replace SectionHeader with new SettingsPageHeader and SettingsSectionHeader components

This commit introduces two new header components for settings pages:
- Created SettingsPageHeader for main page headers
- Created SettingsSectionHeader for subsection headers
- Replaced all existing SectionHeader imports with new components
- Updated styling and type definitions to support more flexible header rendering

* feat(ui): Add dev channel toggle to advanced settings

Move dev channel update option from general settings to advanced settings
- Introduced new state and handler for dev channel toggle
- Removed dev channel option from general settings route
- Added dev channel toggle in advanced settings with error handling
2025-02-27 16:48:50 +01:00
.devcontainer fix(devcontainer): Map local ssh keys to container (#180) 2025-02-20 21:39:25 +01:00
bin Release 202412292127 2024-12-29 21:27:42 +01:00
cmd Release 202412292127 2024-12-29 21:27:42 +01:00
resource Release 202412292127 2024-12-29 21:27:42 +01:00
ui Move settings to modals & better modal handling (#194) 2025-02-27 16:48:50 +01:00
.gitignore Release 202412292127 2024-12-29 21:27:42 +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 Feature: Add a metrics endpoint 2025-02-23 15:18:46 +01:00
README.md Release 202412292127 2024-12-29 21:27:42 +01:00
block_device.go Release 202412292127 2024-12-29 21:27:42 +01:00
cloud.go feat(cloud): Add custom cloud API URL configuration support (#181) 2025-02-25 16:10:46 +01:00
config.go Move settings to modals & better modal handling (#194) 2025-02-27 16:48:50 +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(config): merge userConfig with defaultConfig and add a lock (#164) 2025-02-17 20:12:34 +01:00
fuse.go Release 202412292127 2024-12-29 21:27:42 +01:00
go.mod Feature: Add a metrics endpoint 2025-02-23 15:18:46 +01:00
go.sum Feature: Add a metrics endpoint 2025-02-23 15:18:46 +01:00
hw.go Release 202412292127 2024-12-29 21:27:42 +01:00
jiggler.go Release 202412292127 2024-12-29 21:27:42 +01:00
jsonrpc.go Move settings to modals & better modal handling (#194) 2025-02-27 16:48:50 +01:00
log.go add extra logging and tune timeout settings for cloud (#167) 2025-02-18 17:22:03 +01:00
main.go feat(extension): ATX/DC/Serial extension support 2025-02-17 18:37:47 +01:00
native.go chore(config): merge userConfig with defaultConfig and add a lock (#164) 2025-02-17 20:12:34 +01:00
network.go feat(ntp): add delay between sync attempts and support NTP servers from DHCP (#162) 2025-02-17 11:02:28 +01:00
ntp.go feat(ntp): add delay between sync attempts and support NTP servers from DHCP (#162) 2025-02-17 11:02:28 +01:00
ota.go Release 202412292127 2024-12-29 21:27:42 +01:00
publish_source.sh Release 202412292127 2024-12-29 21:27:42 +01:00
remote_mount.go Release 202412292127 2024-12-29 21:27:42 +01:00
serial.go feat(extension): ATX/DC/Serial extension support 2025-02-17 18:37:47 +01:00
terminal.go Release 202412292127 2024-12-29 21:27:42 +01:00
usb.go Feature/usb config - Rebasing USB Config Changes on Dev Branch (#185) 2025-02-27 09:53:47 +01:00
usb_mass_storage.go Release 202412292127 2024-12-29 21:27:42 +01:00
video.go Release 202412292127 2024-12-29 21:27:42 +01:00
web.go Feature: Add a metrics endpoint 2025-02-23 15:18:46 +01:00
webrtc.go feat(extension): ATX/DC/Serial extension support 2025-02-17 18:37:47 +01:00
wol.go Release 202412292127 2024-12-29 21:27:42 +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.