diff --git a/docs/hardware/assets/NanoKVM/flashing/flashed.png b/docs/hardware/assets/NanoKVM/flashing/flashed.png new file mode 100644 index 0000000000..1ea4e7ab36 Binary files /dev/null and b/docs/hardware/assets/NanoKVM/flashing/flashed.png differ diff --git a/docs/hardware/assets/NanoKVM/flashing/flashing.png b/docs/hardware/assets/NanoKVM/flashing/flashing.png new file mode 100644 index 0000000000..d4244de54b Binary files /dev/null and b/docs/hardware/assets/NanoKVM/flashing/flashing.png differ diff --git a/docs/hardware/assets/NanoKVM/flashing/run_etcher.png b/docs/hardware/assets/NanoKVM/flashing/run_etcher.png new file mode 100644 index 0000000000..3a808e359e Binary files /dev/null and b/docs/hardware/assets/NanoKVM/flashing/run_etcher.png differ diff --git a/docs/hardware/assets/NanoKVM/flashing/select_image.png b/docs/hardware/assets/NanoKVM/flashing/select_image.png new file mode 100644 index 0000000000..74d858ab4d Binary files /dev/null and b/docs/hardware/assets/NanoKVM/flashing/select_image.png differ diff --git a/docs/hardware/assets/NanoKVM/flashing/select_target.png b/docs/hardware/assets/NanoKVM/flashing/select_target.png new file mode 100644 index 0000000000..ae2e322587 Binary files /dev/null and b/docs/hardware/assets/NanoKVM/flashing/select_target.png differ diff --git a/docs/hardware/assets/NanoKVM/tailscale/connect.png b/docs/hardware/assets/NanoKVM/tailscale/connect.png new file mode 100644 index 0000000000..6f36ec9d14 Binary files /dev/null and b/docs/hardware/assets/NanoKVM/tailscale/connect.png differ diff --git a/docs/hardware/assets/NanoKVM/tailscale/install.png b/docs/hardware/assets/NanoKVM/tailscale/install.png new file mode 100644 index 0000000000..4d9967129a Binary files /dev/null and b/docs/hardware/assets/NanoKVM/tailscale/install.png differ diff --git a/docs/hardware/assets/NanoKVM/tailscale/login.png b/docs/hardware/assets/NanoKVM/tailscale/login.png new file mode 100644 index 0000000000..b1ab3b4139 Binary files /dev/null and b/docs/hardware/assets/NanoKVM/tailscale/login.png differ diff --git a/docs/hardware/assets/NanoKVM/tailscale/machines.png b/docs/hardware/assets/NanoKVM/tailscale/machines.png new file mode 100644 index 0000000000..6014354e8c Binary files /dev/null and b/docs/hardware/assets/NanoKVM/tailscale/machines.png differ diff --git a/docs/hardware/assets/NanoKVM/tailscale/setting.png b/docs/hardware/assets/NanoKVM/tailscale/setting.png new file mode 100644 index 0000000000..ad590d353f Binary files /dev/null and b/docs/hardware/assets/NanoKVM/tailscale/setting.png differ diff --git a/docs/hardware/assets/NanoKVM/updating/check_for_update.png b/docs/hardware/assets/NanoKVM/updating/check_for_update.png new file mode 100644 index 0000000000..c7849a015e Binary files /dev/null and b/docs/hardware/assets/NanoKVM/updating/check_for_update.png differ diff --git a/docs/hardware/assets/NanoKVM/updating/ifconfig.png b/docs/hardware/assets/NanoKVM/updating/ifconfig.png new file mode 100644 index 0000000000..0d1a8bd45f Binary files /dev/null and b/docs/hardware/assets/NanoKVM/updating/ifconfig.png differ diff --git a/docs/hardware/assets/NanoKVM/updating/ipconfig.png b/docs/hardware/assets/NanoKVM/updating/ipconfig.png new file mode 100644 index 0000000000..e29b68d6ed Binary files /dev/null and b/docs/hardware/assets/NanoKVM/updating/ipconfig.png differ diff --git a/docs/hardware/assets/NanoKVM/updating/login.png b/docs/hardware/assets/NanoKVM/updating/login.png new file mode 100644 index 0000000000..0b941363d9 Binary files /dev/null and b/docs/hardware/assets/NanoKVM/updating/login.png differ diff --git a/docs/hardware/assets/NanoKVM/updating/ssh.png b/docs/hardware/assets/NanoKVM/updating/ssh.png new file mode 100644 index 0000000000..f69e08c53e Binary files /dev/null and b/docs/hardware/assets/NanoKVM/updating/ssh.png differ diff --git a/docs/hardware/assets/NanoKVM/updating/update.png b/docs/hardware/assets/NanoKVM/updating/update.png new file mode 100644 index 0000000000..9fda9895bb Binary files /dev/null and b/docs/hardware/assets/NanoKVM/updating/update.png differ diff --git a/docs/hardware/zh/kvm/NanoKVM/4_firmware.md b/docs/hardware/zh/kvm/NanoKVM/4_firmware.md deleted file mode 100644 index 86997679ff..0000000000 --- a/docs/hardware/zh/kvm/NanoKVM/4_firmware.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Firmware -keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool -update: - - date: 2024-6-21 - version: v0.1 - author: BuGu - content: - - Release docs ---- - -## 镜像烧录与升级 - -NanoKVM 有两种升级模式，一种是常规的应用升级，在浏览器操作即可；若功能涉及到底层镜像修改则需重新烧卡。 - -### 应用升级 - -在浏览器页面内点击设置->检查更新->立即更新 -等待约10s后，OLED重新刷出KVM状态信息，刷新网页，即可完成更新 - -### 镜像烧录 - -Lite版NanoKVM默认不带TF卡出货，需要自行准备一张8G以上的TF卡（Full版默认带一张32G TF卡，超出8G的部分将自动创建exFAT分区，用于虚拟U盘的挂载） - -Full版NanoKVM自带TF卡，可上电即用，如后续涉及到镜像升级，同样可以参考以下描述 - -使用烧卡软件烧录TF卡，这里建议使用[Etcher](https://etcher.balena.io/)进行烧录 - -镜像下载地址:https://github.com/sipeed/NanoKVM/releases/tag/NanoKVM \ No newline at end of file diff --git a/docs/hardware/zh/kvm/NanoKVM/5_faq.md b/docs/hardware/zh/kvm/NanoKVM/faq.md similarity index 100% rename from docs/hardware/zh/kvm/NanoKVM/5_faq.md rename to docs/hardware/zh/kvm/NanoKVM/faq.md diff --git a/docs/hardware/zh/kvm/NanoKVM/1_intro.md b/docs/hardware/zh/kvm/NanoKVM/introduction.md similarity index 93% rename from docs/hardware/zh/kvm/NanoKVM/1_intro.md rename to docs/hardware/zh/kvm/NanoKVM/introduction.md index 5dc66f3c0d..b68581c7c6 100644 --- a/docs/hardware/zh/kvm/NanoKVM/1_intro.md +++ b/docs/hardware/zh/kvm/NanoKVM/introduction.md @@ -54,7 +54,6 @@ NanoKVM Full 为完整版配置，带精致外壳和完整配件，内置开机 ![](./../assets/NanoKVM/1_intro/NanoKVM_2.jpg) - ## NanoKVM 软硬件资料 NanoKVM 基于 Sipeed [LicheeRV Nano](https://wiki.sipeed.com/hardware/zh/lichee/RV_Nano/1_intro.html) 核心板搭建，这部分硬件的规格书、原理图、尺寸图等均可在这里找到：[点击这里](http://cn.dl.sipeed.com/shareURL/LICHEE/LicheeRV_Nano) @@ -63,9 +62,9 @@ NanoKVM Lite 由 LicheeRV Nano E 和 HDMItoCSI 小板构成，NanoKVM FULL 在 N NanoKVM 镜像在LicheeRV Nano SDK 和 MaixCDK 基础上构建，可以兼容使用 LicheeRV Nano 的资料，反之LicheeRV Nano 或其他 SG2002 产品无法使用KVM软件。如果您想在 NanoKVM 上构建 HDMI 输入相关应用，请与我们联系，以获得技术支持。 -+ [NanoKVM-A 原理图](https://cn.dl.sipeed.com/fileList/KVM/nanoKVM/HDK/02_Schematic/SCH_RV_Nano_KVM_A_30111.pdf) -+ [NanoKVM-B 原理图](https://cn.dl.sipeed.com/fileList/KVM/nanoKVM/HDK/02_Schematic/SCH_HDMI_MIPI_31011.pdf) -+ [NanoKVM 镜像下载](https://github.com/sipeed/NanoKVM/releases/tag/NanoKVM) ++ [NanoKVM-A 原理图](https://dl.sipeed.com/fileList/KVM/nanoKVM/HDK/02_Schematic/SCH_RV_Nano_KVM_A_30111.pdf) ++ [NanoKVM-B 原理图](https://dl.sipeed.com/fileList/KVM/nanoKVM/HDK/02_Schematic/SCH_HDMI_MIPI_31011.pdf) ++ [NanoKVM 镜像下载](https://github.com/sipeed/NanoKVM/releases) ## 购买入口 @@ -77,7 +76,6 @@ NanoKVM 镜像在LicheeRV Nano SDK 和 MaixCDK 基础上构建，可以兼容使 如果您在使用过程中有任何问题或建议，请通过以下渠道和我们反馈： -+ [Github issues](https://github.com/sipeed/NanoKVM) ++ [Github issues](https://github.com/sipeed/NanoKVM) + [MaixHub 论坛](https://maixhub.com/discussion/nanokvm) + QQ 交流群: 703230713 - diff --git a/docs/hardware/zh/kvm/NanoKVM/network/frp.md b/docs/hardware/zh/kvm/NanoKVM/network/frp.md new file mode 100644 index 0000000000..6006aa8845 --- /dev/null +++ b/docs/hardware/zh/kvm/NanoKVM/network/frp.md @@ -0,0 +1,123 @@ +--- +title: frp +keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool +update: + - date: 2024-8-13 + version: v0.1 + author: xwj + content: + - Release docs +--- + +> 注意，直接在公网暴露服务十分危险！建议配置 HTTPS 后使用。 + +想要使用 frp，你需要自己编写配置文件，可以参考 [frp 文档](https://gofrp.org)。 + +这里给出一个示例，实现通过 frp [访问内网的 web 服务](https://gofrp.org/zh-cn/docs/examples/vhost-http/) + +## 启动 frps 服务 + +首先你需要一台带有公网 IP 的服务器，然后在该服务上启动 frps 服务。 +这里我们假设该服务器 IP 地址为 `20.190.1.1`。你可以将这个 IP 替换为你自己的公网 IP。 + +1. 下载 [frp](https://github.com/fatedier/frp/releases/download/v0.59.0/frp_0.59.0_linux_riscv64.tar.gzf) 并解压，解压完成后进入该文件夹： + + ```bash + wget https://github.com/fatedier/frp/releases/download/v0.59.0/frp_0.59.0_linux_riscv64.tar.gz + tar -xzvf frp_0.59.0_linux_amd64.tar.gz + cd frp_0.59.0_linux_amd64 + ``` + +1. 创建配置文件 `frps.yaml`： + + ```yaml + bindPort: 7000 + vhostHTTPPort: 8080 + ``` + +1. 运行 frps 服务： + + ```bash + ./frps -c frps.yaml + ``` + +## 启动 frpc 服务 + +1. 通过 SSH 登录到 NanoKVM； +1. 执行 `frpc -v` 查看版本号，如果没有输出，则需要手动安装 frpc； + - 下载 [frp](https://github.com/fatedier/frp/releases/download/v0.59.0/frp_0.59.0_linux_riscv64.tar.gzf) 并解压； + - 将 `frpc` 文件移动到 `/usr/bin/` 目录 + +1. 创建配置文件 `/etc/kvm/frpc.yaml` ： + + ```yaml + serverAddr: 20.190.1.1 # 你的公网 IP + serverPort: 7000 + proxies: + - name: nanokvm + type: http + localPort: 80 + customDomains: + - 20.190.1.1 + ``` + +1. 启动 frpc 服务： + + ```bash + frpc -c /etc/kvm/frpc.yaml + ``` + +frps 和 frpc 服务都启动后，在浏览器中输入 `20.190.1.1:8080`，就可以在公网中访问到 NanoKVM 了。 + +## 配置域名 + +如果你想给 NanoKVM 配置一个域名，可以修改 `frpc.yaml` 文件： + +```yaml +serverAddr: 20.190.1.1 # 你的公网 IP +serverPort: 7000 +proxies: + - name: nanokvm + type: http + localPort: 80 + customDomains: + - www.yourdomain.com # 你的域名 +``` + +然后将域名 [`www.yourdomain.com`](http://www.yourdomain.com) 解析到 `20.190.1.1`。 + +使用浏览器打开 [`http://www.yourdomain.com:8080`](http://www.yourdomain.com:8080/) 即可访问到 `NanoKVM`。 + +## 配置 HTTPS + +可参考 frp 文档：[为本地 HTTP 服务启用 HTTPS](https://gofrp.org/zh-cn/docs/examples/https2http/)。 + +1. 配置 `frps.yaml` 文件： + + ```yaml + bindPort: 7000 + vhostHTTPSPort: 443 + ``` + +1. 配置 `frpc.yaml` 文件 + + ```yaml + serverAddr: 20.190.1.1 # 你的公网 IP + serverPort: 7000 + proxies: + - name: nanokvm + type: https + customDomains: + - yourdomain.com # 你的域名 + plugin: + type: https2http + localAddr: 127.0.0.1:80 + crtPath: ./server.crt # 证书路径 + keyPath: ./server.key # 私钥路径 + hostHeaderRewrite: 127.0.0.1 + requestHeaders: + set: + x-from-where: frp + ``` + +1. 分别启动 frps 和 frpc 服务，然后在浏览器中访问 [`https://yourdomain.com`](https://yourdomain.com) 即可 diff --git a/docs/hardware/zh/kvm/NanoKVM/network/static_ip.md b/docs/hardware/zh/kvm/NanoKVM/network/static_ip.md new file mode 100644 index 0000000000..c417b871d4 --- /dev/null +++ b/docs/hardware/zh/kvm/NanoKVM/network/static_ip.md @@ -0,0 +1,39 @@ +--- +title: 静态 IP +keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool +update: + - date: 2024-8-13 + version: v0.1 + author: xwj + content: + - Release docs +--- + +NanoKVM 默认通过 DHCP 获取 IP，这意味着 NanoKVM 的 IP 可能会发生变化。 + +如果你希望始终使用同一个 IP 来访问 NanoKVM，可以给 NanoKVM 设置一个静态 IP。 + +## 设置静态 IP + +在 NanoKVM 中创建文件 `/boot/eth.nodhcp` ，然后按照以下规则进行编辑： + +- 一行就是一个自定义 IP，格式为 `addr/netid gw[optional]` ； +- 可以分多行来预设多个静态 IP。 + +```bash +# 示例 +192.168.0.101/24 192.168.0.1 # addr/netid gw +192.168.3.116/22 # addr/netid +``` + +编辑并保存该文件后，执行 `/etc/init.d/S30eth restart` 命令使配置文件生效。 + +**注意**，如果所有预设的静态 IP 地址都被 arp 检测到已占用，则静态 IP 会设置失败。 +此时会触发 DHCP 来获取 IP 地址。如果仍然获取失败，则会将 IP 强制设置成 `192.168.90.1/24`。 + +这是为了保证 NanoKVM 总有一个可用的 IP 地址，以便能通过网络来操作 NanoKVM。 +如果 NanoKVM 没有分配到可用的 IP 地址，则需要手动修改 TF 卡中的文件，或者重新烧录镜像才能正常使用。 + +## 取消静态 IP + +删除 `/boot/eth.nodhcp` 文件，即可取消静态 IP。NanoKVM 会重新通过 DHCP 来获取 IP。 diff --git a/docs/hardware/zh/kvm/NanoKVM/network/tailscale.md b/docs/hardware/zh/kvm/NanoKVM/network/tailscale.md new file mode 100644 index 0000000000..7f7fb081fa --- /dev/null +++ b/docs/hardware/zh/kvm/NanoKVM/network/tailscale.md @@ -0,0 +1,54 @@ +--- +title: Tailscale +keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool +update: + - date: 2024-8-13 + version: v0.1 + author: xwj + content: + - Release docs +--- + + +> **推荐将 NanoKVM 与 Tailscale 配合使用，来实现公网访问远程主机的目的。** + +*注意：v1.0.0 版本的镜像不支持 Tailscale。如果你的 NanoKVM 镜像版本是 v1.0.0，请先[更新镜像](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/start/flashing.html)。* + +目前 NanoKVM 已经内置了 Tailscale，只需要简单的操作即可开始使用。 +有两种配置 Tailscale 的方式：在浏览器中配置和在终端中配置。 +推荐在浏览器中进行配置。如果你需要更多的自定义功能，也可以在终端中进行配置。 + +## 在浏览器中配置 + +1. 在浏览器中输入 NanoKVM 的 IP 并访问； +1. 点击设置 - Tailscale： + + ![ipconfig](../../../../assets/NanoKVM/tailscale/setting.png) + +1. 如果提示 Tailscale 未安装，请点击安装，并等待安装完成。如果显示已安装，则进行下一步： + + ![ipconfig](../../../../assets/NanoKVM/tailscale/install.png) + +1. 点击登录，等待 Tailscale 启动并生成登录链接（该操作只需要执行一次，Tailscale 会开机自启）： + + ![ipconfig](../../../../assets/NanoKVM/tailscale/login.png) + +1. 登录链接生成后，浏览器会自动打开该链接。如果未自动跳转，请手动访问生成的链接。然后登录 Tailscale 账号，并点击 `Connect` 将 NanoKVM 加入到你的账号。 + + ![ipconfig](../../../../assets/NanoKVM/tailscale/connect.png) + +1. 现在可以在你的 Tailscale 账号下看到 NanoKVM 了。在公网环境中，运行 Tailscale，然后在浏览器中访问 `100.79.236.88 (替换为你的 Tailscale IP)`即可： + + ![ipconfig](../../../../assets/NanoKVM/tailscale/machines.png) + +## 在终端中配置 + +1. 通过 SSH 登录到 NanoKVM； +2. 执行 `tailscale version` 检查 tailscale 是否已经安装。如果未安装，则手动进行安装： + - 下载 [Tailscale](https://pkgs.tailscale.com/stable/tailscale_latest_riscv64.tgz) 并解压； + - 将 `tailscale` 文件移动到 `/usr/bin/` 目录； + - 将 `tailscaled` 文件移动到 `/usr/sbin/` 目录。 +3. 执行 `/etc/init.d/S98tailscaled restart` ，启动 tailscale 服务； +4. 执行 `tailscale login` ，等待登录链接生成，然后在浏览器中访问生成的链接； +5. 在浏览器中点击 `Connect` ，将 NanoKVM 加入到你的 Tailscale 账户； +6. 操作完成！现在就可以通过 Tailscale 访问 NanoKVM 了。 diff --git a/docs/hardware/zh/kvm/NanoKVM/2_unbox.md b/docs/hardware/zh/kvm/NanoKVM/quick_start.md similarity index 80% rename from docs/hardware/zh/kvm/NanoKVM/2_unbox.md rename to docs/hardware/zh/kvm/NanoKVM/quick_start.md index 0d9fa0ea34..366dd748bb 100644 --- a/docs/hardware/zh/kvm/NanoKVM/2_unbox.md +++ b/docs/hardware/zh/kvm/NanoKVM/quick_start.md @@ -1,5 +1,5 @@ --- -title: 快速开始 +title: 快速上手 keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool update: - date: 2024-7-4 @@ -15,8 +15,6 @@ update: Full版包含 NanoKVM（带外壳，带卡）、KVM-B板、USB A to C 线 *2、杜邦线。 - - Lite版包含 NanoKVM（不带外壳和TF卡） 、散热片。 ## 接口介绍 @@ -43,9 +41,23 @@ NanoKVM-Full版接口示意图如下，Lite版仅包含 USB-C、HDMI和网口， ![](./../assets/NanoKVM/2_unbox/unbox_2.png) -## 基础操作 +## 更新 + +### 更新镜像 + +> **Lite 版本需要准备 TF 卡并且烧录镜像后才能开始使用！** + +Full 版本出厂时已经烧录了镜像，可以跳过此步骤。 -### Lite用户烧卡请参考[烧卡方法](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/3_firmware.html) +镜像会不定期更新。建议更新到最新版本镜像，以获取更好的使用体验。 + +具体操作方式请参考 [烧录镜像](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/system/flashing.html)。 + +### 更新应用 + +目前应用还处于快速迭代阶段，使用前请先将应用更新到最新版本。具体操作方式请参考 [更新应用](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/system/updating.html)。 + +## 基础操作 ### 如何获取IP地址 @@ -55,9 +67,9 @@ Full版NanoKVM自带OLED显示屏，联网之后会在显示屏第一行显示IP Lite版用户在插入镜像卡启动后，可在路由器/交换机后台查看IP。用户也可按照[LicheeRV NANO](https://wiki.sipeed.com/hardware/zh/lichee/RV_Nano/5_peripheral.html#usb-rndis-%E7%BD%91%E5%8F%A3)的联网方式登录到板子，使用`ifconfig`查看`eth0`的地址 -### 更新应用，查看远程桌面 +### 查看远程桌面 -浏览器直接输入获取的IP，进入登录页面，默认账号密码为admin、admin，登录后请**先检查更新**（设置 -> 检查更新），详细步骤可参考[应用升级方法](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/4_firmware.html)。 +浏览器直接输入获取的IP，进入登录页面，默认账号密码为admin、admin，登录后请**先检查更新**（设置 -> 检查更新），详细步骤可参考 [更新应用](https://wiki.sipeed.com/hardware/zh/kvm/NanoKVM/system/updating.html)。 Lite版用户，或Full用户重新烧卡登录后页面上无远程画面，请先升级应用后刷新网页，即可开始使用 diff --git a/docs/hardware/zh/kvm/NanoKVM/system/configuration.md b/docs/hardware/zh/kvm/NanoKVM/system/configuration.md new file mode 100644 index 0000000000..9ea5269cf3 --- /dev/null +++ b/docs/hardware/zh/kvm/NanoKVM/system/configuration.md @@ -0,0 +1,38 @@ +--- +title: 配置文件 +keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool +update: + - date: 2024-8-13 + version: v0.1 + author: xwj + content: + - Release docs +--- + + +配置文件的路径为 `/etc/kvm/server.yaml`。 + +默认的配置文件内容： + +```yaml +protocol: http +port: + http: 80 + https: 443 +cert: + crt: server.crt + key: server.key +``` + +- protocol：网络协议，`http` 或 `https` +- port：服务运行的端口 + - 当 protocol 为 http 时，服务会使用 port.http 端口 + - 当 protocol 为 https 时，服务会使用 port.https 端口 + - 当 protocol 为 https 时，在浏览器中访问时需要加上 `https://` 前缀 (例如：`https://192.168.1.210`） + - 如果你修改了端口，在浏览器中访问时请加上该端口。例如修改 port.http 为 8080，则在浏览器中的访问地址为 `192.168.1.210:8080` + - 请勿将端口设置为 0。服务检测到端口为 0 时，会使用默认配置覆盖当前配置文件 +- cert：服务证书。如果 protocol 设置为 https，则需要配置该参数 + - crt：证书文件的路径 + - key：私钥文件的路径 + +注意，开启 https 后会增加 cpu 占用，可能会导致画面卡顿。 diff --git a/docs/hardware/zh/kvm/NanoKVM/system/flashing.md b/docs/hardware/zh/kvm/NanoKVM/system/flashing.md new file mode 100644 index 0000000000..ad6a9c7bf2 --- /dev/null +++ b/docs/hardware/zh/kvm/NanoKVM/system/flashing.md @@ -0,0 +1,44 @@ +--- +title: 烧录系统 +keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool +update: + - date: 2024-8-13 + version: v0.1 + author: xwj + content: + - Release docs +--- + +*NanoKVM Full 版本出厂时已经烧录了镜像，可以选择跳过该步骤。* + +1. 准备 SD 卡： + + - Full 版本自带一张 32G 的 SD 卡，需要拆开外壳将其取出； + - Lite 版本需要自己准备一张 8G 以上的 SD 卡。 + +1. 前往 [Github](https://github.com/sipeed/NanoKVM/releases) 下载最新版本镜像。 + +1. 安装烧录软件，推荐使用 [Etcher](https://etcher.balena.io)。 + +1. 运行 Etcher： + ![run Ethcer](../../../../assets/NanoKVM/flashing/run_etcher.png) + +1. 点击 `Flash from file`，选择镜像文件： + + ![select image](../../../../assets/NanoKVM/flashing/select_image.png) + +1. 点击 `Select target`，选择 SD 卡： + + ![select target](../../../../assets/NanoKVM/flashing/select_target.png) + +1. 点击 `Flash!`，开始烧录： + + ![select target](../../../../assets/NanoKVM/flashing/flashing.png) + +1. 等待镜像烧录完成。 + + ![select target](../../../../assets/NanoKVM/flashing/flashed.png) + +恭喜！镜像烧录完成！ + +现在，你可以将 SD 卡装到 NanoKVM 上，然后进行下一步的操作了。 diff --git a/docs/hardware/zh/kvm/NanoKVM/system/introduction.md b/docs/hardware/zh/kvm/NanoKVM/system/introduction.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/docs/hardware/zh/kvm/NanoKVM/system/updating.md b/docs/hardware/zh/kvm/NanoKVM/system/updating.md new file mode 100644 index 0000000000..ad73a7c3b6 --- /dev/null +++ b/docs/hardware/zh/kvm/NanoKVM/system/updating.md @@ -0,0 +1,75 @@ +--- +title: 更新应用 +keywords: NanoKVM, Remote desktop, Lichee, PiKVM, RISCV, tool +update: + - date: 2024-8-13 + version: v0.1 + author: xwj + content: + - Release docs +--- + +## 开机 + +1. 使用网线连接 NanoKVM 的有线网口； +2. 使用标准尺寸的 HDMI 线，连接远程主机和 NanoKVM 的 HDMI 接口； +3. 使用 USB C to A 的数据线，连接远程主机和 NanoKVM 的 PC USB 接口。 + +接好线之后， NanoKVM 就会自动开机。开机启动需要等待一到两分钟。 + +## 获取 IP + +NanoKVM Full 版本在开机启动后，屏幕上会自动显示 IP，可以跳过此步骤。 +NanoKVM Lite 版本可以通过以下方式获取 IP。 + +### 在路由器或交换机上查看 + +NanoKVM 启动后会通过 DHCP 获取 IP。可以在路由器或交换机上找到 NanoKVM 分配的 IP。 + +### 通过串口查看 + +使用串口工具连接 NanoKVM 后获取其 IP。 + +### 通过 usb rndis 网口获取 + +> 如果远程主机是 Windows 系统，请先参考 [usb rndis 网口](https://wiki.sipeed.com/hardware/zh/lichee/RV_Nano/5_peripheral.html#usb-rndis-网口) 安装驱动 + +1. 在远程主机中打开终端软件； +1. 执行 `ifconfig` （在 Windows 系统中是 `ipconfig`）命令； +1. 在显示的网络列表中找到 IPv4 地址为 10 开头的网址，示例如下： + + ![ipconfig](../../../../assets/NanoKVM/updating/ipconfig.png) + +1. 通过 SSH 登录 NanoKVM：`ssh root@10.223.155.1` （注意，不是 10.223.155.100），密码为 `root` ： + + ![ipconfig](../../../../assets/NanoKVM/updating/ssh.png) + +1. 进入 NanoKVM 后，执行 `ifconfig` ，从网络列表中找到 `eth0` 网卡的地址，该地址就是 NanoKVM 的 IP： + + ![ipconfig](../../../../assets/NanoKVM/updating/ifconfig.png) + +1. 获取到 IP 后，接下来就可以通过该 IP 访问 NanoKVM 了。 + +## 检查更新 + +1. 使用任意电脑，连接到与 NanoKVM 相同的网络； +1. 打开浏览器（推荐使用 Chrome），在地址栏中输入刚刚获取到的 IP 并访问； +1. 浏览器会进入一个登录页面，输入默认账号 `admin` 和默认密码 `admin` 进行登录; + + ![ipconfig](../../../../assets/NanoKVM/updating/login.png) + +1. 登录成功后，点击检查更新： + + ![ipconfig](../../../../assets/NanoKVM/updating/check_for_update.png) + +1. 如果有更新，则点击开始更新： + + ![ipconfig](../../../../assets/NanoKVM/updating/update.png) + +1. 等待应用更新完成后，浏览器会自动刷新并重新进入登录页面，再次登录即可。 + +## 更新完成 + +大功告成！ +现在镜像和应用都已经更新到了最新版本。 +只要在浏览器中输入 NanoKVM 的 IP 地址，就可开始操控远程主机了。 diff --git a/docs/hardware/zh/kvm/NanoKVM/3_user_guide.md b/docs/hardware/zh/kvm/NanoKVM/user_guide.md similarity index 94% rename from docs/hardware/zh/kvm/NanoKVM/3_user_guide.md rename to docs/hardware/zh/kvm/NanoKVM/user_guide.md index 8ad9c402e4..34fdcc2f7d 100644 --- a/docs/hardware/zh/kvm/NanoKVM/3_user_guide.md +++ b/docs/hardware/zh/kvm/NanoKVM/user_guide.md @@ -11,7 +11,7 @@ update: ## 管理页面功能 -![](./../assets/NanoKVM/3_user_guide/user1.png) +![](../../assets/NanoKVM/3_user_guide/user1.png) 悬浮栏从左到右依次为：图像设置、屏幕键盘、鼠标样式、镜像挂载、KVM网页终端、开机按钮、电源/HDD状态指示、设置、全屏、隐藏悬浮栏。 @@ -24,14 +24,14 @@ update: + 图像质量选项可以修改画面的压缩比例，当您认为画面较卡，延迟较高时，可以适当调低图像质量。 -![](./../assets/NanoKVM/3_user_guide/user2.png) +![](../../assets/NanoKVM/3_user_guide/user2.png) ### 虚拟键鼠使用 + NanoKVM 的 USB 接口模拟出了键鼠设备。打开浏览器页面后，系统将自动捕获键鼠输入，并将操作实时同步到 NanoKVM 连接的主机。用户可以选择隐藏鼠标或改变在画面上显示的样式。 + 对于不方便使用键盘的用户，我们提供了屏幕键盘，点击悬浮栏的键盘图标即可唤出屏幕键盘。 -![](./../assets/NanoKVM/3_user_guide/user3.png) +![](../../assets/NanoKVM/3_user_guide/user3.png) ### ISO镜像挂载 @@ -41,7 +41,7 @@ update: 按上述步骤连接远程主机与Nano KVM，在浏览器登录系统后，点击光盘图标，选中待安装的系统，即可实现ISO挂载 -![](./../assets/NanoKVM/2_unbox/unbox_7.png) +![](../../assets/NanoKVM/2_unbox/unbox_7.png) 注： @@ -53,8 +53,7 @@ update: + 用户点击悬浮栏的`Terminal`图标，即可打开网页终端，无需ssh直接访问 NanoKVM 系统 + 当 NanoKVM 断网重连或系统重启后，网页终端界面会提示重新登录，账号`root`，密码`root` -![](./../assets/NanoKVM/3_user_guide/user4.png) - +![](../../assets/NanoKVM/3_user_guide/user4.png) ### 电源灯，HDD灯 @@ -76,7 +75,7 @@ update: NanoKVM 基于 LicheeRV Nano 构建，RVNano 核心板共有3个串口，UART0默认用于输出系统log，在 NanoKVM Full 版中，引出了 UART1/2，用户可自行拓展功能（第一批内测版仅在外壳处开孔） -![](./../assets/NanoKVM/1_intro/NanoKVM_2.jpg) +![](../../assets/NanoKVM/1_intro/NanoKVM_2.jpg) 点击管理页面的`Terminal`打开网页终端 @@ -117,8 +116,7 @@ Todo 2. 如果上述方式无法恢复正常，点击界面上的检查更新，更新应用 + 更新过程中如果出现断网等异常情况，可能导致更新失败，若旧应用也无法启动时，请参照以下解决方法： 1. 使用 SSH 连接 NanoKVM，如 `ssh root@192.168.1.2`，密码为 `root` - 2. 执行 `rm -r /kvmapp && cp -r /root/old/ / && mv /old /kvmapp` + 2. 执行 `rm -r /kvmapp && cp -r /root/old/ / && mv /old /kvmapp` 3. 执行 `reboot` 重启系统 + 尝试断电重启解决未知问题 + 若上述方法不能解决异常，请在论坛或QQ群提出您的问题，我们会耐心解答 - diff --git a/docs/hardware/zh/maixIV/m4ndock/quick-start.md b/docs/hardware/zh/maixIV/m4ndock/quick-start.md index bde239f8c9..0b70424dfa 100644 --- a/docs/hardware/zh/maixIV/m4ndock/quick-start.md +++ b/docs/hardware/zh/maixIV/m4ndock/quick-start.md @@ -76,7 +76,7 @@ apt install cmake 原始代码由爱芯官方开源于 GITHUB：[CLIP-ONNX-AX650-CPP](https://github.com/AXERA-TECH/CLIP-ONNX-AX650-CPP) -https://github.com/sipeed/sipeed_wiki/assets/13964381/df4cec7f-29af-465f-bfad-e54312274437 +[DEMO VIDEO](https://github.com/sipeed/sipeed_wiki/assets/13964381/df4cec7f-29af-465f-bfad-e54312274437) 准备 QT 运行环境 ``` @@ -85,7 +85,7 @@ apt install cmake qt6-base-dev ``` 下载预编译好的可执行文件、模型文件、测试图片、测试文本 -- [Baidu Pan](https://pan.baidu.com/s/1E0aR4OzTdqV90r002hNhLg?pwd=i3jp) +- [Baidu Pan](https://pan.baidu.com/s/17M5ugUyuf9mbi1cHLGJHXg) 将下载获得的 *CLIP.zip* 在 `/root/Desktop/` 路径下解压得到以下内容 ``` diff --git a/docs/hardware/zh/sidebar.yaml b/docs/hardware/zh/sidebar.yaml index 64fc31eb41..811b15ec3e 100644 --- a/docs/hardware/zh/sidebar.yaml +++ b/docs/hardware/zh/sidebar.yaml @@ -409,15 +409,31 @@ items: - label: Lichee Nano KVM items: - label: 简介 - file: kvm/NanoKVM/1_intro.md - - label: 快速开始 - file: kvm/NanoKVM/2_unbox.md + file: kvm/NanoKVM/introduction.md + - label: 快速上手 + file: kvm/NanoKVM/quick_start.md - label: 用户指南 - file: kvm/NanoKVM/3_user_guide.md - - label: 应用更新&固件烧录 - file: kvm/NanoKVM/4_firmware.md + file: kvm/NanoKVM/user_guide.md + - label: 网络 + items: + - label: Tailscale + file: kvm/NanoKVM/network/tailscale.md + - label: frp + file: kvm/NanoKVM/network/frp.md + - label: 静态 IP + file: kvm/NanoKVM/network/static_ip.md + - label: 系统 + items: + - label: 系统介绍 + file: kvm/NanoKVM/system/introduction.md + - label: 烧录镜像 + file: kvm/NanoKVM/system/flashing.md + - label: 更新应用 + file: kvm/NanoKVM/system/updating.md + - label: 配置文件 + file: kvm/NanoKVM/system/configuration.md - label: FAQ - file: kvm/NanoKVM/5_faq.md + file: kvm/NanoKVM/faq.md # - label: Maix Audio # items: # - label: MA USB 16 diff --git a/layout/home.html b/layout/home.html index df520e2e8f..0a2f6dec5b 100644 --- a/layout/home.html +++ b/layout/home.html @@ -89,19 +89,6 @@ const data = { head: [ // 图片分辨率为： 1800x600， 左右两边各留 200px 不包含实际内容只有背景，中间 1400px 是内容 - { - img: "/static/home/banner_2024_diansai.jpg", - btns: [ - { - lable: "QQ群: 750799296", - link: "https://qm.qq.com/cgi-bin/qm/qr?k=EzTCNLqzBYJ0X4y0rwFylmXV9TQmG96_&jump_from=webapi&authKey=Tqb1ox3yxcfS4x17y/qekgh35tB6bTs4a4slbdOUrzR4MO0uBeOckKFXX6rKhZ5F", - }, - { - lable: "{{_('淘宝')}}", - link: "{{_('https://sipeed.taobao.com')}}", - }, - ], - }, { img: "{{_('/static/home/banner_maixcam.jpg')}}", btns: [ diff --git a/pages/index/zh/nanokvm.html b/pages/index/zh/nanokvm.html index 84ceea6fe5..57605029e3 100644 --- a/pages/index/zh/nanokvm.html +++ b/pages/index/zh/nanokvm.html @@ -2,14 +2,13 @@ var hash = window.location.hash var url_language = "zh" - if( navigator.language.indexOf("zh") == -1 ) - { + if (navigator.language.indexOf("zh") == -1) { url_language = "en" } switch (window.location.hash) { - case "#shell" : - default : - location.href = window.location.origin + "/hardware/" + url_language + "/kvm/NanoKVM/1_intro.html" + case "#shell": + default: + location.href = window.location.origin + "/hardware/" + url_language + "/kvm/NanoKVM/introduction.html" } - + \ No newline at end of file