JetKVM - Control any computer remotely
kvm
Go to file
Alex Goodkind 718b343713
feat: add local web server loopback mode configuration (#511)
* feat: add local web server loopback mode configuration

- Introduced a new configuration option `LocalWebServerLoopbackOnly` to restrict the web server to listen only on the loopback interface.
- Added RPC methods `rpcGetLocalWebServerLoopbackOnly` and `rpcSetLocalWebServerLoopbackOnly` for retrieving and updating this setting.
- Updated the web server startup logic to bind to the appropriate address based on the new configuration.
- Modified the `LocalDevice` struct to include the loopback setting in the response.

* remove extra logs

* chore: add VSCode extensions for improved development environment

* refactor: rename LocalWebServerLoopbackOnly to LocalLoopbackOnly

- Updated the configuration struct and related RPC methods to use the new name `LocalLoopbackOnly` for clarity.
- Adjusted the web server binding logic and device response structure to reflect this change.

* feat: add loopback-only mode functionality to UI

- Implemented a new setting for enabling loopback-only mode, restricting web interface access to localhost.
- Added a confirmation dialog to warn users before enabling this feature.
- Updated the ConfirmDialog component to accept React nodes for the description prop.
- Refactored imports and adjusted component structure for clarity.

* refactor: optimize device settings handlers for better performance

- Refactored the `handleDevChannelChange` and `handleLoopbackOnlyModeChange` functions to use `useCallback` for improved performance and to prevent unnecessary re-renders.
- Consolidated the logic for applying loopback-only mode into a separate `applyLoopbackOnlyMode` function, enhancing code clarity and maintainability.
- Updated the confirmation flow for enabling loopback-only mode to ensure user warnings are displayed appropriately.
2025-05-27 17:28:51 +02:00
.devcontainer chore: add VSCode extensions for improved development environment (#509) 2025-05-23 14:38:15 +02:00
.github/workflows build: enable trimpath for both dev and prod releases 2025-05-20 20:28:40 +02:00
.vscode chore: add VSCode extensions for improved development environment (#509) 2025-05-23 14:38:15 +02: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 feat(websecure): add support for ed25519 certificates (#513) 2025-05-25 11:09:58 +02:00
resource fix: unit test not returning error when test fails 2025-05-19 22:51:11 +02:00
ui feat: add local web server loopback mode configuration (#511) 2025-05-27 17:28:51 +02:00
.gitignore chore: run golang tests 2025-05-16 19:53:01 +02:00
.golangci.yml refactor: remove init functions (#489) 2025-05-22 10:29:16 +02: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 chore: bump version to 0.4.1 2025-05-22 11:17:00 +02:00
README.md chore: add Go Report Card 2025-05-19 08:53:01 +02:00
block_device.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
block_device_linux.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
block_device_notlinux.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
cloud.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
config.go feat: add local web server loopback mode configuration (#511) 2025-05-27 17:28:51 +02:00
dev_deploy.sh fix: unit test not returning error when test fails 2025-05-19 22:51:11 +02:00
display.go refactor: remove init functions (#489) 2025-05-22 10:29:16 +02:00
fuse.go refactor: update golintci-lint and linter issues 2025-04-13 03:55:30 +02:00
go.mod fix: unit test not returning error when test fails 2025-05-19 22:51:11 +02:00
go.sum fix: unit test not returning error when test fails 2025-05-19 22:51:11 +02:00
hw.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
jiggler.go refactor: remove init functions (#489) 2025-05-22 10:29:16 +02:00
jsonrpc.go feat: add local web server loopback mode configuration (#511) 2025-05-27 17:28:51 +02:00
log.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
main.go refactor: remove init functions (#489) 2025-05-22 10:29:16 +02:00
mdns.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
native.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
native_linux.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
native_notlinux.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
network.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
ota.go chore: always return local version if update check fails (#485) 2025-05-20 14:57:57 +02:00
prometheus.go chore: Enable more linters 2025-03-26 18:41:09 +01:00
publish_source.sh fix: Shell linting (#328) 2025-04-11 00:43:45 +02:00
remote_mount.go refactor: use structured logging 2025-04-11 00:43:46 +02:00
serial.go refactor: update golintci-lint and linter issues 2025-04-13 03:55:30 +02:00
terminal.go chore(log): add terminalLogger 2025-04-11 07:58:11 +02:00
timesync.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
usb.go feat: sync keyboard led status (#502) 2025-05-23 00:12:18 +02:00
usb_mass_storage.go chore: create images folder when starting the application (#437) 2025-05-13 21:13:21 +02:00
video.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
web.go feat: add local web server loopback mode configuration (#511) 2025-05-27 17:28:51 +02:00
web_tls.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
webrtc.go network enhanecment / refactor (#361) 2025-04-16 01:39:23 +02:00
wol.go chore: update logging 2025-04-11 12:55:36 +02: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.