Administrator/NANOKVM-sipeed_wiki-MIRROR
1
0
Fork 0
mirror of https://github.com/sipeed/sipeed_wiki.git synced 2026-09-11 00:22:49 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs(nanokvm-go): scaffold wiki structure (#985)

Browse Source
This commit is contained in:
liang ziyue
2026-07-13 10:43:57 +08:00
committed by GitHub
parent 5e1d56401e
commit 3a5cba65b5
22 changed files with 394 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/hardware/en/kvm/NanoKVM_Go/development/development.md Normal file
View File

@@ -0,0 +1,4 @@
---
title: Development
keywords: NanoKVM Go, development
---

0
docs/hardware/en/kvm/NanoKVM_Go/faq.md Normal file
View File

154
docs/hardware/en/kvm/NanoKVM_Go/network/Tailscale.md Normal file
View File

@@ -0,0 +1,154 @@
---
title: Tailscale
keywords: Tailscale, remote access, NAT traversal
update:
- date: 2026-07-13
version: v0.1
author: Liang Ziyue
---
# Tailscale
## 1. Introduction to Tailscale
Tailscale is a WireGuard-based mesh networking tool. It can add NanoKVM Go, computers, phones, and other devices to the same virtual LAN, allowing you to access NanoKVM Go remotely without a public IP address or router port forwarding.
After joining a Tailscale network, each device receives a virtual IP address in the `100.x.x.x` range. As long as the client device and NanoKVM Go are in the same Tailscale network (Tailnet), you can access NanoKVM Go through this address.
```text
NanoKVM Go -- Tailscale virtual network -- remote computer or phone
```
> This guide focuses on configuring Tailscale through the web interface to access NanoKVM Go remotely.
## 2. Prerequisites
Before starting, make sure that:
- NanoKVM Go is connected to the Internet;
- NanoKVM Go is accessible from the local network;
- the NanoKVM Go system and application versions support Tailscale;
- the computer or phone used for remote access can install the Tailscale client.
<!-- TODO: Add the minimum version requirements and instructions for checking the version. -->
## 3. Register and Log In to Tailscale
NanoKVM Go and the computer or phone used for remote access must join the same Tailscale network (Tailnet). If this is your first time using Tailscale:
1. Visit the [Tailscale website](https://tailscale.com/);
2. Click `Get Started` or `Log in`;
3. Sign in using one of the supported account providers;
4. Follow the prompts to complete the initial authorization;
5. Open the Tailscale admin console and locate the `Machines` device list.
The `Machines` page is used to view and manage devices in the current Tailnet. After completing the following configuration, both NanoKVM Go and the client device will appear on this page.
<!-- TODO: Add screenshots of the Tailscale login page, account provider selection, and Machines page. -->
> Tailscale plans, organization management, and advanced network settings are not required for basic remote access and are not covered in this guide.
## 4. Enable Tailscale on NanoKVM Go
### 4.1 Open the Tailscale Settings
<!-- TODO: Add instructions and screenshots for opening the NanoKVM Go settings page. -->
### 4.2 Install or Start Tailscale
<!-- TODO: Add the location of the install/start button and the page status after installation. -->
### 4.3 Log In to Tailscale
<!-- TODO: Add instructions and screenshots for obtaining the login link, signing in, and clicking Connect to authorize the device. -->
### 4.4 Confirm That NanoKVM Go Is Online
<!-- TODO: Add the interface shown after login and explain how to verify the online status. -->
## 5. Install and Log In to Tailscale on the Client Device
Install Tailscale on the computer or phone that will remotely access NanoKVM Go:
1. Download and install the client from an official Tailscale channel;
2. Start Tailscale and click `Log in`;
3. Sign in with the same account used during registration;
4. Confirm that the client shows a connected status;
5. Check that NanoKVM Go appears in the device list.
If you use a different account, make sure that account has been invited to the Tailnet containing NanoKVM Go.
| Platform | Installation method |
| --- | --- |
| Windows | Download the installer from the Tailscale website |
| macOS | Install from the Tailscale website or the App Store |
| Linux | Use the official installation script or package repository |
| Android | Install from Google Play or another official channel |
| iOS / iPadOS | Install from the App Store |
<!-- TODO: Using Windows as an example, add screenshots for downloading, installing, logging in, and confirming a successful connection. Also add official links for each platform. -->
## 6. Find the Tailscale IP Address of NanoKVM Go
After NanoKVM Go joins the Tailnet, it receives a Tailscale IP address in the `100.x.x.x` range. You can find this address on the NanoKVM Go settings page or in the Tailscale admin console.
<!-- TODO: Add both methods and the corresponding screenshots. -->
## 7. Access NanoKVM Go Remotely
To ensure that the test uses an external network, disconnect the client device from the current LAN and use a phone hotspot or mobile network instead:
1. Confirm that Tailscale is connected on the client device;
2. Enter the Tailscale IP address of NanoKVM Go in the browser address bar;
3. Log in to NanoKVM Go;
4. Test remote video, keyboard and mouse control, power control, and other features.
<!-- TODO: Add a complete access URL example and screenshots of the login page and a successful remote connection. -->
## 8. Everyday Use and Security Recommendations
- Enable two-factor authentication for the Tailscale account;
- set a strong password for NanoKVM Go and keep its own login authentication enabled;
- do not expose additional NanoKVM Go ports on the router;
- do not share Tailscale device authentication links with others;
- regularly review the Tailscale admin console and remove unused devices;
- in multi-user environments, use ACLs or Grants to restrict device access.
## 9. Troubleshooting
### Tailscale Cannot Be Installed or Started
<!-- TODO: Add troubleshooting steps for the network, version, storage space, and service status. -->
### The Login Link Is Not Generated
<!-- TODO: Add checks for Internet connectivity, system time, and the Tailscale service. -->
### NanoKVM Go Appears Offline
<!-- TODO: Add instructions for checking the Machines page and the device status. -->
### The Tailscale IP Is Visible but Cannot Be Accessed
<!-- TODO: Add checks for the client connection status, Tailnet, ACLs, and NanoKVM services. -->
### The Connection Works but Video Is Choppy
<!-- TODO: Add recommendations related to network latency, bandwidth, video quality, and frame rate. -->
### Tailscale Does Not Reconnect After a Restart
<!-- TODO: Add instructions for checking automatic startup and logging in again. -->
## 10. Advanced Configuration
After completing the basic configuration, you can also learn how to:
- use MagicDNS to access NanoKVM Go by device name;
- change the NanoKVM Go device name in the Tailnet;
- manage device key expiration policies;
- use ACLs or Grants for precise access control;
- determine whether the current connection is peer-to-peer or relayed through DERP;
- use commands such as `tailscale status` to check the connection;
- log out of the current account or move NanoKVM Go to another Tailnet.
> Exit nodes and subnet routers are not required for remote access to NanoKVM Go. Most users only need to complete the first seven sections.

4
docs/hardware/en/kvm/NanoKVM_Go/network/frp.md Normal file
View File

@@ -0,0 +1,4 @@
---
title: frp
keywords: NanoKVM Go, frp, remote access
---

4
docs/hardware/en/kvm/NanoKVM_Go/network/static_ip.md Normal file
View File

@@ -0,0 +1,4 @@
---
title: Static IP
keywords: NanoKVM Go, static IP, network configuration
---

0
docs/hardware/en/kvm/NanoKVM_Go/quick_start.md Normal file
View File

0
docs/hardware/en/kvm/NanoKVM_Go/reset.md Normal file
View File

4
docs/hardware/en/kvm/NanoKVM_Go/system/system.md Normal file
View File

@@ -0,0 +1,4 @@
---
title: System
keywords: NanoKVM Go, system
---

0
docs/hardware/en/kvm/NanoKVM_Go/user_guide.md Normal file
View File

24
docs/hardware/en/sidebar.yaml
View File

@@ -540,6 +540,30 @@ items:
file: kvm/NanoKVM/faq.md
- label: Development
file: kvm/NanoKVM/development.md
- label: NanoKVM Go
items:
- label: Introduction
file: kvm/NanoKVM_Go/introduction.md
- label: Quick Start
file: kvm/NanoKVM_Go/quick_start.md
- label: User Guide
file: kvm/NanoKVM_Go/user_guide.md
- label: Development
file: kvm/NanoKVM_Go/development/development.md
- label: Network
items:
- label: Tailscale
file: kvm/NanoKVM_Go/network/Tailscale.md
- label: frp
file: kvm/NanoKVM_Go/network/frp.md
- label: Static IP
file: kvm/NanoKVM_Go/network/static_ip.md
- label: System
file: kvm/NanoKVM_Go/system/system.md
- label: Reset
file: kvm/NanoKVM_Go/reset.md
- label: FAQ
file: kvm/NanoKVM_Go/faq.md
- label: NanoKVM PCIe
items:
- label: Introduction

4
docs/hardware/zh/kvm/NanoKVM_Go/development/development.md Normal file
View File

@@ -0,0 +1,4 @@
---
title: 二次开发
keywords: NanoKVM Go, 二次开发
---

0
docs/hardware/zh/kvm/NanoKVM_Go/faq.md Normal file
View File

157
docs/hardware/zh/kvm/NanoKVM_Go/network/Tailscale.md Normal file
View File

@@ -0,0 +1,157 @@
---
title: Tailscale
keywords: Tailscale，远程控制，内网穿透
update:
- date: 2026-07-13
version: v0.1
author: Liang Ziyue
---
# Tailscale
## 一、Tailscale简介
Tailscale 是一款基于 WireGuard 的异地组网工具。它可以将 NanoKVM Go 与电脑、手机等设备加入同一个虚拟局域网，使用户无需公网 IP，也无需在路由器上配置端口转发，即可从外网访问 NanoKVM Go。
加入 Tailscale 网络后，每台设备都会获得一个 `100.x.x.x` 格式的虚拟 IP 地址。只要访问端与 NanoKVM Go 位于同一个 Tailscale 网络（Tailnet），就可以通过该地址访问 NanoKVM Go。
```text
NanoKVM Go ── Tailscale 虚拟网络 ── 外网电脑或手机
```
> 本文将以网页配置方式为主，介绍如何使用 Tailscale 从外网访问 NanoKVM Go。
## 二、使用前准备
开始配置前，请确认：
- NanoKVM Go 已连接互联网；
- 可以在局域网内正常访问 NanoKVM Go；
- NanoKVM Go 的系统和应用版本支持 Tailscale；
- 用于外网访问的电脑或手机可以安装 Tailscale 客户端。
<!-- TODO：补充最低版本要求和版本查看方法。 -->
## 三、注册并登录 Tailscale
NanoKVM Go 和用于远程访问的电脑或手机需要加入同一个 Tailscale 网络（Tailnet）。首次使用时，需要先注册并登录 Tailscale：
1. 访问 [Tailscale 官网](https://tailscale.com/)；
2. 点击 `Get Started` 或 `Log in`；
3. 使用页面支持的账号完成登录；
4. 按照页面提示完成首次授权；
5. 进入 Tailscale 管理后台，并找到 `Machines` 设备列表。
`Machines` 页面用于查看和管理已经加入当前 Tailnet 的设备。完成后续配置后，NanoKVM Go 和访问端都会出现在该页面中。
<!-- TODO：补充官网登录入口、登录方式选择页面和 Machines 页面的截图。 -->
> Tailscale 的套餐、组织管理和高级网络设置并非基础远程访问的必需内容，本文不作展开。
## 四、在 NanoKVM Go 上启用 Tailscale
### 1. 打开 Tailscale 设置
<!-- TODO：补充进入 NanoKVM Go 设置页面的操作和截图。 -->
### 2. 安装或启动 Tailscale
<!-- TODO：补充安装、启动按钮的位置，以及安装完成后的页面状态。 -->
### 3. 登录 Tailscale
<!-- TODO：补充获取登录链接、登录账号及点击 Connect 授权的操作和截图。 -->
### 4. 确认 NanoKVM Go 已上线
<!-- TODO：补充登录成功后的界面，以及在线状态的判断方法。 -->
## 五、在访问端安装并登录 Tailscale
在需要远程访问 NanoKVM Go 的电脑或手机上安装 Tailscale：
1. 从 Tailscale 官方渠道下载并安装客户端；
2. 启动 Tailscale，并点击 `Log in`；
3. 使用注册时的同一账号登录；
4. 确认客户端显示已连接；
5. 检查设备列表中是否可以看到 NanoKVM Go。
如果使用不同账号，需要确保该账号已经被邀请加入 NanoKVM Go 所在的 Tailnet。
| 平台 | 安装方式 |
| --- | --- |
| Windows | 从 Tailscale 官网下载安装程序 |
| macOS | 从 Tailscale 官网或 App Store 安装 |
| Linux | 使用官方安装脚本或软件源安装 |
| Android | 从 Google Play 或其他官方渠道安装 |
| iOS / iPadOS | 从 App Store 安装 |
<!-- TODO：以 Windows 为例补充下载安装、登录和连接成功的截图，并补充各平台官方入口。 -->
## 六、查看 NanoKVM Go 的 Tailscale IP
NanoKVM Go 加入 Tailnet 后，会获得一个 `100.x.x.x` 格式的 Tailscale IP。可以通过 NanoKVM Go 的设置页面或 Tailscale 管理后台查看该地址。
<!-- TODO：补充两种查看方式及对应截图。 -->
## 七、从外网访问 NanoKVM Go
为确保测试使用的是外网连接，建议断开访问端当前的局域网，改用手机热点或移动网络：
1. 确认访问端的 Tailscale 客户端已连接；
2. 在浏览器地址栏输入 NanoKVM Go 的 Tailscale IP；
3. 登录 NanoKVM Go；
4. 测试远程画面、键鼠控制和电源控制等功能。
<!-- TODO：补充完整访问地址示例、登录界面和访问成功截图。 -->
## 八、日常使用与安全建议
- 为 Tailscale 账号启用双重验证；
- 为 NanoKVM Go 设置强密码，并保留设备自身的登录认证；
- 不要在路由器上额外开放 NanoKVM Go 的访问端口；
- 不要将 Tailscale 设备认证链接分享给他人；
- 定期检查 Tailscale 管理后台，移除不再使用的设备；
- 多用户环境建议使用 ACL 或 Grants 限制设备访问权限。
## 九、常见问题
### Tailscale 无法安装或启动
<!-- TODO：补充网络、版本、存储空间和服务状态等排查步骤。 -->
### 登录链接没有生成
<!-- TODO：补充互联网连接、系统时间和 Tailscale 服务的检查方法。 -->
### NanoKVM Go 显示离线
<!-- TODO：补充 Machines 页面状态和设备端状态检查方法。 -->
### 可以看到 Tailscale IP，但无法访问
<!-- TODO：补充访问端连接状态、Tailnet、ACL 和 NanoKVM 服务排查方法。 -->
### 连接成功但画面卡顿
<!-- TODO：补充网络延迟、带宽、画质和帧率相关建议。 -->
### 重启后没有自动连接
<!-- TODO：补充开机启动状态和重新登录方法。 -->
## 十、进阶配置
完成基础配置后，可以根据需要进一步了解：
- 使用 MagicDNS 通过设备名称访问 NanoKVM Go；
- 修改 NanoKVM Go 在 Tailnet 中的设备名称；
- 管理设备密钥过期策略；
- 使用 ACL 或 Grants 精确控制访问权限；
- 判断当前连接是点对点直连还是 DERP 中继；
- 使用 `tailscale status` 等命令检查连接状态；
- 退出当前账号或将 NanoKVM Go 更换到其他 Tailnet。
> 出口节点和子网路由器不是远程访问 NanoKVM Go 的必需配置，普通用户完成前七节即可正常使用。

4
docs/hardware/zh/kvm/NanoKVM_Go/network/frp.md Normal file
View File

@@ -0,0 +1,4 @@
---
title: frp
keywords: NanoKVM Go, frp, 远程访问
---

4
docs/hardware/zh/kvm/NanoKVM_Go/network/static_ip.md Normal file
View File

@@ -0,0 +1,4 @@
---
title: 静态 IP
keywords: NanoKVM Go, 静态 IP, 网络配置
---

0
docs/hardware/zh/kvm/NanoKVM_Go/quick_start.md Normal file
View File

0
docs/hardware/zh/kvm/NanoKVM_Go/reset.md Normal file
View File

4
docs/hardware/zh/kvm/NanoKVM_Go/system/system.md Normal file
View File

@@ -0,0 +1,4 @@
---
title: 系统
keywords: NanoKVM Go, 系统
---

0
docs/hardware/zh/kvm/NanoKVM_Go/user_guide.md Normal file
View File

24
docs/hardware/zh/sidebar.yaml
View File

@@ -541,6 +541,30 @@ items:
file: kvm/NanoKVM/ipmi.md
- label: FAQ
file: kvm/NanoKVM/faq.md
- label: NanoKVM Go
items:
- label: 简介
file: kvm/NanoKVM_Go/introduction.md
- label: 快速上手
file: kvm/NanoKVM_Go/quick_start.md
- label: 用户指南
file: kvm/NanoKVM_Go/user_guide.md
- label: 二次开发
file: kvm/NanoKVM_Go/development/development.md
- label: 网络
items:
- label: Tailscale
file: kvm/NanoKVM_Go/network/Tailscale.md
- label: frp
file: kvm/NanoKVM_Go/network/frp.md
- label: 静态 IP
file: kvm/NanoKVM_Go/network/static_ip.md
- label: 系统
file: kvm/NanoKVM_Go/system/system.md
- label: 重置
file: kvm/NanoKVM_Go/reset.md
- label: FAQ
file: kvm/NanoKVM_Go/faq.md
- label: NanoKVM PCIe
items:
- label: 简介

2
pages/index/en/faq.md
View File

@@ -24,6 +24,7 @@ The sharing location is the FAQ page of the corresponding product in the table b
| MaixHub | [maixhub.com](https://maixhub.com) | [MaixHub FAQ](/ai/zh/maixhub/faq.html) |
| Tang FPGA | [Tang](/tang) | [Tang FAQ](/hardware/zh/tang/Tang-Nano-Doc/questions.html) |
| NanoKVM | [NanoKVM](/nanokvm) | [NanoKVM FAQ](/hardware/en/kvm/NanoKVM/faq.html) |
| NanoKVM-Go | [NanoKVM-Go](/nanokvmgo) | [NanoKVM Go FAQ](/hardware/en/kvm/NanoKVM_Go/faq.html) |
| NanoKVM-PCIe | [NanoKVM-PCIe](/nanokvmpcie) | [NanoKVM PCIe FAQ](/hardware/en/kvm/NanoKVM/faq.html) |
| NanoKVM-USB | [NanoKVM-USB](/nanokvmusb) | [NanoKVM USB FAQ](/hardware/en/kvm/NanoKVM_USB/faq.html) |
| NanoKVM-Pro | [NanoKVM-Pro](/nanokvmpro) | [NanoKVM Pro FAQ](/hardware/en/kvm/NanoKVM_Pro/faq.html) |
@@ -39,4 +40,3 @@ The sharing location is the FAQ page of the corresponding product in the table b
| Telegram MaixPy | [t.me/maixpy](https://t.me/maixpy) |
| Twitter | [twitter.com/SipeedIO](https://twitter.com/SipeedIO) |
| FPGA Reddit | [GowinFPGA](https://www.reddit.com/r/GowinFPGA/) |

1
pages/index/zh/faq.md
View File

@@ -25,6 +25,7 @@ class: faq
| MaixHub | [maixhub.com](https://maixhub.com) | [MaixHub FAQ 汇总](/ai/zh/maixhub/faq.html) |
| Tang FPGA | [Tang](/tang) | [Tang FAQ 汇总](/hardware/zh/tang/Tang-Nano-Doc/questions.html) |
| NanoKVM | [NanoKVM](/nanokvm) | [NanoKVM FAQ 汇总](/hardware/zh/kvm/NanoKVM/faq.html) |
| NanoKVM-Go | [NanoKVM-Go](/nanokvmgo) | [NanoKVM Go FAQ 汇总](/hardware/zh/kvm/NanoKVM_Go/faq.html) |
| NanoKVM-PCIe | [NanoKVM-PCIe](/nanokvmpcie) | [NanoKVM PCIe FAQ 汇总](/hardware/zh/kvm/NanoKVM/faq.html) |
| NanoKVM-USB | [NanoKVM-USB](/nanokvmusb) | [NanoKVM USB FAQ 汇总](/hardware/zh/kvm/NanoKVM_USB/faq.html) |
| NanoKVM-Pro | [NanoKVM-Pro](/nanokvmpro) | [NanoKVM Pro FAQ 汇总](/hardware/zh/kvm/NanoKVM_Pro/faq.html) |