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

Files

wj-xiao 6eb4a4ea62 update version to 2.1.6

feat: support downloading image from online URL
feat: add keyboard shortcut Ctrl+Alt+Del
fix: fix the CSRF issue
perf: add an option to configure custom ICE servers
perf: removed unnecessary modifications to DNS configuration
perf: add an SSH enable/disable toggle in the web UI
perf: add a Tailscale enable/disable toggle in the web UI
perf: download Tailscale installation package from the official source
perf: automatic enable/disable GOMEMLIMIT on tailscale start/stop
perf: add JWT configuration
perf: implement secure password storage using bcrypt hashing
perf: implement integrity checks for online updates
refactor: refactor HDMI module and remove the dependency libmaixcam_lib.so
refactor: web terminal use pty instead of SSH
refactor: move Tailscale APIs from the network module to the extensions module

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

public

Add mocks to remove the need for a physical device

2024-11-05 23:28:02 +00:00

src

update version to 2.1.6

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

.editorconfig

create web

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

.env.development

update version to 2.1.4

2025-01-10 10:31:38 +08:00

.eslintrc.cjs

create web

2024-08-09 19:45:45 +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

index.html

create web

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

package.json

Upgrade vite

2025-02-07 10:21:25 +08:00

pnpm-lock.yaml

Upgrade vite

2025-02-07 10:21:25 +08:00

postcss.config.js

create web

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

README_JA.md

docs: add Japanese README files

2024-12-14 17:51:53 +09:00

README_ZH.md

update version to 2.1.6

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

README.md

update version to 2.1.6

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

tailwind.config.js

create web

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

tsconfig.json

create web

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

tsconfig.node.json

create web

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

vite.config.ts

create web

2024-08-09 19:45:45 +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

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.