Merge pull request #755 from Z2Z-GuGu/main

Update NanoKVM Doc
sipeed · Jan 22, 2025 · 4f715c6 · 4f715c6
2 parents 8605870 + 889c385
commit 4f715c6
Show file tree

Hide file tree

Showing 12 changed files with 74 additions and 2 deletions.
diff --git a/docs/hardware/en/kvm/NanoKVM/faq.md b/docs/hardware/en/kvm/NanoKVM/faq.md
@@ -12,6 +12,12 @@ keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool
    > Users outside of China may experience download failures due to DNS issues. Please add `nameserver 119.29.29.29` or `nameserver 223.5.5.5` to `/etc/resolv.conf` and try again.
    > Earlier versions of the application may not have this script file. Please download [here](https://github.com/user-attachments/files/16939944/update-nanokvm.py.zip), extract it, and grant execute permissions before trying again.
 
+### About Password
+
+   1. After updating to version 2.1.5, if you haven't set a web password before, you will be prompted to change the password upon logging in. When you change the password, the backend `root` password will also be synchronized to the web password. If you have already changed the web password before, the backend `root` password will not be changed automatically. You can modify it using `passwd` in the terminal or click "Reset Password" in the web settings.
+   2. If the application version is greater than 2.1.5 and you forget the password, you can press the `BOOT` button on the device for more than 10 seconds (the BOOT button for the NanoKVM-Cube is located next to the USB-HID interface, while the PCIe version can be found on the panel. Older versions of the NanoKVM Full may not have a hole in the corresponding location and require disassembly).
+   3. If holding down the button does not reset the password, it may be because the application version is less than 2.1.5. Please refer to [here](https://wiki.sipeed.com/hardware/en/kvm/NanoKVM/system/flashing.html) to reflash the image. Note that reflashing the image will erase all configuration information.
+
 ### STA LED Not Flashing Normally
 
 The STA LED indicates the operating status of the NanoKVM. When functioning properly, the STA LED should flash irregularly. If the STA LED is continuously on or off, or exhibits regular intermittent extinguishing, the NanoKVM may be malfunctioning.

diff --git a/docs/hardware/en/kvm/NanoKVM/quick_start.md b/docs/hardware/en/kvm/NanoKVM/quick_start.md
@@ -74,6 +74,8 @@ The wiring diagram for the NanoKVM-Full version is as follows. The Lite version
   ![](./../../../assets/NanoKVM/unbox/old-ATX-B.png)
   ![](./../../../assets/NanoKVM/unbox/old-ATX-B-w.png)
 
+Note: NanoKVM-Cube does not monitor HDD status.
+
 ## Updates
 
 ### Update Image

diff --git a/docs/hardware/en/kvm/NanoKVM/user_guide.md b/docs/hardware/en/kvm/NanoKVM/user_guide.md
@@ -108,6 +108,8 @@ NanoKVM's USB will default to simulate an RNDIS USB network card (slave device),
 
 If you do not use the RNDIS feature, it can be disabled by clicking `Settings` -> `RNDIS`.
 
+Note: The NCM connection method was added after version 2.1.5, but the default remains RNDIS. To enable it, use: touch /boot/usb.ncm or create an empty file named usb.ncm in the /boot partition.
+
 ### ATX Power Control
 
 + On the right side of the floating toolbar, there are power and hard disk icons. Normally, they are gray. After powering on, the power icon turns green.
@@ -124,6 +126,13 @@ Note:
 + About NanoKVM: Click to open the Wiki.
 + Check for updates: When updates are available, users can click to update. The web page will automatically refresh and re-login after about 15 seconds to complete the update.
 
+### About SSH
+
++ After updating to version 2.1.5, SSH support can be permanently disabled or temporarily enabled as follows:
+
+1. **Permanently Disable**: Execute `touch /etc/kvm/ssh_stop` to disable SSH login on the next boot of the NanoKVM. To remove this restriction, delete the file with `rm /etc/kvm/ssh_stop`.
+2. **Temporarily Enable**: Execute `touch /boot/start_ssh_once` or create an empty file named start_ssh_once in the /boot partition to enable SSH on the next boot of the NanoKVM. This file will be automatically deleted afterward.
+
 ### More Features Coming Soon
 
 ## Network Latency Estimation

diff --git a/docs/hardware/en/kvm/NanoKVM_PCIe/quick_start.md b/docs/hardware/en/kvm/NanoKVM_PCIe/quick_start.md
@@ -35,7 +35,7 @@ Note: If you need USB HID direct power, you must enable the "Always Power USB" s
 
 Note: The USB-PWR-IN CC interface of the NanoKVM-PCIe has a 5.1K pull-down resistor, allowing it to be powered by a standard PD charger. Some low-quality PD chargers may pose a risk of damaging the NanoKVM-PCIe.
 
-## Wiring
+## Assembly
 
 1. The wiring for NanoKVM-PCIe is similar to that of the Cube. Please install the NanoKVM-PCIe while the main unit is powered off and disconnected from power. Only after testing all functions as normal should you install it into the case.
 
@@ -61,6 +61,10 @@ When wiring, please be sure to refer to the diagram above and the internal inter
 
 ![](./../../../assets/NanoKVM/unbox/PCIe-Pin.jpg)
 
+Note: NanoKVM-PCIe does not monitor HDD status.
+
+Note: Some early users of the NanoKVM-PCIe with a full-height PCIe bracket may encounter issues related to the installation being too long. Please use longer screws to secure it (be careful not to overtighten) or purchase washers with specifications of outer diameter 7mm, inner diameter 4.2mm, height 3mm. If you still encounter difficulties with the installation, please contact Taobao/AliExpress customer service or email [email protected] for support.
+
 ## WiFi Configuration
 
 + This step is only applicable to the NanoKVM-PCIe version with WiFi; other versions will display "--" in the WiFi icon position.

diff --git a/docs/hardware/en/kvm/NanoKVM_PCIe/user_guide.md b/docs/hardware/en/kvm/NanoKVM_PCIe/user_guide.md
@@ -111,6 +111,8 @@ The USB of NanoKVM will default to virtualizing an RNDIS USB network card (as a
 
 If you do not wish to use the RNDIS function, you can click `Settings` -> `RNDIS` to disable it.
 
+Note: The NCM connection method was added after version 2.1.5, but the default remains RNDIS. To enable it, use: touch /boot/usb.ncm or create an empty file named usb.ncm in the /boot partition.
+
 ### ATX Power Control
 
 + On the right side of the floating toolbar, there are power and hard drive icons. Under normal circumstances, they are gray; after powering on, the power icon turns green.
@@ -123,6 +125,13 @@ If you do not wish to use the RNDIS function, you can click `Settings` -> `RNDIS
 + About NanoKVM: Click to open the Wiki.
 + Check for updates: When updates are available, users can click to update. After about 15 seconds, the webpage will automatically refresh and re-login to complete the update.
 
+### About SSH
+
++ After updating to version 2.1.5, SSH support can be permanently disabled or temporarily enabled as follows:
+
+1. **Permanently Disable**: Execute `touch /etc/kvm/ssh_stop` to disable SSH login on the next boot of the NanoKVM. To remove this restriction, delete the file with `rm /etc/kvm/ssh_stop`.
+2. **Temporarily Enable**: Execute `touch /boot/start_ssh_once` or create an empty file named start_ssh_once in the /boot partition to enable SSH on the next boot of the NanoKVM. This file will be automatically deleted afterward.
+
 ## Hardware and Structure
 
 The NanoKVM-PCIe consists of two parts: the mainboard and the USB interface board, connected via a 2P+4P ribbon cable. The USB interface board only exposes the USB-HID and USB-PWR interfaces. When the USB-HID needs to connect to the internal pins of the mainboard, the 4P ribbon cable can be disconnected.

diff --git a/docs/hardware/en/kvm/NanoKVM_USB/faq.md b/docs/hardware/en/kvm/NanoKVM_USB/faq.md
@@ -30,6 +30,12 @@ keywords: NanoKVM-USB, Lichee, PiKVM, RISCV, tool
 
 ### If the above methods do not resolve the issue, please describe your purchased model and the encountered problem on the forum, GitHub, or QQ group, and we will respond patiently.
 
+## Known Issues
+
+### Latency:
+
++ The ARM version of macOS experiences increased latency when connected to a Raspberry Pi via NanoKVM-USB; other combinations are not affected.
+
 ## Feedback Methods
 
 - [GitHub Issues](https://github.com/sipeed/NanoKVM)

diff --git a/docs/hardware/zh/kvm/NanoKVM/faq.md b/docs/hardware/zh/kvm/NanoKVM/faq.md
@@ -11,6 +11,12 @@ keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool
   > 国外用户可能因为DNS原因下载失败，请在 `/etc/resolv.conf` 添加`nameserver 119.29.29.29`或`nameserver 223.5.5.5`后再试
   > 早期版本应用可能不存在该脚本文件，请下载 https://github.com/user-attachments/files/16939944/update-nanokvm.py.zip 解压赋予执行权限后再试
 
+### 关于密码
+
+  1. 更新至 2.1.5 版本应用后，若之前没有设置过网页密码，登录后会提示修改密码，修改密码时，后台的`root`密码也会同步修改成网页密码，若之前已经修改过网页密码，后台`root`密码不会主动修改，请在终端使用`passwd`或网页设置中点击重置密码以修改;
+  2. 应用版本大于 2.1.5 时，若忘记密码，可以按下机身`BOOT`按键10s以上（NanoKVM-Cube的BOOT按键位于USB-HID接口右边，PCIe版本BOOT按键可在面板上找到，较老版本的NanoKVM Full可能没有在对应位置开孔，需要拆机操作）
+  3. 若长按无法重置密码，可能是应用版本小于 2.1.5 ，参考[这里](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/system/flashing.html)重新烧录镜像，注意，重烧镜像后会丢失所有配置信息。
+
 ### STA LED 无法正常闪烁
 
   STA灯用于指示NanoKVM的运行状态，正常工作时，STA灯在不规律闪烁，当STA灯出现长亮/长灭或者 规律性间断熄灭时认为NanoKVM出现故障

diff --git a/docs/hardware/zh/kvm/NanoKVM/quick_start.md b/docs/hardware/zh/kvm/NanoKVM/quick_start.md
@@ -73,6 +73,8 @@ NanoKVM-Full版接口示意图如下，Lite版仅包含 USB-C、HDMI和网口，
   ![](./../../../assets/NanoKVM/unbox/old-ATX-B.png)
   ![](./../../../assets/NanoKVM/unbox/old-ATX-B-w.png)  
 
+  注：NanoKVM-Cube 不会监控HDD状态
+
 ## 更新
 
 ### 更新镜像

diff --git a/docs/hardware/zh/kvm/NanoKVM/user_guide.md b/docs/hardware/zh/kvm/NanoKVM/user_guide.md
@@ -103,6 +103,8 @@ NanoKVM 的 USB 会默认虚拟出 RNDIS USB网卡（从设备），当 NanoKVM
 
 若不使用 RNDIS 功能，可点击`设置`->`RNDIS`关闭。
 
+注: 2.1.5 版本后添加 ncm 方式接，但默认还是 RNDIS ，启用方式：`touch /boot/usb.ncm` 或在 /boot 分区下创建 usb.ncm 空文件
+
 ### ATX电源控制
 
 + 在悬浮栏右侧，有电源和硬盘图标，正常情况下是灰色状态，开机后电源图标变绿。
@@ -120,6 +122,13 @@ NanoKVM 的 USB 会默认虚拟出 RNDIS USB网卡（从设备），当 NanoKVM
 + 关于NanoKVM：点击打开Wiki
 + 检查更新：当有可用更新时，用户可点击更新，约15s左右，网页自动刷新重新登录即可更新完成。
 
+### 关于SSH
+
++ 2.1.5 版本应用后，SSH支持永久关闭和临时开启，方法如下：
+
+1. 永久关闭：执行`touch /etc/kvm/ssh_stop`即可在NanoKVM下一次开机时开始禁用ssh登录，删除该文件`rm /etc/kvm/ssh_stop`即可解除
+2. 临时开启：执行`touch /boot/start_ssh_once`或在 /boot 分区下创建 start_ssh_once 空文件，即可在NanoKVM下一次开机时打开ssh，该文件会自动删除
+
 ### 更多功能敬请期待
 
 ## 网络延迟测算

diff --git a/docs/hardware/zh/kvm/NanoKVM_PCIe/quick_start.md b/docs/hardware/zh/kvm/NanoKVM_PCIe/quick_start.md
@@ -37,7 +37,7 @@ NanoKVM-PCIe 包装内包含主机, 半高 PCIe 挡板, 两条 USBA-C线缆, 一
 
 注: NanoKVM-PCIe USB-PWR-IN CC 接口下拉5.1K电阻，可使用正规 PD 充电头供电。部分劣质PD电源存在烧坏 NanoKVM-PCIe 的风险。
 
-## 接线
+## 安装
 
 1. NanoKVM-PCIe 在接线上与 Cube 类似, 请在主机关机且断电的情况下安装 NanoKVM-PCIe, 测试功能全部正常后再装入机箱
 
@@ -63,6 +63,10 @@ NanoKVM-PCIe 包装内包含主机, 半高 PCIe 挡板, 两条 USBA-C线缆, 一
 
 ![](./../../../assets/NanoKVM/unbox/PCIe-Pin.jpg)
 
+注：NanoKVM-PCIe 不会监控HDD状态
+
+注：早期部分用户购买的NanoKVM-PCIe配套全高PCIe挡板在安装上可能存在过长的问题，请使用较长螺丝固定（注意不要太用力）或购买`外径7mm、内径4.2mm、高度3mm`规格的垫圈。若安装仍然存在困难，请联系淘宝/速卖通客服，或者[email protected]邮箱获取支持
+
 ## WiFi 配网
 
 + 此步骤仅适用于购买了带 WiFi 版本的 NanoKVM-PCIe, 其他版本会在 WiFi 图标位置显示 "--"

diff --git a/docs/hardware/zh/kvm/NanoKVM_PCIe/user_guide.md b/docs/hardware/zh/kvm/NanoKVM_PCIe/user_guide.md
@@ -112,6 +112,8 @@ NanoKVM 的 USB 会默认虚拟出 RNDIS USB网卡（从设备），当 NanoKVM
 
 若不使用 RNDIS 功能，可点击`设置`->`RNDIS`关闭。
 
+注: 2.1.5 版本后添加 ncm 方式接，但默认还是 RNDIS ，启用方式：`touch /boot/usb.ncm` 或在 /boot 分区下创建 usb.ncm 空文件
+
 ### ATX电源控制
 
 + 在悬浮栏右侧，有电源和硬盘图标，正常情况下是灰色状态，开机后电源图标变绿。
@@ -124,6 +126,13 @@ NanoKVM 的 USB 会默认虚拟出 RNDIS USB网卡（从设备），当 NanoKVM
 + 关于NanoKVM：点击打开Wiki
 + 检查更新：当有可用更新时，用户可点击更新，约15s左右，网页自动刷新重新登录即可更新完成。
 
+### 关于SSH
+
++ 2.1.5 版本应用后，SSH支持永久关闭和临时开启，方法如下：
+
+1. 永久关闭：执行`touch /etc/kvm/ssh_stop`即可在NanoKVM下一次开机时开始禁用ssh登录，删除该文件`rm /etc/kvm/ssh_stop`即可解除
+2. 临时开启：执行`touch /boot/start_ssh_once`或在 /boot 分区下创建 start_ssh_once 空文件，即可在NanoKVM下一次开机时打开ssh，该文件会自动删除
+
 ### 更多功能敬请期待
 
 ## 硬件与结构

diff --git a/docs/hardware/zh/kvm/NanoKVM_USB/faq.md b/docs/hardware/zh/kvm/NanoKVM_USB/faq.md
@@ -30,6 +30,12 @@ keywords: NanoKVM-USB, Lichee, PiKVM, RISCV, tool
 
 ### 若上述方法不能解决异常，请在论坛,GitHub或QQ群说明您购买的型号和遇到的问题，我们会耐心解答
 
+## 已知问题
+
+### 延迟：
+
++ ARM 版的 macOS 通过 NanoKVM-USB 连接树莓派时延迟会增大，其他组合则不受影响
+
 ## 反馈方式
 
 - [Github issues](https://github.com/sipeed/NanoKVM)