mirror of https://github.com/sipeed/NanoKVM.git synced 2026-09-11 00:22:56 -05:00

Files

watermeko 9e6d280826 feat(web): add configurable mouse input regions

Add device-level input-region APIs for reading, validating, and atomically persisting absolute mouse calibration settings, including automatic, manual, and disabled modes.

Introduce a shared screen viewport that keeps the rendered media geometry and configured input region aligned across MJPEG, direct H.264, and WebRTC streams. Add automatic black-border detection and a manual selection overlay with dragging, resizing, magnified preview, keyboard locking, and cancellation support.

Provide original-resolution presets so manual calibration can be recalculated for common aspect ratios, expose the controls from the desktop mouse menu, close menus before entering selection mode, and preserve active file transfers when the download menu closes.

Add localized control-region labels and messages for all supported locales, and update direct-frame rendering so media dimensions are reported after the canvas has been drawn.

2026-08-25 09:36:13 +08:00

public

chore(web): update PostCSS and MSW worker

2026-05-18 15:02:31 +08:00

src

feat(web): add configurable mouse input regions

2026-08-25 09:36:13 +08:00

.editorconfig

create web

2024-08-09 19:45:45 +08:00

.env.development

refactor: refactor offline update function

2025-12-26 15:38:05 +08:00

.prettierignore

create web

2024-08-09 19:45:45 +08:00

.prettierrc.yaml

optimizing i18n and language setting

2024-08-26 14:15:35 +08:00

eslint.config.js

chore: update eslint

2026-01-14 17:58:25 +08:00

index.html

create web

2024-08-09 19:45:45 +08:00

package.json

feat: add secure multi-user support (#876 )

2026-08-20 14:29:56 +08:00

pnpm-lock.yaml

feat: add secure multi-user support (#876 )

2026-08-20 14:29:56 +08:00

pnpm-workspace.yaml

chore(web): update PostCSS and MSW worker

2026-05-18 15:02:31 +08:00

postcss.config.js

create web

2024-08-09 19:45:45 +08:00

README_JA.md

Update Japanese Docs.

2025-02-23 09:31:51 +09:00

README_ZH.md

update version to 2.1.6

2025-02-14 14:18:13 +08:00

README.md

feat: add dev container for full-stack development (#861 )

2026-08-06 11:00:40 +08:00

tailwind.config.js

create web

2024-08-09 19:45:45 +08:00

tsconfig.json

Streaming Refactor:

2025-11-26 10:57:30 +08:00

tsconfig.node.json

create web

2024-08-09 19:45:45 +08:00

vite.config.ts

feat(web): upgrade build tooling to Vite 8 (#853 )

2026-08-06 14:25:55 +08:00

README.md

NanoKVM Frontend

This is NanoKVM web project. For more documentation, please refer to the Wiki.

Structure

src
├── api                // backend api
├── assets             // static resources
├── components         // public components
├── i18n               // language resources
├── jotai              // Global jotai variables
├── lib                // util libs
├── pages              // web pages
│    ├── auth             // login and password
│    ├── desktop          // remote desktop
│    └── terminal         // web terminal
├── router.tsx         // routers
└── types              // types

Local Development

Requirements: Node.js >= 22 and pnpm >= 11 (the versions CI uses; enforced via the engines field in package.json).

Development requires SSH. You can enable it in the Web Settings: Settings > SSH.

Due to CORS restrictions, authentication needs to be disabled during local development.

To develop authentication features, you need to build the project and test in NanoKVM.

Log in to NanoKVM via SSH: ssh root@your-nanokvm-ip (default password is root).
Open the configuration file /etc/kvm/server.yaml/ and add authentication: disable. ⚠️CAUTION: This option disables all authentication and should NOT be enabled in production environment!
Restart the service: /etc/init.d/S95nanokvm restart.
Edit the .env.development file and change VITE_SERVER_IP to your NanoKVM IP address.
Run pnpm dev to start the server and visit http://localhost:3001/ in browser.

It's recommended to disable browser caching to avoid access issues during development:

Open the browser Developer Tools;
Go to the Network tab;
Check Disable cache option;
Refresh the page.

Deployment

Build:

cd web
pnpm install
pnpm build

After the compilation is complete, the dist folder will be generated.
Rename the folder to web.
Upload web to /kvmapp/server/ in NanoKVM.
Restart the service by executing /etc/init.d/S95nanokvm restart in NanoKVM.

Tips:

File uploads requires SSH. You can enable it in the Web Settings: Settings > SSH.
Browser may have old version cache. If you can't open the page, try a force refresh or clear the cache.