diff --git a/docs/linkr/linkr-kvm/product-introduction.mdx b/docs/linkr/linkr-kvm/product-introduction.mdx deleted file mode 100644 index 43ec91d287..0000000000 --- a/docs/linkr/linkr-kvm/product-introduction.mdx +++ /dev/null @@ -1,131 +0,0 @@ ---- -id: product-introduction -sidebar_position: 0 -title: 产品概述 ---- - -# 产品概述 - -Linkr KVM（Radxa Linkr KVM）是一款基于 Web 的 IP KVM 设备，通过 HDMI 采集被控主机画面，经 USB 模拟键鼠输入，让你在任何有浏览器的终端上远程查看、操作目标电脑——无需安装专用客户端。 - -设备体积小巧，支持有线网络、Wi-Fi 与热点多种联网方式，并内置 Tailscale、Wake on LAN、访问令牌等高级能力，适合家庭实验室、远程运维与嵌入式开发等场景。 - -## 产品定位 - -Linkr KVM 定位于**轻量级、开箱即用的硬件 KVM over IP 解决方案**： - -- **即插即用**：HDMI + USB Type-C 连接被控主机，浏览器打开管理页面即可使用 -- **Web 优先**：远程画面、键鼠控制、网络与系统管理统一在 Web 控制台完成 -- **场景友好**：兼顾桌面 PC、开发板、无头服务器等设备的远程维护需求 - -与传统机架式 KVM 或纯软件远程桌面方案相比，Linkr KVM 在成本、部署复杂度和使用门槛之间取得平衡，适合个人开发者、小团队及教育场景。 - -## 目标用户 - -| 用户群体 | 典型场景 | -| --- | --- | -| 开发者与创客 | 远程调试开发板、无显示器环境下的系统安装与排障 | -| 家庭实验室用户 | 管理家中 NAS、软路由、备用 PC，无需额外显示器和键盘 | -| 运维与技术支持 | 远程协助用户操作电脑、抓取画面、发送控制指令 | -| 教育与培训 | 课堂演示、实验环境统一远程访问与管控 | - -## 核心价值 - -- **随时随地访问**：局域网、互联网（配合 Tailscale）均可连接管理界面 -- **完整远程操控**：视频采集 + 键鼠注入，体验接近本地操作 -- **一体化管理**：网络配置、固件升级、虚拟磁盘挂载、API 集成均在同一 Web 界面 -- **可扩展集成**：访问令牌支持截图、控制等公开 API，便于自动化与监控 - -## 产品外观 - -Linkr KVM 采用紧凑型设计，正面与侧面分布有 HDMI 接口、USB Type-C 接口、FN 功能键及状态指示灯。具体外观以实物为准，可参考产品包装或官方资料中的示意图。 - -![img](/img/linkr/linkr.jpg) - -## 接口与连接 - -| 接口 | 用途 | -| --- | --- | -| HDMI 公口 | 接入被控主机，采集视频信号 | -| USB Type-C（OTG） | 供电与数据传输（模拟被控机的鼠标、键盘等 HID 设备） | -| USB Type-C（网口） | 有线以太网通信 | -| Wi-Fi | 连接无线网络 | -| 热点 | 设备作为 AP 共享网络 | - -### 连接说明 - -1. **HDMI 公口**：连接被控主机的 HDMI 视频输出，用于采集画面。 -2. **USB Type-C（OTG）**：同时承担供电与数据通道，向被控机提供键鼠等 USB HID 功能。 -3. **USB Type-C（网口）**：百兆有线网络，用于 KVM 设备自身的网络通信。 -4. **Wi-Fi**：接入现有无线网络，免布线部署。 -5. **热点**：KVM 可作为热点，供其他终端连接以访问管理界面或共享网络。 - -典型接线方式：HDMI 连接被控机视频输出，OTG Type-C 连接被控机 USB 口（供电 + 键鼠），网口 Type-C 或 Wi-Fi 接入网络。 - -## LED 指示灯 - -设备 **FN 键** 两侧各有一颗指示灯： - -- **靠近 HDMI 一侧**：视频（HDMI）状态灯 -- **远离 HDMI 一侧**：系统状态灯（RGB，通过颜色表示运行状态） - -### 系统状态灯 - -| LED 状态 | 说明 | -| --- | --- | -| 蓝色闪烁 | 系统启动中 | -| 蓝色常亮 | 系统正常运行 | -| 绿色常亮 | 正在被使用中（有活跃连接） | -| 白色闪烁 | 正在升级固件 | -| 白色常亮 | 正在重置系统 | - -### HDMI / 视频状态灯 - -| LED 状态 | 说明 | -| --- | --- | -| 灭 | 无视频信号 | -| 亮 | 有视频信号 | -| 闪烁 | 视频链路异常或错误 | - -通过观察指示灯，可在不打开 Web 界面的情况下快速判断设备与视频链路状态。 - -## FN 按钮 - -| 操作 | 功能 | -| --- | --- | -| **长按 ≥ 10 秒** | 重置系统（将所有配置恢复到出厂默认状态） | -| **短按一次** | 设备识别（用于 [linkr.now](https://linkr.now) 上的设备发现功能） | - -:::caution 注意 -长按 FN 键重置将清除所有本地配置（含网络、账号、Tailscale 绑定等），操作前请确认已备份必要信息。 -::: - -## 规格参数 - -| 项目 | 说明 | -| --- | --- | -| 视频编码 | 最高 2K@30fps，支持 H.264 或 MJPEG | -| 视频传输 | WebRTC、WebSocket | -| 以太网 | 百兆（100 Mbps） | -| USB 网卡 | 百兆（100 Mbps） | -| 存储 | 16 GB eMMC | -| 板载 Wi-Fi | 支持 | -| USB | 1× USB（Host/Device） | -| 供电 | USB 5 V | - -## 软件能力概览 - -除硬件 KVM 能力外，Linkr KVM 固件与 Web 管理界面还提供： - -| 功能 | 说明 | 文档 | -| --- | --- | --- | -| Web 远程控制台 | 视频、键鼠、截图、录屏、虚拟键盘等 | [用户页面指南](./usage) | -| Tailscale | 内置 VPN，无需公网 IP 远程访问 | [Tailscale 远程访问](./tailscale) | -| Wake on LAN | 局域网魔术包唤醒被控主机 | [Wake on LAN](./wake-on-lan) | -| 访问令牌 | API Key，支持截图与控制接口 | [访问令牌](./access-token) | - -## 相关链接 - -- [上手指南](./getting-started) -- [功能详解](./feature-details) -- [常见问题](./faq) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/README.md b/docs/linkr/linkr/README.md similarity index 75% rename from i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/README.md rename to docs/linkr/linkr/README.md index b7a633adab..4f88694e6b 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/README.md +++ b/docs/linkr/linkr/README.md @@ -2,6 +2,6 @@ sidebar_position: 2 --- -# Linkr KVM +# 瑞莎灵控 diff --git a/docs/linkr/linkr-kvm/access-token.mdx b/docs/linkr/linkr/access-token.mdx similarity index 81% rename from docs/linkr/linkr-kvm/access-token.mdx rename to docs/linkr/linkr/access-token.mdx index cecaada070..7ca582dc69 100644 --- a/docs/linkr/linkr-kvm/access-token.mdx +++ b/docs/linkr/linkr/access-token.mdx @@ -4,7 +4,7 @@ sidebar_position: 5 # 访问令牌 -Linkr KVM 提供 **访问令牌（Access Token）** 功能，用于在无需 Web 登录会话的情况下，通过 API 以编程方式访问 KVM 的部分能力。适用于自动化脚本、监控集成、第三方工具调用等场景。 +瑞莎灵控（Radxa Linkr）提供 **访问令牌（Access Token）** 功能，用于在无需 Web 登录会话的情况下，通过 API 以编程方式访问灵控的部分能力。适用于自动化脚本、监控集成、第三方工具调用等场景。 访问令牌等同于 API Key，创建后可用于调用设备的公开 API 接口。 @@ -13,15 +13,15 @@ Linkr KVM 提供 **访问令牌（Access Token）** 功能，用于在无需 Web | 能力 | 说明 | | ------------ | ------------------------------------------------------ | | Web 界面管理 | 在系统设置中创建、查看名称、删除访问令牌 | -| 密码验证 | 生成新令牌时需输入 KVM 登录密码，防止未授权创建 | +| 密码验证 | 生成新令牌时需输入灵控登录密码，防止未授权创建 | | 一次性展示 | 令牌明文仅在创建成功时显示一次，关闭弹窗后无法再次查看 | | 持久保存 | 令牌保存在设备本地配置中，重启后仍然有效，直至手动删除 | ## 适用场景 -- **远程截图**：定时获取 KVM 当前画面快照，用于监控或巡检 +- **远程截图**：定时获取灵控当前画面快照，用于监控或巡检 - **远程控制**：通过 API 发送控制指令（键盘、鼠标等） -- **自动化集成**：将 KVM 接入 CI/CD、运维平台或自定义脚本 +- **自动化集成**：将灵控接入 CI/CD、运维平台或自定义脚本 :::caution 安全提示 访问令牌拥有与创建者相当的 API 访问权限。请妥善保管，切勿提交到公开代码仓库或分享给不可信方。若令牌泄露，请立即在管理界面删除并重新生成。 @@ -31,7 +31,7 @@ Linkr KVM 提供 **访问令牌（Access Token）** 功能，用于在无需 Web ### 1. 进入系统设置 -1. 打开 KVM 管理 Web 界面并登录。 +1. 打开灵控管理 Web 界面并登录。 2. 点击左侧边栏的 **系统设置**（设置图标）。 3. 找到 **访问令牌** 折叠面板。 @@ -43,7 +43,7 @@ Linkr KVM 提供 **访问令牌（Access Token）** 功能，用于在无需 Web - 必须以字母或数字开头，不能以 `-` 开头或结尾 - 最长 20 个字符 - 示例：`monitor-script`、`ci-deploy-01` -3. 填写 **用户密码**（必填）：输入当前 KVM 管理账号的登录密码，用于身份验证。 +3. 填写 **用户密码**（必填）：输入当前灵控管理账号的登录密码，用于身份验证。 4. 点击绿色 **生成** 按钮。 ### 3. 保存令牌 @@ -70,7 +70,7 @@ Linkr KVM 提供 **访问令牌（Access Token）** 功能，用于在无需 Web 在 HTTP 请求头中携带访问令牌： -```http +```text Authorization: token <你的访问令牌> ``` @@ -82,7 +82,7 @@ curl -H "Authorization: token radxa_linkr_xxxxxxxx" \ --output snapshot.jpg ``` -请将 `` 替换为 KVM 的实际 IP 地址或域名（本地局域网 IP、Tailscale IP 等均可）。 +请将 `` 替换为灵控的实际 IP 地址或域名（本地局域网 IP、Tailscale IP 等均可）。 ### 可用公开 API @@ -113,7 +113,7 @@ curl -X POST \ "https://192.168.1.100/api/public/control" ``` -控制数据的格式取决于 KVM 控制协议，具体字段请参考 API 文档或集成 SDK。 +控制数据的格式取决于灵控控制协议，具体字段请参考 API 文档或集成 SDK。 ### 认证失败 @@ -122,7 +122,7 @@ curl -X POST \ - `Authorization` 头格式是否为 `token <令牌>`（注意 `token` 与令牌之间有一个空格） - 令牌是否完整、未被截断 - 该令牌是否已被删除 -- KVM 设备 IP 或网络是否可达 +- 灵控设备 IP 或网络是否可达 ## 令牌格式说明 @@ -137,7 +137,7 @@ curl -X POST \ 1. **最小权限原则**：为不同用途创建不同名称的令牌，便于单独吊销。 2. **定期轮换**：建议定期删除旧令牌并重新生成，尤其在人员变动或脚本迁移后。 3. **安全存储**：使用环境变量或密钥管理工具存放令牌，不要硬编码在源码中。 -4. **HTTPS 访问**：生产环境建议通过 HTTPS 访问 KVM API，避免令牌在传输中被窃听。 +4. **HTTPS 访问**：生产环境建议通过 HTTPS 访问灵控 API，避免令牌在传输中被窃听。 5. **及时吊销**：发现泄露或不再使用时，立即在系统设置中删除对应令牌。 ## 常见问题 @@ -152,7 +152,7 @@ curl -X POST \ ### 提示密码错误 -生成令牌时输入的用户密码与 KVM 登录密码不一致。请使用当前管理账号的正确密码。 +生成令牌时输入的用户密码与灵控登录密码不一致。请使用当前管理账号的正确密码。 ### 提示名称已被占用 diff --git a/docs/linkr/linkr-kvm/advanced-usage/README.md b/docs/linkr/linkr/advanced-usage/README.md similarity index 100% rename from docs/linkr/linkr-kvm/advanced-usage/README.md rename to docs/linkr/linkr/advanced-usage/README.md diff --git a/docs/linkr/linkr-kvm/advanced-usage/remote-access.mdx b/docs/linkr/linkr/advanced-usage/remote-access.mdx similarity index 81% rename from docs/linkr/linkr-kvm/advanced-usage/remote-access.mdx rename to docs/linkr/linkr/advanced-usage/remote-access.mdx index eb21449c15..28a46ae038 100644 --- a/docs/linkr/linkr-kvm/advanced-usage/remote-access.mdx +++ b/docs/linkr/linkr/advanced-usage/remote-access.mdx @@ -4,7 +4,7 @@ sidebar_position: 1 # Tailscale 远程访问 -Linkr KVM 内置了 [Tailscale](https://tailscale.com/) 客户端，可将设备加入你的 Tailscale 虚拟专用网络（VPN），在任意地点通过加密隧道安全访问 KVM 管理界面，无需公网 IP 或手动配置端口转发。 +瑞莎灵控（Radxa Linkr）内置了 [Tailscale](https://tailscale.com/) 客户端，可将设备加入你的 Tailscale 虚拟专用网络（VPN），在任意地点通过加密隧道安全访问灵控管理界面，无需公网 IP 或手动配置端口转发。 Tailscale 基于 WireGuard 协议，由 Tailscale 协调服务器负责节点发现与密钥交换，设备之间建立点对点加密连接。 @@ -13,21 +13,21 @@ Tailscale 基于 WireGuard 协议，由 Tailscale 协调服务器负责节点发 | 能力 | 说明 | | ------------ | -------------------------------------------------------- | | 内置客户端 | 固件预装 `tailscale` / `tailscaled` 二进制，无需额外安装 | -| Web 界面管理 | 在 KVM 管理界面中启用、登录、解绑 Tailscale 账号 | +| Web 界面管理 | 在灵控管理界面中启用、登录、解绑 Tailscale 账号 | | 开机自启 | 启用后配置持久保存，设备重启后自动启动 `tailscaled` | | 安全组网 | 流量经 WireGuard 加密，仅同一 Tailnet 内的设备可互通 | ## 使用前准备 1. **Tailscale 账号**：在 [tailscale.com](https://tailscale.com/) 注册个人或团队账号（免费套餐即可满足个人使用）。 -2. **网络连接**：KVM 设备需能访问互联网（RJ45有线或Wi-Fi均可），以便与 Tailscale 协调服务器通信。 +2. **网络连接**：灵控设备需能访问互联网（RJ45有线或Wi-Fi均可），以便与 Tailscale 协调服务器通信。 3. **浏览器**：绑定账号时需在浏览器中完成 Tailscale 授权，请确保管理端浏览器允许弹出窗口。 ## 操作步骤 ### 1. 进入设置页面 -1. 打开 KVM 管理 Web 界面并登录。 +1. 打开灵控管理 Web 界面并登录。 2. 在左侧边栏进入 **系统** → **高级设置**。 3. 找到 **Tailscale** 配置项。 @@ -53,11 +53,11 @@ Tailscale 基于 WireGuard 协议，由 Tailscale 协调服务器负责节点发 ![img](/img/linkr/tailscale-3.png) -### 4. 通过 Tailscale 访问 KVM +### 4. 通过 Tailscale 访问灵控 绑定成功后，可在 [Tailscale 管理后台](https://login.tailscale.com/admin/machines) 查看设备分配的 Tailscale IP（通常为 `100.x.x.x` 网段）。 -在同一 Tailnet 内的任意设备上，使用以下地址访问 KVM： +在同一 Tailnet 内的任意设备上，使用以下地址访问灵控： ```text https://<设备 Tailscale IP> @@ -70,7 +70,7 @@ https://<设备主机名>.<你的-tailnet>.ts.net ``` :::tip 提示 -通过 Tailscale 访问时，仍需使用 KVM 的本地登录凭据（用户名与密码），Tailscale 仅提供网络层连通性，不替代 KVM 的身份认证。 +通过 Tailscale 访问时，仍需使用灵控的本地登录凭据（用户名与密码），Tailscale 仅提供网络层连通性，不替代灵控的身份认证。 ::: ### 5. 解绑账号 @@ -98,13 +98,13 @@ Tailscale 客户端以内置二进制形式打包进固件： ### 与本地访问的关系 -启用 Tailscale 不会影响 KVM 的本地网络访问方式。设备仍可通过局域网 IP、Wi-Fi 或 USB 网络等方式访问，Tailscale 作为额外的远程访问通道叠加使用。 +启用 Tailscale 不会影响灵控的本地网络访问方式。设备仍可通过局域网 IP、Wi-Fi 或 USB 网络等方式访问，Tailscale 作为额外的远程访问通道叠加使用。 ## 常见问题 ### 绑定失败或长时间无响应 -- 确认 KVM 设备已连接互联网。 +- 确认灵控设备已连接互联网。 - 检查浏览器是否拦截了弹出窗口。 - 确认 Tailscale 协调服务器（`controlplane.tailscale.com`）未被防火墙阻断。 - 尝试关闭后重新启用 Tailscale，再次绑定。 @@ -112,7 +112,7 @@ Tailscale 客户端以内置二进制形式打包进固件： ### 启用后无法通过 Tailscale IP 访问 - 在 Tailscale 管理后台确认设备在线（Online）。 -- 确认访问端与 KVM 在同一 Tailnet 内。 +- 确认访问端与灵控在同一 Tailnet 内。 - 检查访问端 Tailscale 客户端是否已连接。 - 确认使用的是 `https://` 协议及正确的 Tailscale IP。 diff --git a/docs/linkr/linkr-kvm/advanced-usage/wake-on-lan.mdx b/docs/linkr/linkr/advanced-usage/wake-on-lan.mdx similarity index 68% rename from docs/linkr/linkr-kvm/advanced-usage/wake-on-lan.mdx rename to docs/linkr/linkr/advanced-usage/wake-on-lan.mdx index fd3be88cdb..bb974c2303 100644 --- a/docs/linkr/linkr-kvm/advanced-usage/wake-on-lan.mdx +++ b/docs/linkr/linkr/advanced-usage/wake-on-lan.mdx @@ -4,9 +4,9 @@ sidebar_position: 2 # Wake on LAN 设备唤醒 -Linkr KVM 支持 **Wake on LAN（WOL，网络唤醒）** 功能。当远端电脑处于关机或休眠状态时，可通过 KVM 向其网卡发送 Magic Packet（魔术包），远程唤醒目标设备，无需到现场按电源键。 +瑞莎灵控（Radxa Linkr）支持 **Wake on LAN（WOL，网络唤醒）** 功能。当远端电脑处于关机或休眠状态时，可通过灵控向其网卡发送 Magic Packet（魔术包），远程唤醒目标设备，无需到现场按电源键。 -KVM 与目标电脑通常通过网线或交换机处于同一局域网内；发送唤醒包后，目标机器收到符合其 MAC 地址的广播包即可启动。 +灵控与目标电脑通常通过网线或交换机处于同一局域网内；发送唤醒包后，目标机器收到符合其 MAC 地址的广播包即可启动。 ## 功能概述 @@ -18,7 +18,7 @@ KVM 与目标电脑通常通过网线或交换机处于同一局域网内；发 ## 使用前准备 -在通过 KVM 唤醒目标电脑前，请确认目标机器已正确配置 WOL： +在通过灵控唤醒目标电脑前，请确认目标机器已正确配置 WOL： ### 1. 在 BIOS/UEFI 中启用 Wake on LAN @@ -49,8 +49,8 @@ sudo ethtool -s eth0 wol g ### 3. 网络连接要求 -- 目标电脑关机后，**有线网卡**需保持与网络的物理连接（接网线、交换机或 KVM 所在网段）。 -- KVM 与目标电脑应在**同一二层广播域**（同一局域网或 VLAN）内，唤醒包以 UDP 广播方式发送。 +- 目标电脑关机后，**有线网卡**需保持与网络的物理连接（接网线、交换机或灵控所在网段）。 +- 灵控与目标电脑应在**同一二层广播域**（同一局域网或 VLAN）内，唤醒包以 UDP 广播方式发送。 - 无线网卡对 WOL 支持普遍较差，建议使用有线网口对应的 MAC 地址。 ### 4. 获取目标 MAC 地址 @@ -61,13 +61,13 @@ sudo ethtool -s eth0 wol g - Linux：`ip link show` - macOS：`ifconfig` -记下用于连接 KVM 所在局域网的那块网卡的 MAC 地址。 +记下用于连接灵控所在局域网的那块网卡的 MAC 地址。 ## 操作步骤 ### 1. 进入高级设置 -1. 打开 KVM 管理 Web 界面并登录。 +1. 打开灵控管理 Web 界面并登录。 2. 点击左侧边栏底部的 **高级设置**（齿轮图标）。 3. 在页面中找到 **设备唤醒** 折叠面板并展开。 @@ -93,7 +93,7 @@ sudo ethtool -s eth0 wol g - **发送失败**：请检查网络连接与目标端 WOL 配置后重试。 :::tip 提示 -「发送成功」表示 KVM 已成功发出 Magic Packet，并不保证目标电脑一定开机。若目标端未正确配置 WOL 或不在同一广播域，电脑可能仍无法唤醒。 +「发送成功」表示灵控已成功发出 Magic Packet，并不保证目标电脑一定开机。若目标端未正确配置 WOL 或不在同一广播域，电脑可能仍无法唤醒。 ::: ## 工作原理 @@ -101,11 +101,11 @@ sudo ethtool -s eth0 wol g Wake on LAN 使用标准 Magic Packet 格式： 1. 包体由 6 字节 `0xFF` 头部 + 16 次重复的目标 MAC 地址组成，共 102 字节。 -2. KVM 通过 UDP 将数据包广播到 `255.255.255.255:9`（标准 WOL 端口）。 +2. 灵控通过 UDP 将数据包广播到 `255.255.255.255:9`（标准 WOL 端口）。 3. 目标网卡在关机/休眠但保持供电的状态下监听链路层流量，识别到自身 MAC 后触发主板开机。 ``` -KVM 管理界面 → 输入 MAC → 点击「唤醒」 +灵控 管理界面 → 输入 MAC → 点击「唤醒」 ↓ 构造 Magic Packet（102 字节） ↓ @@ -128,21 +128,21 @@ KVM 管理界面 → 输入 MAC → 点击「唤醒」 - 确认使用的是**有线网卡** MAC，且关机后网线仍连接在同一局域网。 - 检查主板是否关闭了关机后的网卡供电（ErP、EuP 等节能选项）。 - 部分电脑仅支持从**休眠/睡眠**唤醒，不支持从完全关机（S5）状态唤醒。 -- 若 KVM 与目标电脑不在同一网段或 VLAN，广播包可能无法到达目标网卡。 +- 若灵控与目标电脑不在同一网段或 VLAN，广播包可能无法到达目标网卡。 ### 发送失败 -- 确认 KVM 设备网络正常，能访问管理界面即表示基本连通。 -- 检查 KVM 与目标设备之间的交换机、路由器是否允许广播流量透传。 -- 稍后重试；若持续失败，可重启 KVM 网络服务或检查固件版本。 +- 确认灵控设备网络正常，能访问管理界面即表示基本连通。 +- 检查灵控与目标设备之间的交换机、路由器是否允许广播流量透传。 +- 稍后重试；若持续失败，可重启灵控网络服务或检查固件版本。 ### 如何确认用的是哪块网卡的 MAC -若电脑有多块网卡（有线、无线、虚拟网卡），请使用**实际接入 KVM 所在局域网的那块有线网卡** MAC。可通过暂时禁用其他网卡后执行 `ipconfig` / `ip link` 来确认。 +若电脑有多块网卡（有线、无线、虚拟网卡），请使用**实际接入灵控所在局域网的那块有线网卡** MAC。可通过暂时禁用其他网卡后执行 `ipconfig` / `ip link` 来确认。 ## 与「防止休眠」功能的区别 -KVM 还提供 **防止休眠** 功能：在已连接远端电脑时，定时发送微小鼠标移动，防止系统进入休眠。该功能作用于**已开机且已通过 KVM 连接**的场景。 +灵控 还提供 **防止休眠** 功能：在已连接远端电脑时，定时发送微小鼠标移动，防止系统进入休眠。该功能作用于**已开机且已通过灵控连接**的场景。 **Wake on LAN（设备唤醒）** 则用于**电脑已关机或深度休眠**时，通过网络魔术包远程开机。两者用途不同，请根据实际场景选择。 diff --git a/docs/linkr/linkr-kvm/develop-guide.mdx b/docs/linkr/linkr/develop-guide.mdx similarity index 93% rename from docs/linkr/linkr-kvm/develop-guide.mdx rename to docs/linkr/linkr/develop-guide.mdx index 47a4d329b3..052d680821 100644 --- a/docs/linkr/linkr-kvm/develop-guide.mdx +++ b/docs/linkr/linkr/develop-guide.mdx @@ -6,7 +6,7 @@ sidebar_position: 7 ## AI Agent 接口 -通过调用 Linkr 提供的 HTTP 接口（包括屏幕截图、键盘与鼠标控制），来实现对被控机的远程自动化操作。 +通过调用 Radxa Linkr 提供的 HTTP 接口（包括屏幕截图、键盘与鼠标控制），来实现对被控机的远程自动化操作。 **API Token获取参考使用指南中如何生成API Token章节。** @@ -206,12 +206,12 @@ curl -X POST http://192.168.2.224:80/api/public/control \ **参数说明**: -- 索引 0: 固定字符串 `"delay"`，表示暂停，确保IPKVM完成上一个操作。例如：用来确保长文本输入完整。 +- 索引 0: 固定字符串 `"delay"`，表示暂停，确保灵控完成上一个操作。例如：用来确保长文本输入完整。 - 索引 1: 字段类型：Number。表示是暂停时长，单位：毫秒。 **注意**: -在文本输入事件后通常需要添加暂停事件，确保 IPKVM 有足够时间处理输入完整的长文本，如果IPKVM需要较长时间操作，则需要多次发送暂停事件。一般地输入文本长度为30时，就需要暂停1000毫秒。 +在文本输入事件后通常需要添加暂停事件，确保灵控有足够时间处理输入完整的长文本，如果灵控需要较长时间操作，则需要多次发送暂停事件。一般地输入文本长度为30时，就需要暂停1000毫秒。 **示例**: diff --git a/docs/linkr/linkr-kvm/firmware-update.mdx b/docs/linkr/linkr/firmware-update.mdx similarity index 78% rename from docs/linkr/linkr-kvm/firmware-update.mdx rename to docs/linkr/linkr/firmware-update.mdx index 8a12cc2ca8..09ad1b72e3 100644 --- a/docs/linkr/linkr-kvm/firmware-update.mdx +++ b/docs/linkr/linkr/firmware-update.mdx @@ -6,7 +6,7 @@ title: 固件更新 # 固件更新 -Linkr KVM 支持通过 Web 管理界面上传固件包进行**本地升级**，用于获取新功能、问题修复与安全更新。固件文件从 GitHub Releases 下载，上传后由设备自动校验、解密并安装。 +瑞莎灵控（Radxa Linkr）支持通过 Web 管理界面上传固件包进行**本地升级**，用于获取新功能、问题修复与安全更新。固件文件从 GitHub Releases 下载，上传后由设备自动校验、解密并安装。 :::info 当前版本 固件下载页面：[https://github.com/radxa-linkr/linkr/releases](https://github.com/radxa-linkr/linkr/releases) @@ -18,7 +18,7 @@ Linkr KVM 支持通过 Web 管理界面上传固件包进行**本地升级**， 1. **确认当前版本**：在 **关于 → 设备信息** 中查看「当前固件版本」，与待安装版本对比，确保为更高版本。 2. **下载固件包**：访问 [GitHub Releases](https://github.com/radxa-linkr/linkr/releases)，在对应版本的 **Assets** 区域下载 `linkr-ota-<版本号>.bin` 文件到本地电脑。 -3. **保持网络稳定**：升级过程中请保持浏览器与 KVM 的连接，避免关闭页面或断开网络。 +3. **保持网络稳定**：升级过程中请保持浏览器与灵控的连接，避免关闭页面或断开网络。 4. **预留存储空间**：固件包约 50～60 MB，设备需有足够可用空间；空间不足时会提示「存储空间不足」。 5. **避免中断**：升级期间设备系统指示灯为**白色闪烁**（参见[产品概述](./product-introduction)），请勿断电或拔线。 @@ -26,7 +26,7 @@ Linkr KVM 支持通过 Web 管理界面上传固件包进行**本地升级**， ### 1. 进入系统更新 -1. 打开 KVM 管理 Web 界面并登录。 +1. 打开灵控管理 Web 界面并登录。 2. 点击左侧边栏的 **系统设置**（设置图标）。 3. 找到 **系统更新** 一行，点击右侧 **更新** 按钮。 @@ -50,11 +50,11 @@ Linkr KVM 支持通过 Web 管理界面上传固件包进行**本地升级**， 升级分为以下阶段： -| 阶段 | 界面提示 | 说明 | -| --- | --- | --- | -| 上传中 | 上传中... | 固件文件从浏览器传输到 KVM 设备 | -| 升级中 | 升级中... | 设备校验签名、解密并写入固件 | -| 完成 | 已升级，请重启设备 | 安装完成，需重启后生效 | +| 阶段 | 界面提示 | 说明 | +| ------ | ------------------ | ------------------------------ | +| 上传中 | 上传中... | 固件文件从浏览器传输到灵控设备 | +| 升级中 | 升级中... | 设备校验签名、解密并写入固件 | +| 完成 | 已升级，请重启设备 | 安装完成，需重启后生效 | 升级过程中可点击 **取消** 中止操作（安装接近完成时建议不要取消）。 @@ -67,7 +67,7 @@ Linkr KVM 支持通过 Web 管理界面上传固件包进行**本地升级**， 3. 在 **关于 → 设备信息** 中确认固件版本已更新。 :::caution 注意 -重启会短暂中断 KVM 服务与远程连接。请在合适的时间窗口执行升级，并确保被控主机不会因 KVM 重启而受影响。 +重启会短暂中断灵控服务与远程连接。请在合适的时间窗口执行升级，并确保被控主机不会因灵控重启而受影响。 ::: ## 下载固件 @@ -84,11 +84,11 @@ Linkr KVM 支持通过 Web 管理界面上传固件包进行**本地升级**， ### 文件说明 -| 项目 | 说明 | -| --- | --- | -| 文件格式 | `linkr-ota-.bin`（加密 OTA 固件包） | -| 典型大小 | 约 50～60 MB | -| 来源 | 仅从官方 GitHub Releases 下载，勿使用来历不明的文件 | +| 项目 | 说明 | +| -------- | --------------------------------------------------- | +| 文件格式 | `linkr-ota-.bin`（加密 OTA 固件包） | +| 典型大小 | 约 50～60 MB | +| 来源 | 仅从官方 GitHub Releases 下载，勿使用来历不明的文件 | ### 国内镜像（百度网盘） @@ -98,20 +98,21 @@ Linkr KVM 支持通过 Web 管理界面上传固件包进行**本地升级**， - **提取码**：`1234` :::caution 校验与安全 + - 镜像中的固件版本与 GitHub Releases 保持一致；下载后请确认文件名仍为 `linkr-ota-<版本号>.bin`。 - 如 GitHub Releases 页面提供了同版本固件的 SHA256，请优先比对哈希后再上传到设备。 - 百度网盘分享链接如失效，请以 [GitHub Releases](https://github.com/radxa-linkr/linkr/releases) 为准。 -::: + ::: ## 版本规则 设备在安装前会自动校验固件版本： -| 情况 | 结果 | -| --- | --- | -| 固件版本 **高于** 当前版本 | 允许升级 | +| 情况 | 结果 | +| -------------------------- | ---------------------------------- | +| 固件版本 **高于** 当前版本 | 允许升级 | | 固件版本 **等于** 当前版本 | 拒绝，提示「版本号与当前版本相同」 | -| 固件版本 **低于** 当前版本 | 拒绝，提示「版本号低于当前版本」 | +| 固件版本 **低于** 当前版本 | 拒绝，提示「版本号低于当前版本」 | 不支持降级安装。如需回退版本，请联系技术支持。 @@ -130,7 +131,7 @@ Linkr KVM 支持通过 Web 管理界面上传固件包进行**本地升级**， ### 上传或升级失败 - 确认下载的是完整、未损坏的 `linkr-ota-*.bin` 文件，可尝试重新下载。 -- 检查浏览器与 KVM 之间的网络连接是否稳定。 +- 检查浏览器与灵控之间的网络连接是否稳定。 - 刷新页面后重新上传，避免同时开启多个升级任务。 - 升级失败后，设备通常仍运行原固件；若出现异常，可长按 FN 键 10 秒恢复出厂设置（会清除所有配置）。 @@ -148,7 +149,7 @@ Linkr KVM 支持通过 Web 管理界面上传固件包进行**本地升级**， ## 升级流程示意 -``` +```text GitHub Releases 下载 linkr-ota-*.bin ↓ 系统设置 → 系统更新 → 更新 @@ -167,4 +168,4 @@ GitHub Releases 下载 linkr-ota-*.bin - [固件下载（GitHub Releases）](https://github.com/radxa-linkr/linkr/releases) - [固件下载（百度网盘镜像，提取码 1234）](https://pan.baidu.com/s/1AZgLUDaU8hJKhZjqTT_sMQ?pwd=1234) - [产品概述 - LED 指示灯](./product-introduction#led-指示灯) -- [常见问题](./faq) +- [常见问题](#常见问题) diff --git a/docs/linkr/linkr-kvm/getting-started.mdx b/docs/linkr/linkr/getting-started.mdx similarity index 51% rename from docs/linkr/linkr-kvm/getting-started.mdx rename to docs/linkr/linkr/getting-started.mdx index 1686cd1ad4..14dd04687f 100644 --- a/docs/linkr/linkr-kvm/getting-started.mdx +++ b/docs/linkr/linkr/getting-started.mdx @@ -6,18 +6,18 @@ title: 快速上手指南 # 快速上手指南 -本指南帮助你在 **10～15 分钟**内完成 Linkr KVM 的首次接线、访问管理界面、账号配置，并看到被控电脑的远程画面。 +本指南帮助你在 **10～15 分钟**内完成瑞莎灵控（Radxa Linkr）的首次接线、访问管理界面、账号配置，并看到被控电脑的远程画面。 更完整的界面说明请参阅 [灵控 Web 使用指南](./usage)；硬件细节请参阅 [产品概述](./product-introduction)。 ## 你需要准备 -| 物品 | 说明 | -| --- | --- | -| Linkr KVM 设备 | 含 HDMI 线、USB Type-C 数据线 | -| 被控电脑 | 带 HDMI 输出和 USB 口（用于供电与键鼠） | +| 物品 | 说明 | +| ----------------- | ---------------------------------------- | +| 瑞莎灵控设备 | 含 HDMI 线、USB Type-C 数据线 | +| 被控电脑 | 带 HDMI 输出和 USB 口（用于供电与键鼠） | | 管理端电脑 / 手机 | 安装 Chrome 或 Edge 浏览器（建议最新版） | -| 网络 | 同一局域网，或先通过设备热点连接 | +| 网络 | 同一局域网，或先通过设备热点连接 | ## 第一步：连接硬件 @@ -29,30 +29,29 @@ title: 快速上手指南 ![img](/img/linkr/linkr-6.png) - 按以下方式接线： -1. **HDMI**：KVM 的 HDMI 公口 → 被控电脑 HDMI 输出口（采集画面）。 -2. **USB Type-C（OTG）**：KVM 尾部 OTG 口 → 被控电脑 USB 口（供电 + 模拟键鼠）。 +1. **HDMI**：灵控的 HDMI 公口 → 被控电脑 HDMI 输出口（采集画面）。 +2. **USB Type-C（OTG）**：灵控尾部 OTG 口 → 被控电脑 USB 口（供电 + 模拟键鼠）。 3. **网络**（任选其一）： - **USB Type-C（网口）** → 管理端电脑（直连，无需路由器）；或 - **USB Type-C（网口）** → 路由器 / 交换机（有线局域网）；或 - 稍后通过 Web 界面配置 **Wi-Fi**；或 - - 使用设备 **热点** 让管理端先连上 KVM。 + - 使用设备 **热点** 让管理端先连上灵控。 :::tip 接线提示 -OTG 口同时负责向 KVM 供电和向被控机注入键鼠信号，请使用质量可靠的数据线。网口 Type-C 用于 KVM 与管理端或路由器的网络通信——直连管理端电脑时，可通过 `linkr-usb.local` 访问（见下文）。 +OTG 口同时负责向灵控供电和向被控机注入键鼠信号，请使用质量可靠的数据线。网口 Type-C 用于灵控与管理端或路由器的网络通信——直连管理端电脑时，可通过 `linkr-usb.local` 访问（见下文）。 ::: ## 第二步：确认设备已就绪 接通电源后，观察 **FN 键旁的系统状态灯**： -| 指示灯 | 含义 | -| --- | --- | -| 蓝色闪烁 | 正在启动，请稍候 | +| 指示灯 | 含义 | +| ------------ | ------------------ | +| 蓝色闪烁 | 正在启动，请稍候 | | **蓝色常亮** | 系统正常，可以访问 | -| 绿色常亮 | 已有人在远程使用 | +| 绿色常亮 | 已有人在远程使用 | 同时可观察 **HDMI 侧视频灯**：亮起表示已检测到被控机视频信号。 @@ -64,8 +63,8 @@ OTG 口同时负责向 KVM 供电和向被控机注入键鼠信号，请使用 1. 在管理端浏览器打开 **https://linkr.now**。 2. 按页面提示 **授权访问本地网络**（浏览器需允许 mDNS / 本地网络发现）。 -3. （可选）在 KVM 上 **短按 FN 键一次**，帮助页面识别你的设备。 -4. 在设备列表中选择你的 KVM，进入管理界面。 +3. （可选）在灵控上 **短按 FN 键一次**，帮助页面识别你的设备。 +4. 在设备列表中选择你的灵控，进入管理界面。 ![img](/img/linkr/linkr-now-0.png) @@ -75,20 +74,20 @@ OTG 口同时负责向 KVM 供电和向被控机注入键鼠信号，请使用 若 linkr.now 无法发现设备，可尝试： -| 方式 | 地址 | 适用场景 | -| --- | --- | --- | -| mDNS（局域网） | `https://linkr.local` | 网口 Type-C 接路由器，或已通过 Wi-Fi 接入同一局域网 | -| mDNS（USB 直连） | `https://linkr-usb.local` | 网口 Type-C 直连管理端电脑，无需路由器 | -| mDNS（已初始化） | `https://linkr-<用户名>.local` | 完成首次配置后，局域网模式下也可使用该地址 | -| 设备 IP | `https://` | 已知 IP 时直接访问 | -| 热点 | 连接 Wi-Fi `linkr-<设备ID>` 后访问上述地址 | 尚无路由器网络时首次配置 | +| 方式 | 地址 | 适用场景 | +| ---------------- | ------------------------------------------ | --------------------------------------------------- | +| mDNS（局域网） | `https://linkr.local` | 网口 Type-C 接路由器，或已通过 Wi-Fi 接入同一局域网 | +| mDNS（USB 直连） | `https://linkr-usb.local` | 网口 Type-C 直连管理端电脑，无需路由器 | +| mDNS（已初始化） | `https://linkr-<用户名>.local` | 完成首次配置后，局域网模式下也可使用该地址 | +| 设备 IP | `https://<灵控的IP地址>` | 已知 IP 时直接访问 | +| 热点 | 连接 Wi-Fi `linkr-<设备ID>` 后访问上述地址 | 尚无路由器网络时首次配置 | #### mDNS 域名说明 -KVM 根据网口 Type-C 的连接方式自动切换 mDNS 主机名： +灵控根据网口 Type-C 的连接方式自动切换 mDNS 主机名： - **接路由器 / 交换机，或经 Wi-Fi 连入局域网**：使用 `linkr.local`（出厂默认）；完成首次配置后还可使用 `linkr-<用户名>.local`。 -- **直连管理端电脑**：KVM 通过 USB 网络与主控机通信，mDNS 域名为 **`linkr-usb.local`**，适合无路由器时开箱即用。 +- **直连管理端电脑**：灵控通过 USB 网络与主控机通信，mDNS 域名为 **`linkr-usb.local`**，适合无路由器时开箱即用。 :::tip USB 直连访问 将网口 Type-C 插入管理端电脑后，在浏览器地址栏输入 `https://linkr-usb.local` 即可打开管理界面（无需经过 linkr.now）。 @@ -98,17 +97,17 @@ KVM 根据网口 Type-C 的连接方式自动切换 mDNS 主机名： 通过 HTTPS 访问时，浏览器可能提示证书不受信任（自签名证书），选择继续访问即可。 ::: -若页面显示「连接丢失」，请检查：KVM 是否蓝灯常亮、管理端是否与 KVM 在同一网络、网线 / Wi-Fi 是否正常。详见下方 [常见问题](#常见问题)。 +若页面显示「连接丢失」，请检查：灵控是否蓝灯常亮、管理端是否与灵控在同一网络、网线 / Wi-Fi 是否正常。详见下方 [常见问题](#常见问题)。 ## 第四步：首次配置（新设备） 出厂未初始化的设备会进入 **首次配置** 页面，请设置： -| 项目 | 是否必填 | 说明 | -| --- | --- | --- | -| 用户名 | 必填 | 1～20 位，仅字母、数字、`-`；不能以 `-` 开头或结尾；不能为 `usb` | -| 登录密码 | 必填 | 至少 6 位，页面会显示密码强度 | -| 设备名称 | 选填 | 用于区分设备；填写后会校验域名唯一性 | +| 项目 | 是否必填 | 说明 | +| -------- | -------- | ---------------------------------------------------------------- | +| 用户名 | 必填 | 1～20 位，仅字母、数字、`-`；不能以 `-` 开头或结尾；不能为 `usb` | +| 登录密码 | 必填 | 至少 6 位，页面会显示密码强度 | +| 设备名称 | 选填 | 用于区分设备；填写后会校验域名唯一性 | 填写完成后提交，即完成初始化。在局域网模式下，设备 mDNS 名称将变为 `linkr-<用户名>.local`；USB 直连管理端时仍使用 `linkr-usb.local`。 @@ -139,22 +138,22 @@ KVM 根据网口 Type-C 的连接方式自动切换 mDNS 主机名： 2. 在画面上点击、移动，确认鼠标能控制被控电脑。 3. 敲击键盘，确认输入生效。 -详细功能说明请参阅 [用户页面指南](./page-display)。 +详细功能说明请参阅 [用户页面指南](./usage)。 ## 推荐的首批设置 完成首次连接后，建议按需配置： -| 设置 | 入口 | 文档 | -| --- | --- | --- | -| 连接 Wi-Fi | 左侧栏 → 网络设置 | [用户页面指南](./page-display) | -| 修改设备名称 | 系统设置 → 设备名称 | [用户页面指南](./page-display) | -| 远程访问（外网） | 高级设置 → Tailscale | [Tailscale 远程访问](./tailscale) | -| 固件升级 | 系统设置 → 系统更新 | [固件更新](./firmware-update) | +| 设置 | 入口 | 文档 | +| ---------------- | -------------------- | ---------------------------------------------------- | +| 连接 Wi-Fi | 左侧栏 → 网络设置 | [用户页面指南](./usage) | +| 修改设备名称 | 系统设置 → 设备名称 | [用户页面指南](./usage) | +| 远程访问（外网） | 高级设置 → Tailscale | [Tailscale 远程访问](./advanced-usage/remote-access) | +| 固件升级 | 系统设置 → 系统更新 | [固件更新](./firmware-update) | ## 全流程一览 -``` +```text 接线（HDMI + OTG + 网络） ↓ 系统蓝灯常亮 + 视频灯亮 @@ -172,16 +171,16 @@ KVM 根据网口 Type-C 的连接方式自动切换 mDNS 主机名： ### linkr.now 找不到设备 -- 确认 KVM 系统灯为蓝色常亮。 -- 确认管理端与 KVM 在同一局域网（或通过热点连接）。 +- 确认灵控系统灯为蓝色常亮。 +- 确认管理端与灵控在同一局域网（或通过热点连接）。 - 浏览器需允许本地网络访问权限；可尝试短按 FN 键后刷新页面。 - 局域网模式：改用 `https://linkr.local` 或 `https://linkr-<用户名>.local`。 - USB 直连模式：改用 `https://linkr-usb.local`。 -- 或直接输入 KVM IP 访问。 +- 或直接输入灵控 IP 访问。 ### 页面显示「连接丢失」 -- 检查 KVM 供电与网络是否正常。 +- 检查灵控供电与网络是否正常。 - 确认网线插紧，或 Wi-Fi 已正确配置。 - 点击页面上的 **刷新** 重试。 @@ -189,7 +188,7 @@ KVM 根据网口 Type-C 的连接方式自动切换 mDNS 主机名： - 确认被控电脑已开机且 HDMI 有输出。 - 检查 HDMI 线连接是否牢固。 -- 观察 KVM **视频状态灯** 是否亮起；闪烁表示信号异常。 +- 观察灵控**视频状态灯**是否亮起；闪烁表示信号异常。 ### 鼠标键盘无响应 @@ -202,10 +201,12 @@ KVM 根据网口 Type-C 的连接方式自动切换 mDNS 主机名： - 核对用户名大小写与密码。 - 若忘记密码，长按 FN 键 10 秒恢复出厂后重新初始化。 -更多问题请参阅 [常见问题](./faq)。 +更多问题请参阅 [常见问题](#常见问题)。 ## 下一步 -- [用户页面指南](./page-display) — 完整界面与功能说明 +- [用户页面指南](./usage) — 完整界面与功能说明 - [产品概述](./product-introduction) — 接口、指示灯、规格参数 -- [功能详解](./feature-details) — Tailscale、WOL、访问令牌等进阶功能 +- [Tailscale 远程访问](./advanced-usage/remote-access) — 外网安全访问 +- [Wake on LAN](./advanced-usage/wake-on-lan) — 远程唤醒被控主机 +- [访问令牌](./access-token) — API 访问与自动化 diff --git a/docs/linkr/linkr/product-introduction.mdx b/docs/linkr/linkr/product-introduction.mdx new file mode 100644 index 0000000000..40302eb0bd --- /dev/null +++ b/docs/linkr/linkr/product-introduction.mdx @@ -0,0 +1,132 @@ +--- +id: product-introduction +sidebar_position: 0 +title: 产品概述 +--- + +# 产品概述 + +瑞莎灵控（Radxa Linkr）是一款远程控制工具，基于 Web 的键盘鼠标远程显示方案打造，通过 HDMI 采集被控主机画面，经 USB 模拟键鼠输入，让你在任何有浏览器的终端上远程查看、操作目标电脑——无需安装专用客户端。 + +设备体积小巧，支持有线网络、Wi-Fi 与热点多种联网方式，并内置 Tailscale、Wake on LAN、访问令牌等高级能力，适合家庭实验室、远程运维与嵌入式开发等场景。 + +## 产品定位 + +瑞莎灵控定位于**轻量级、开箱即用的基于键盘鼠标的远程显示解决方案**： + +- **即插即用**：HDMI + USB Type-C 连接被控主机，浏览器打开管理页面即可使用 +- **Web 优先**：远程画面、键鼠控制、网络与系统管理统一在 Web 控制台完成 +- **场景友好**：兼顾桌面 PC、开发板、无头服务器等设备的远程维护需求 + +与传统机架式远程控制设备或纯软件远程桌面方案相比，瑞莎灵控在成本、部署复杂度和使用门槛之间取得平衡，适合个人开发者、小团队及教育场景。 + +## 目标用户 + +| 用户群体 | 典型场景 | +| -------------- | --------------------------------------------------- | +| 开发者与创客 | 远程调试开发板、无显示器环境下的系统安装与排障 | +| 家庭实验室用户 | 管理家中 NAS、软路由、备用 PC，无需额外显示器和键盘 | +| 运维与技术支持 | 远程协助用户操作电脑、抓取画面、发送控制指令 | +| 教育与培训 | 课堂演示、实验环境统一远程访问与管控 | + +## 核心价值 + +- **随时随地访问**：局域网、互联网（配合 Tailscale）均可连接管理界面 +- **完整远程操控**：视频采集 + 键鼠注入，体验接近本地操作 +- **一体化管理**：网络配置、固件升级、虚拟磁盘挂载、API 集成均在同一 Web 界面 +- **可扩展集成**：访问令牌支持截图、控制等公开 API，便于自动化与监控 + +## 产品外观 + +瑞莎灵控采用紧凑型设计，正面与侧面分布有 HDMI 接口、USB Type-C 接口、FN 功能键及状态指示灯。具体外观以实物为准，可参考产品包装或官方资料中的示意图。 + +![img](/img/linkr/linkr.jpg) + +## 接口与连接 + +| 接口 | 用途 | +| ------------------ | --------------------------------------------------- | +| HDMI 公口 | 接入被控主机，采集视频信号 | +| USB Type-C（OTG） | 供电与数据传输（模拟被控机的鼠标、键盘等 HID 设备） | +| USB Type-C（网口） | 有线以太网通信 | +| Wi-Fi | 连接无线网络 | +| 热点 | 设备作为 AP 共享网络 | + +### 连接说明 + +1. **HDMI 公口**：连接被控主机的 HDMI 视频输出，用于采集画面。 +2. **USB Type-C（OTG）**：同时承担供电与数据通道，向被控机提供键鼠等 USB HID 功能。 +3. **USB Type-C（网口）**：百兆有线网络，用于瑞莎灵控自身的网络通信。 +4. **Wi-Fi**：接入现有无线网络，免布线部署。 +5. **热点**：瑞莎灵控可作为热点，供其他终端连接以访问管理界面或共享网络。 + +典型接线方式：HDMI 连接被控机视频输出，OTG Type-C 连接被控机 USB 口（供电 + 键鼠），网口 Type-C 或 Wi-Fi 接入网络。 + +## LED 指示灯 + +设备 **FN 键** 两侧各有一颗指示灯： + +- **靠近 HDMI 一侧**：视频（HDMI）状态灯 +- **远离 HDMI 一侧**：系统状态灯（RGB，通过颜色表示运行状态） + +### 系统状态灯 + +| LED 状态 | 说明 | +| -------- | -------------------------- | +| 蓝色闪烁 | 系统启动中 | +| 蓝色常亮 | 系统正常运行 | +| 绿色常亮 | 正在被使用中（有活跃连接） | +| 白色闪烁 | 正在升级固件 | +| 白色常亮 | 正在重置系统 | + +### HDMI / 视频状态灯 + +| LED 状态 | 说明 | +| -------- | ------------------ | +| 灭 | 无视频信号 | +| 亮 | 有视频信号 | +| 闪烁 | 视频链路异常或错误 | + +通过观察指示灯，可在不打开 Web 界面的情况下快速判断设备与视频链路状态。 + +## FN 按钮 + +| 操作 | 功能 | +| ---------------- | ---------------------------------------------------------------- | +| **长按 ≥ 10 秒** | 重置系统（将所有配置恢复到出厂默认状态） | +| **短按一次** | 设备识别（用于 [linkr.now](https://linkr.now) 上的设备发现功能） | + +:::caution 注意 +长按 FN 键重置将清除所有本地配置（含网络、账号、Tailscale 绑定等），操作前请确认已备份必要信息。 +::: + +## 规格参数 + +| 项目 | 说明 | +| ---------- | ---------------------------------- | +| 视频编码 | 最高 2K@30fps，支持 H.264 或 MJPEG | +| 视频传输 | WebRTC、WebSocket | +| 以太网 | 百兆（100 Mbps） | +| USB 网卡 | 百兆（100 Mbps） | +| 存储 | 16 GB eMMC | +| 板载 Wi-Fi | 支持 | +| USB | 1× USB（Host/Device） | +| 供电 | USB 5 V | + +## 软件能力概览 + +除硬件远程控制能力外，瑞莎灵控固件与 Web 管理界面还提供： + +| 功能 | 说明 | 文档 | +| -------------- | ---------------------------------- | ---------------------------------------------------- | +| Web 远程控制台 | 视频、键鼠、截图、录屏、虚拟键盘等 | [用户页面指南](./usage) | +| Tailscale | 内置 VPN，无需公网 IP 远程访问 | [Tailscale 远程访问](./advanced-usage/remote-access) | +| Wake on LAN | 局域网魔术包唤醒被控主机 | [Wake on LAN](./advanced-usage/wake-on-lan) | +| 访问令牌 | API Key，支持截图与控制接口 | [访问令牌](./access-token) | + +## 相关链接 + +- [上手指南](./getting-started) +- [Tailscale 远程访问](./advanced-usage/remote-access) +- [Wake on LAN](./advanced-usage/wake-on-lan) +- [常见问题](./getting-started#常见问题) diff --git a/docs/linkr/linkr-kvm/usage.mdx b/docs/linkr/linkr/usage.mdx similarity index 93% rename from docs/linkr/linkr-kvm/usage.mdx rename to docs/linkr/linkr/usage.mdx index 572b49f0dc..4c9efbb770 100644 --- a/docs/linkr/linkr-kvm/usage.mdx +++ b/docs/linkr/linkr/usage.mdx @@ -17,7 +17,7 @@ sidebar_position: 2 - 管理虚拟磁盘挂载 `ISO/IMG` - 做系统级管理 `用户、密码、设备名、升级、重置、API Key` -简单理解：它把 **远程 KVM 操作 + 设备管理后台** 合在了一个 Web 页面里。 +简单理解：它把 **远程键鼠画面操作 + 设备管理后台** 合在了一个 Web 页面里。 --- @@ -112,13 +112,13 @@ sidebar_position: 2 左侧导航栏主菜单（从上到下）通常包括： -- [常用工具](#6-常用工具) -- [网络设置](#7-网络设置) -- [画面设置](#8-画面设置) -- [键盘与鼠标](#9-键盘与鼠标) -- [虚拟设备](#10-虚拟设备) -- [系统设置](#11-系统设置) -- [关于](#12-关于) +- [常用工具](#常用工具) +- [网络设置](#网络设置) +- [画面设置](#画面设置) +- [键盘与鼠标](#键盘与鼠标) +- [虚拟设备](#虚拟设备) +- [系统设置](#系统设置) +- [关于](#关于) 此外左侧导航栏底部有： @@ -464,7 +464,7 @@ sidebar_position: 2 作用： -- 供脚本/自动化工具访问接口时使用，详细文档请参考 [这里](/linkr/linkr-kvm/access-token) +- 供脚本/自动化工具访问接口时使用，详细文档请参考 [这里](/linkr/linkr/access-token) :::warning @@ -527,7 +527,7 @@ sidebar_position: 2 ## 关于 -包含：设备信息、用户协议、Radxa Linkr 介绍、日志下载。 +包含：设备信息、用户协议、瑞莎灵控介绍、日志下载。 ### 设备信息 @@ -546,7 +546,7 @@ sidebar_position: 2 - 在线查看最终用户许可协议内容 -### Radxa Linkr 介绍 +### 瑞莎灵控（Radxa Linkr）介绍 作用： @@ -575,12 +575,12 @@ sidebar_position: 2 作用： -- 配置 Tailscale 网络，实现跨设备安全通信，详细文档请参考 [这里](/linkr/linkr-kvm/advanced-usage/remote-access) +- 配置 Tailscale 网络，实现跨设备安全通信，详细文档请参考 [这里](/linkr/linkr/advanced-usage/remote-access) - 用于远程访问、文件共享、VPN 等场景 :::tip -使用 Tailscale 之前请确认 Linkr 能连接外部网络，通过 USB-C 转 RJ45 线或者 WiFi 连接路由器 +使用 Tailscale 之前请确认灵控能连接外部网络，通过 USB-C 转 RJ45 线或者 WiFi 连接路由器 ::: @@ -588,7 +588,7 @@ sidebar_position: 2 作用： -- 配置 MAC 设备唤醒，实现远程启动，详细文档请参考 [这里](/linkr/linkr-kvm/advanced-usage/wake-on-lan) +- 配置 MAC 设备唤醒，实现远程启动，详细文档请参考 [这里](/linkr/linkr/advanced-usage/wake-on-lan) - 用于在无电源时唤醒设备，保持连接状态 --- @@ -636,7 +636,7 @@ sidebar_position: 2 ## 一句话总结 -如果你把这个系统当成网页里的远程 KVM 控制台 + 设备管理中心，就能快速理解所有页面： +如果你把这个系统当成网页里的远程键鼠画面控制台 + 设备管理中心，就能快速理解所有页面： - 中间看画面 - 下方做即时控制 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/product-introduction.mdx b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/product-introduction.mdx deleted file mode 100644 index 42ebc98f39..0000000000 --- a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/product-introduction.mdx +++ /dev/null @@ -1,131 +0,0 @@ ---- -id: product-introduction -sidebar_position: 0 -title: Product Overview ---- - -# Product Overview - -Linkr KVM (Radxa Linkr KVM) is a web-based IP KVM device that captures the video output of a target host over HDMI and emulates keyboard/mouse input over USB, allowing you to remotely view and control the target computer from any browser-equipped terminal — no dedicated client software required. - -The device is compact, supports wired Ethernet, Wi-Fi, and hotspot connectivity, and ships with built-in capabilities such as Tailscale, Wake on LAN, and access tokens. It is well suited for home labs, remote operations and maintenance, and embedded development scenarios. - -## Product Positioning - -Linkr KVM is positioned as a **lightweight, ready-to-use hardware KVM-over-IP solution**: - -- **Plug and play**: Connect to the target host via HDMI + USB Type-C and use it directly from a browser-based management page. -- **Web-first**: Remote video, keyboard/mouse control, networking, and system management are all unified in the web console. -- **Scenario-friendly**: Equally suitable for remote maintenance of desktop PCs, development boards, and headless servers. - -Compared with traditional rack-mount KVM appliances or pure-software remote desktop solutions, Linkr KVM strikes a balance between cost, deployment complexity, and ease of use, making it ideal for individual developers, small teams, and educational scenarios. - -## Target Users - -| User Group | Typical Scenarios | -| --- | --- | -| Developers and makers | Remotely debug development boards, install and troubleshoot systems without a display | -| Home lab users | Manage home NAS, soft routers, and backup PCs without extra monitors or keyboards | -| Operations and technical support | Remotely assist users with computer operations, capture screens, and send control commands | -| Education and training | Classroom demonstrations, unified remote access and management of lab environments | - -## Core Value - -- **Access from anywhere**: Connect to the management interface from a LAN or over the Internet (in combination with Tailscale) -- **Full remote control**: Video capture + keyboard/mouse injection for an experience close to local operation -- **Unified management**: Network configuration, firmware upgrade, virtual disk mounting, and API integration are all in the same web interface -- **Extensible integration**: Access tokens support public APIs for screenshots, control, and more, enabling automation and monitoring - -## Product Appearance - -Linkr KVM uses a compact design, with the HDMI port, USB Type-C ports, the FN function key, and status indicator LEDs distributed on the front and side panels. The actual appearance is subject to the physical product. Refer to the product packaging or official materials for illustrative diagrams. - -![img](/img/linkr/linkr.jpg) - -## Interfaces and Connections - -| Interface | Purpose | -| --- | --- | -| HDMI male port | Connects to the target host, captures the video signal | -| USB Type-C (OTG) | Power supply and data transfer (emulates keyboard, mouse, and other HID devices on the target machine) | -| USB Type-C (network) | Wired Ethernet communication | -| Wi-Fi | Connect to a wireless network | -| Hotspot | The device acts as an AP to share the network | - -### Connection Description - -1. **HDMI male port**: Connects to the HDMI video output of the target host to capture the video. -2. **USB Type-C (OTG)**: Provides both power and a data channel; emulates USB HID devices (keyboard/mouse) on the target machine. -3. **USB Type-C (network)**: 100 Mbps wired network for the KVM device's own network communication. -4. **Wi-Fi**: Connects to an existing wireless network, eliminating the need for cabling. -5. **Hotspot**: The KVM can act as a hotspot for other terminals to access the management interface or share the network. - -Typical wiring: the HDMI port connects to the target machine's video output; the OTG Type-C port connects to the target machine's USB port (power + keyboard/mouse); the network Type-C port or Wi-Fi provides network connectivity. - -## LED Indicators - -There is one indicator LED on each side of the device's **FN key**: - -- **The one closer to the HDMI side**: Video (HDMI) status LED -- **The one farther from the HDMI side**: System status LED (RGB, indicates operating state by color) - -### System Status LED - -| LED State | Description | -| --- | --- | -| Flashing blue | System is starting up | -| Solid blue | System is running normally | -| Solid green | In active use (an active connection exists) | -| Flashing white | Firmware is being upgraded | -| Solid white | System is being reset | - -### HDMI / Video Status LED - -| LED State | Description | -| --- | --- | -| Off | No video signal | -| On | Video signal is present | -| Flashing | Video link is abnormal or in error | - -By observing the indicator LEDs, you can quickly determine the state of the device and the video link without opening the web interface. - -## FN Button - -| Action | Function | -| --- | --- | -| **Long press for 10 seconds or more** | Reset the system (restore all configuration to factory defaults) | -| **Short press once** | Device identification (used for the device discovery feature on [linkr.now](https://linkr.now)) | - -:::caution Note -A long-press reset of the FN key clears all local configuration (including network, account, Tailscale bindings, etc.). Make sure to back up any required information before performing this action. -::: - -## Specifications - -| Item | Description | -| --- | --- | -| Video encoding | Up to 2K@30fps, supports H.264 or MJPEG | -| Video transport | WebRTC, WebSocket | -| Ethernet | 100 Mbps | -| USB network | 100 Mbps | -| Storage | 16 GB eMMC | -| Onboard Wi-Fi | Supported | -| USB | 1× USB (Host/Device) | -| Power | USB 5 V | - -## Software Capabilities Overview - -In addition to the hardware KVM capabilities, the Linkr KVM firmware and the web management interface also provide: - -| Feature | Description | Documentation | -| --- | --- | --- | -| Web remote console | Video, keyboard/mouse, screenshots, recording, virtual keyboard, etc. | [User Interface Guide](./usage) | -| Tailscale | Built-in VPN, access the device remotely without a public IP | [Tailscale Remote Access](./tailscale) | -| Wake on LAN | Send a magic packet on the LAN to wake the target host | [Wake on LAN](./wake-on-lan) | -| Access tokens | API keys that support screenshot and control endpoints | [Access Tokens](./access-token) | - -## Related Links - -- [Getting Started Guide](./getting-started) -- [Feature Details](./feature-details) -- [FAQ](./faq) diff --git a/docs/linkr/linkr-kvm/README.md b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/README.md similarity index 76% rename from docs/linkr/linkr-kvm/README.md rename to i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/README.md index 876d100518..69032a5452 100644 --- a/docs/linkr/linkr-kvm/README.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/README.md @@ -2,6 +2,6 @@ sidebar_position: 2 --- -# 灵控 KVM +# Radxa Linkr diff --git a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/access-token.mdx b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/access-token.mdx similarity index 82% rename from i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/access-token.mdx rename to i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/access-token.mdx index f46492493e..ccc92a2a19 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/access-token.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/access-token.mdx @@ -4,7 +4,7 @@ sidebar_position: 5 # Access Tokens -Linkr KVM provides the **Access Token** feature for programmatically accessing some of the KVM's capabilities through the API without a web login session. It is suitable for automation scripts, monitoring integration, third-party tool calls, and similar scenarios. +Radxa Linkr provides the **Access Token** feature for programmatically accessing some of Linkr's capabilities through the API without a web login session. It is suitable for automation scripts, monitoring integration, third-party tool calls, and similar scenarios. An access token is the equivalent of an API key. Once created, it can be used to call the device's public API endpoints. @@ -13,15 +13,15 @@ An access token is the equivalent of an API key. Once created, it can be used to | Capability | Description | | --- | --- | | Web UI management | Create, view name, and delete access tokens in System Settings | -| Password verification | The KVM login password is required when generating a new token to prevent unauthorized creation | +| Password verification | The Linkr login password is required when generating a new token to prevent unauthorized creation | | One-time display | The plaintext token is only shown once at creation; it cannot be viewed again after the dialog is closed | | Persistent storage | Tokens are saved in the device's local configuration, remain valid after restart, and stay active until manually deleted | ## Applicable Scenarios -- **Remote screenshots**: Periodically capture the KVM's current screen snapshot for monitoring or inspection +- **Remote screenshots**: Periodically capture Linkr's current screen snapshot for monitoring or inspection - **Remote control**: Send control commands (keyboard, mouse, etc.) through the API -- **Automation integration**: Integrate the KVM into CI/CD, operations platforms, or custom scripts +- **Automation integration**: Integrate Linkr into CI/CD, operations platforms, or custom scripts :::caution Security Notice Access tokens have API access permissions comparable to the creator. Please keep them safe; do not commit them to public code repositories or share them with untrusted parties. If a token is leaked, delete it in the management interface and generate a new one immediately. @@ -31,7 +31,7 @@ Access tokens have API access permissions comparable to the creator. Please keep ### 1. Go to System Settings -1. Open the KVM management web interface and log in. +1. Open the Linkr management web interface and log in. 2. Click **System Settings** (the settings icon) in the left sidebar. 3. Find the **Access Tokens** collapsible panel. @@ -43,7 +43,7 @@ Access tokens have API access permissions comparable to the creator. Please keep - Must start with a letter or digit, and cannot start or end with `-` - Up to 20 characters - Examples: `monitor-script`, `ci-deploy-01` -3. Fill in the **User Password** (required): Enter the current KVM management account's login password for identity verification. +3. Fill in the **User Password** (required): Enter the current Linkr management account's login password for identity verification. 4. Click the green **Generate** button. ### 3. Save the Token @@ -82,7 +82,7 @@ curl -H "Authorization: token radxa_linkr_xxxxxxxx" \ --output snapshot.jpg ``` -Replace `` with the KVM's actual IP address or domain name (a LAN IP, Tailscale IP, etc. are all fine). +Replace `` with Linkr's actual IP address or domain name (a LAN IP, Tailscale IP, etc. are all fine). ### Available Public APIs @@ -113,7 +113,7 @@ curl -X POST \ "https://192.168.1.100/api/public/control" ``` -The format of the control data depends on the KVM control protocol. Refer to the API documentation or the integration SDK for the specific fields. +The format of the control data depends on the Linkr control protocol. Refer to the API documentation or the integration SDK for the specific fields. ### Authentication Failure @@ -122,7 +122,7 @@ If the response is `403 No Permission`, please check: - The `Authorization` header is in the format `token ` (note there is a single space between `token` and the token) - The token is complete and not truncated - The token has not been deleted -- The KVM device's IP address or network is reachable +- The Linkr device's IP address or network is reachable ## Token Format @@ -137,7 +137,7 @@ The name of each token must be unique on the device. You cannot create two token 1. **Principle of least privilege**: Create tokens with different names for different purposes so they can be revoked individually. 2. **Rotate regularly**: Periodically delete old tokens and generate new ones, especially after personnel changes or script migrations. 3. **Secure storage**: Use environment variables or secrets management tools to store tokens. Do not hardcode them in source code. -4. **HTTPS access**: In production, access the KVM API over HTTPS to prevent tokens from being intercepted in transit. +4. **HTTPS access**: In production, access the Linkr API over HTTPS to prevent tokens from being intercepted in transit. 5. **Revoke promptly**: If a token is leaked or no longer used, delete it in System Settings immediately. ## FAQ @@ -152,7 +152,7 @@ The secret name does not follow the rules. Please make sure that: ### "Wrong Password" Message -The user password entered when generating the token is not the KVM login password. Use the correct password of the current management account. +The user password entered when generating the token is not the Linkr login password. Use the correct password of the current management account. ### "Name Already Exists" Message diff --git a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/advanced-usage/README.md b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/advanced-usage/README.md similarity index 100% rename from i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/advanced-usage/README.md rename to i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/advanced-usage/README.md diff --git a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/advanced-usage/remote-access.mdx b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/advanced-usage/remote-access.mdx similarity index 81% rename from i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/advanced-usage/remote-access.mdx rename to i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/advanced-usage/remote-access.mdx index 35d79b4ee5..e64233bfdc 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/advanced-usage/remote-access.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/advanced-usage/remote-access.mdx @@ -4,7 +4,7 @@ sidebar_position: 1 # Tailscale Remote Access -Linkr KVM has a built-in [Tailscale](https://tailscale.com/) client that can join the device to your Tailscale virtual private network (VPN), allowing you to securely access the KVM management interface from anywhere over an encrypted tunnel, with no public IP or manual port forwarding required. +Radxa Linkr has a built-in [Tailscale](https://tailscale.com/) client that can join the device to your Tailscale virtual private network (VPN), allowing you to securely access the Linkr management interface from anywhere over an encrypted tunnel, with no public IP or manual port forwarding required. Tailscale is based on the WireGuard protocol. The Tailscale coordination server handles node discovery and key exchange, and devices establish point-to-point encrypted connections with each other. @@ -13,21 +13,21 @@ Tailscale is based on the WireGuard protocol. The Tailscale coordination server | Capability | Description | | --- | --- | | Built-in client | The firmware pre-installs the `tailscale` / `tailscaled` binaries; no extra installation is required | -| Web UI management | Enable, log in, and unbind the Tailscale account in the KVM management interface | +| Web UI management | Enable, log in, and unbind the Tailscale account in the Linkr management interface | | Auto-start on boot | Once enabled, the configuration persists and `tailscaled` starts automatically after the device reboots | | Secure networking | Traffic is encrypted by WireGuard; only devices within the same Tailnet can communicate with each other | ## Before You Start 1. **Tailscale account**: Register a personal or team account on [tailscale.com](https://tailscale.com/) (the free plan is sufficient for personal use). -2. **Network connection**: The KVM device must be able to access the Internet (RJ45 wired or Wi-Fi is fine) in order to communicate with the Tailscale coordination server. +2. **Network connection**: The Linkr device must be able to access the Internet (RJ45 wired or Wi-Fi is fine) in order to communicate with the Tailscale coordination server. 3. **Browser**: When binding an account, you need to complete Tailscale authorization in a browser. Please make sure the management browser allows pop-ups. ## Operation Steps ### 1. Go to the Settings Page -1. Open the KVM management web interface and log in. +1. Open the Linkr management web interface and log in. 2. In the left sidebar, go to **System** → **Advanced Settings**. 3. Find the **Tailscale** option. @@ -53,11 +53,11 @@ If the pop-up is blocked by the browser, please allow pop-ups for the current si ![img](/img/linkr/tailscale-3.png) -### 4. Access the KVM via Tailscale +### 4. Access Linkr via Tailscale After a successful binding, you can view the Tailscale IP assigned to the device (usually in the `100.x.x.x` range) in the [Tailscale admin console](https://login.tailscale.com/admin/machines). -On any device within the same Tailnet, use the following address to access the KVM: +On any device within the same Tailnet, use the following address to access Linkr: ``` https:// @@ -70,7 +70,7 @@ https://..ts.net ``` :::tip Note -When accessing through Tailscale, you still need to use the KVM's local login credentials (username and password). Tailscale only provides network-layer connectivity and does not replace KVM authentication. +When accessing through Tailscale, you still need to use Linkr's local login credentials (username and password). Tailscale only provides network-layer connectivity and does not replace Linkr authentication. ::: ### 5. Unbind the Account @@ -98,13 +98,13 @@ The Tailscale client is packaged into the firmware as built-in binaries: ### Relationship with Local Access -Enabling Tailscale does not affect the KVM's local network access. The device can still be accessed through the LAN IP, Wi-Fi, or USB network, and Tailscale works as an additional remote access channel on top of these. +Enabling Tailscale does not affect Linkr's local network access. The device can still be accessed through the LAN IP, Wi-Fi, or USB network, and Tailscale works as an additional remote access channel on top of these. ## FAQ ### Binding Fails or Has No Response for a Long Time -- Confirm that the KVM device is connected to the Internet. +- Confirm that the Linkr device is connected to the Internet. - Check whether the browser has blocked pop-ups. - Confirm that the Tailscale coordination server (`controlplane.tailscale.com`) is not blocked by a firewall. - Try turning Tailscale off and on again, then re-bind. @@ -112,7 +112,7 @@ Enabling Tailscale does not affect the KVM's local network access. The device ca ### Cannot Access via the Tailscale IP After Enabling - In the Tailscale admin console, confirm the device is online. -- Confirm that the accessing client and the KVM are in the same Tailnet. +- Confirm that the accessing client and Linkr are in the same Tailnet. - Check that the Tailscale client on the accessing device is connected. - Confirm that you are using the `https://` protocol and the correct Tailscale IP. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/advanced-usage/wake-on-lan.mdx b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/advanced-usage/wake-on-lan.mdx similarity index 70% rename from i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/advanced-usage/wake-on-lan.mdx rename to i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/advanced-usage/wake-on-lan.mdx index b42137e7f6..44dc11696f 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/advanced-usage/wake-on-lan.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/advanced-usage/wake-on-lan.mdx @@ -4,9 +4,9 @@ sidebar_position: 2 # Wake on LAN Device Wakeup -Linkr KVM supports **Wake on LAN (WOL)**, which lets you remotely power on a target computer that is shut down or in sleep mode by sending a Magic Packet from the KVM to the target's network card — no need to press the power button in person. +Radxa Linkr supports **Wake on LAN (WOL)**, which lets you remotely power on a target computer that is shut down or in sleep mode by sending a Magic Packet from Linkr to the target's network card — no need to press the power button in person. -The KVM and the target computer are usually in the same LAN through a network cable or a switch. After the wake-up packet is sent, the target machine will start up once it receives a broadcast packet that matches its MAC address. +Linkr and the target computer are usually in the same LAN through a network cable or a switch. After the wake-up packet is sent, the target machine will start up once it receives a broadcast packet that matches its MAC address. ## Feature Overview @@ -18,7 +18,7 @@ The KVM and the target computer are usually in the same LAN through a network ca ## Before You Start -Before using the KVM to wake up the target computer, please confirm that WOL has been correctly configured on the target machine: +Before using Linkr to wake up the target computer, please confirm that WOL has been correctly configured on the target machine: ### 1. Enable Wake on LAN in BIOS/UEFI @@ -49,8 +49,8 @@ sudo ethtool -s eth0 wol g ### 3. Network Connection Requirements -- After the target computer is powered off, the **wired network card** must remain physically connected to the network (network cable, switch, or the same LAN segment as the KVM). -- The KVM and the target computer should be in the **same Layer 2 broadcast domain** (same LAN or VLAN); the wake-up packet is sent as a UDP broadcast. +- After the target computer is powered off, the **wired network card** must remain physically connected to the network (network cable, switch, or the same LAN segment as Linkr). +- Linkr and the target computer should be in the **same Layer 2 broadcast domain** (same LAN or VLAN); the wake-up packet is sent as a UDP broadcast. - Wireless network cards generally have poor WOL support. It is recommended to use the MAC address of the wired network port. ### 4. Get the Target MAC Address @@ -61,13 +61,13 @@ With the target computer powered on, view the network card MAC address through a - Linux: `ip link show` - macOS: `ifconfig` -Write down the MAC address of the network card that is connected to the KVM's LAN. +Write down the MAC address of the network card that is connected to Linkr's LAN. ## Operation Steps ### 1. Go to Advanced Settings -1. Open the KVM management web interface and log in. +1. Open the Linkr management web interface and log in. 2. Click **Advanced Settings** (the gear icon) at the bottom of the left sidebar. 3. Find and expand the **Device Wakeup** collapsible panel on the page. @@ -93,7 +93,7 @@ Each section has two hexadecimal digits, for a total of 6 sections, separated by - **Send failed**: Please check the network connection and the WOL configuration on the target side, then try again. :::tip Note -"Sent successfully" means the KVM has successfully sent the Magic Packet. It does not guarantee that the target computer will start. If the target side has not correctly configured WOL or is not in the same broadcast domain, the computer may still not wake up. +"Sent successfully" means Linkr has successfully sent the Magic Packet. It does not guarantee that the target computer will start. If the target side has not correctly configured WOL or is not in the same broadcast domain, the computer may still not wake up. ::: ## How It Works @@ -101,11 +101,11 @@ Each section has two hexadecimal digits, for a total of 6 sections, separated by Wake on LAN uses the standard Magic Packet format: 1. The packet body consists of 6 bytes of `0xFF` header followed by 16 repetitions of the target MAC address, for a total of 102 bytes. -2. The KVM broadcasts the packet via UDP to `255.255.255.255:9` (the standard WOL port). +2. Linkr broadcasts the packet via UDP to `255.255.255.255:9` (the standard WOL port). 3. The target network card listens for link-layer traffic in a powered-off / sleeping state. Once it identifies its own MAC, the motherboard powers on. ``` -KVM management interface → Enter MAC → Click "Wake Up" +Linkr management interface → Enter MAC → Click "Wake Up" ↓ Construct Magic Packet (102 bytes) ↓ @@ -128,21 +128,21 @@ KVM management interface → Enter MAC → Click "Wake Up" - Confirm that you are using the **wired network card** MAC, and the network cable remains connected to the same LAN after power-off. - Check whether the motherboard has disabled power to the network card after shutdown (ErP, EuP, and other energy-saving options). - Some computers only support wake from **sleep / hibernation**, not from a full power-off (S5) state. -- If the KVM and the target computer are not in the same network segment or VLAN, the broadcast packet may not reach the target network card. +- If Linkr and the target computer are not in the same network segment or VLAN, the broadcast packet may not reach the target network card. ### Send Failed -- Confirm the KVM device's network is normal. Being able to access the management interface indicates basic connectivity. -- Check whether switches and routers between the KVM and the target device allow broadcast traffic to pass through. -- Try again later. If it continues to fail, restart the KVM's network service or check the firmware version. +- Confirm the Linkr device's network is normal. Being able to access the management interface indicates basic connectivity. +- Check whether switches and routers between Linkr and the target device allow broadcast traffic to pass through. +- Try again later. If it continues to fail, restart Linkr's network service or check the firmware version. ### How to Confirm Which Network Card's MAC Is Being Used -If the computer has multiple network cards (wired, wireless, virtual), use the **MAC of the wired network card that is actually connected to the KVM's LAN**. You can temporarily disable other network cards and run `ipconfig` / `ip link` to confirm. +If the computer has multiple network cards (wired, wireless, virtual), use the **MAC of the wired network card that is actually connected to Linkr's LAN**. You can temporarily disable other network cards and run `ipconfig` / `ip link` to confirm. ## Difference from the "Prevent Sleep" Feature -The KVM also provides a **Prevent Sleep** feature: when connected to a remote computer, it periodically sends a tiny mouse movement to prevent the system from going to sleep. This feature applies to a scenario where **the computer is already powered on and connected through the KVM**. +Linkr also provides a **Prevent Sleep** feature: when connected to a remote computer, it periodically sends a tiny mouse movement to prevent the system from going to sleep. This feature applies to a scenario where **the computer is already powered on and connected through Linkr**. **Wake on LAN (Device Wakeup)** is used to **remotely power on a computer that is already shut down or in deep sleep** by sending a magic packet over the network. The two features have different uses; choose the one that fits your scenario. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/develop-guide.mdx b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/develop-guide.mdx similarity index 93% rename from i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/develop-guide.mdx rename to i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/develop-guide.mdx index fe3c6cc823..c9da2bf124 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/develop-guide.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/develop-guide.mdx @@ -6,7 +6,7 @@ sidebar_position: 7 ## AI Agent Interface -By calling the HTTP interfaces provided by Linkr (including screenshots, keyboard, and mouse control), you can remotely automate operations on the target machine. +By calling the HTTP interfaces provided by Radxa Linkr (including screenshots, keyboard, and mouse control), you can remotely automate operations on the target machine. **Refer to the "How to generate an API Token" section in the user guide to obtain an API Token.** @@ -205,12 +205,12 @@ Only the following ASCII characters are supported: **Parameter description:** -- Index 0: The fixed string `"delay"`, indicating a pause to ensure that the IPKVM completes the previous operation. For example, used to ensure that a long text input completes. +- Index 0: The fixed string `"delay"`, indicating a pause to ensure that Linkr completes the previous operation. For example, used to ensure that a long text input completes. - Index 1: Field type: Number. The duration of the pause, in milliseconds. **Note:** -A delay event is usually required after a text input event to ensure that the IPKVM has enough time to fully process long text input. If the IPKVM needs a longer time to perform the operation, multiple delay events may be required. As a general rule, when the input text length is 30, a delay of 1000 milliseconds is needed. +A delay event is usually required after a text input event to ensure that Linkr has enough time to fully process long text input. If Linkr needs a longer time to perform the operation, multiple delay events may be required. As a general rule, when the input text length is 30, a delay of 1000 milliseconds is needed. **Example:** diff --git a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/firmware-update.mdx b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/firmware-update.mdx similarity index 73% rename from i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/firmware-update.mdx rename to i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/firmware-update.mdx index f1eadfd1ff..475a515ffc 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/firmware-update.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/firmware-update.mdx @@ -6,7 +6,7 @@ title: Firmware Update # Firmware Update -Linkr KVM supports **local upgrade** by uploading a firmware package through the web management interface, which is used to obtain new features, bug fixes, and security updates. The firmware file is downloaded from GitHub Releases, and the device automatically verifies, decrypts, and installs it after upload. +Radxa Linkr supports **local upgrade** by uploading a firmware package through the web management interface, which is used to obtain new features, bug fixes, and security updates. The firmware file is downloaded from GitHub Releases, and the device automatically verifies, decrypts, and installs it after upload. :::info Current Version Firmware download page: [https://github.com/radxa-linkr/linkr/releases](https://github.com/radxa-linkr/linkr/releases) @@ -18,7 +18,7 @@ Latest release example: `linkr-ota-1.0.1.bin` (the version number in the file na 1. **Check the current version**: In **About → Device Information**, view the "Current Firmware Version" and compare it with the version to be installed to make sure it is a higher version. 2. **Download the firmware package**: Visit [GitHub Releases](https://github.com/radxa-linkr/linkr/releases), and download the `linkr-ota-.bin` file from the **Assets** section of the corresponding version to your local computer. -3. **Keep the network stable**: Please keep the connection between the browser and the KVM during the upgrade process; do not close the page or disconnect the network. +3. **Keep the network stable**: Please keep the connection between the browser and Linkr during the upgrade process; do not close the page or disconnect the network. 4. **Reserve storage space**: The firmware package is about 50-60 MB, and the device needs to have enough free space. If space is insufficient, the message "Insufficient storage space" will be displayed. 5. **Avoid interruption**: During the upgrade, the device's system indicator LED is **flashing white** (see [Product Overview](./product-introduction)). Do not power off or unplug cables. @@ -26,7 +26,7 @@ Latest release example: `linkr-ota-1.0.1.bin` (the version number in the file na ### 1. Go to System Update -1. Open the KVM management web interface and log in. +1. Open the Linkr management web interface and log in. 2. Click **System Settings** (the settings icon) in the left sidebar. 3. Find the **System Update** row, and click the **Update** button on the right. @@ -50,11 +50,11 @@ After upload starts, the interface will display a progress bar and the current s The upgrade is divided into the following stages: -| Stage | UI Message | Description | -| --- | --- | --- | -| Uploading | Uploading... | The firmware file is transferred from the browser to the KVM device | -| Upgrading | Upgrading... | The device verifies the signature, decrypts, and writes the firmware | -| Complete | Upgraded, please restart the device | The installation is complete; takes effect after restart | +| Stage | UI Message | Description | +| --------- | ----------------------------------- | --------------------------------------------------------------------- | +| Uploading | Uploading... | The firmware file is transferred from the browser to the Linkr device | +| Upgrading | Upgrading... | The device verifies the signature, decrypts, and writes the firmware | +| Complete | Upgraded, please restart the device | The installation is complete; takes effect after restart | You can click **Cancel** to abort the operation during the upgrade (it is recommended not to cancel once installation is nearly complete). @@ -67,7 +67,7 @@ When the progress reaches 100% and the message **Upgraded, please restart the de 3. In **About → Device Information**, confirm that the firmware version has been updated. :::caution Note -A restart will briefly interrupt the KVM service and remote connection. Please perform the upgrade in an appropriate time window, and make sure that the target host will not be affected by the KVM restart. +A restart will briefly interrupt the Linkr service and remote connection. Please perform the upgrade in an appropriate time window, and make sure that the target host will not be affected by the Linkr restart. ::: ## Download the Firmware @@ -84,11 +84,11 @@ A restart will briefly interrupt the KVM service and remote connection. Please p ### File Description -| Item | Description | -| --- | --- | -| File format | `linkr-ota-.bin` (encrypted OTA firmware package) | -| Typical size | About 50-60 MB | -| Source | Download only from the official GitHub Releases. Do not use files from unknown sources | +| Item | Description | +| ------------ | -------------------------------------------------------------------------------------- | +| File format | `linkr-ota-.bin` (encrypted OTA firmware package) | +| Typical size | About 50-60 MB | +| Source | Download only from the official GitHub Releases. Do not use files from unknown sources | ### China Mirror (Baidu Pan) @@ -98,20 +98,21 @@ For users in mainland China where GitHub access may be slow or limited, a Baidu - **Extraction code**: `1234` :::caution Verification & Security + - The mirror keeps the same firmware versions as the official GitHub Releases. After downloading, please confirm the file name is still `linkr-ota-.bin`. - If the GitHub Releases page provides a SHA256 for the same version, please compare the hash before uploading to the device. - If the Baidu Pan share link is no longer valid, please use the [GitHub Releases](https://github.com/radxa-linkr/linkr/releases) as the source of truth. -::: + ::: ## Version Rules The device automatically verifies the firmware version before installation: -| Case | Result | -| --- | --- | -| Firmware version **higher than** the current version | Allowed to upgrade | -| Firmware version **equal to** the current version | Rejected, with the message "The version number is the same as the current version" | -| Firmware version **lower than** the current version | Rejected, with the message "The version number is lower than the current version" | +| Case | Result | +| ---------------------------------------------------- | ---------------------------------------------------------------------------------- | +| Firmware version **higher than** the current version | Allowed to upgrade | +| Firmware version **equal to** the current version | Rejected, with the message "The version number is the same as the current version" | +| Firmware version **lower than** the current version | Rejected, with the message "The version number is lower than the current version" | Downgrade installation is not supported. To roll back to a previous version, please contact technical support. @@ -130,7 +131,7 @@ The firmware package needs to be written to the device's local storage. Please d ### Upload or Upgrade Failed - Confirm that the downloaded `linkr-ota-*.bin` file is complete and not corrupted. Try downloading it again. -- Check whether the network connection between the browser and the KVM is stable. +- Check whether the network connection between the browser and Linkr is stable. - Refresh the page and re-upload. Avoid running multiple upgrade tasks at the same time. - After an upgrade failure, the device usually still runs the original firmware. If there is an abnormality, you can long-press the FN key for 10 seconds to restore factory settings (this will clear all configuration). @@ -148,7 +149,7 @@ The current web interface is mainly **local upgrade**: first download the firmwa ## Upgrade Process Overview -``` +```text Download linkr-ota-*.bin from GitHub Releases ↓ System Settings → System Update → Update @@ -167,4 +168,4 @@ Log in again and confirm the version number - [Firmware Download (GitHub Releases)](https://github.com/radxa-linkr/linkr/releases) - [Firmware Download (Baidu Pan mirror, extraction code 1234)](https://pan.baidu.com/s/1AZgLUDaU8hJKhZjqTT_sMQ?pwd=1234) - [Product Overview - LED Indicators](./product-introduction#led-indicators) -- [FAQ](./faq) +- [FAQ](#faq) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/getting-started.mdx b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/getting-started.mdx similarity index 52% rename from i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/getting-started.mdx rename to i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/getting-started.mdx index 8b06262fa3..f150fc51c6 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/getting-started.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/getting-started.mdx @@ -6,18 +6,18 @@ title: Getting Started Guide # Getting Started Guide -This guide helps you complete the initial wiring of your Linkr KVM, access the management interface, configure the account, and view the remote desktop of the target computer within **10 to 15 minutes**. +This guide helps you complete the initial wiring of your Radxa Linkr, access the management interface, configure the account, and view the remote desktop of the target computer within **10 to 15 minutes**. For a more complete interface description, see the [Linkr Web User Guide](./usage). For hardware details, see [Product Overview](./product-introduction). ## What You Need -| Item | Description | -| --- | --- | -| Linkr KVM device | Includes an HDMI cable and a USB Type-C data cable | -| Target computer | Has an HDMI output and a USB port (used for power and keyboard/mouse) | -| Management computer / phone | Install Chrome or Edge browser (latest version recommended) | -| Network | The same LAN, or connect via the device's hotspot first | +| Item | Description | +| --------------------------- | --------------------------------------------------------------------- | +| Radxa Linkr device | Includes an HDMI cable and a USB Type-C data cable | +| Target computer | Has an HDMI output and a USB port (used for power and keyboard/mouse) | +| Management computer / phone | Install Chrome or Edge browser (latest version recommended) | +| Network | The same LAN, or connect via the device's hotspot first | ## Step 1: Connect the Hardware @@ -31,27 +31,27 @@ Method 2 (USB to RJ45, long distance): Wire everything up as follows: -1. **HDMI**: KVM's HDMI male port → target computer's HDMI output port (capture the video). -2. **USB Type-C (OTG)**: KVM's tail OTG port → target computer's USB port (power + emulate keyboard/mouse). +1. **HDMI**: Linkr's HDMI male port → target computer's HDMI output port (capture the video). +2. **USB Type-C (OTG)**: Linkr's tail OTG port → target computer's USB port (power + emulate keyboard/mouse). 3. **Network** (choose one of the following): - **USB Type-C (network)** → management computer (direct connection, no router needed); or - **USB Type-C (network)** → router / switch (wired LAN); or - Configure **Wi-Fi** later through the web interface; or - - Use the device's **hotspot** to let the management computer connect to the KVM first. + - Use the device's **hotspot** to let the management computer connect to Linkr first. :::tip Wiring Tips -The OTG port is responsible for both powering the KVM and injecting keyboard/mouse signals into the target machine, so please use a reliable data cable. The network Type-C port is used for communication between the KVM and the management computer or router. When directly connected to a management computer, it can be accessed via `linkr-usb.local` (see below). +The OTG port is responsible for both powering Linkr and injecting keyboard/mouse signals into the target machine, so please use a reliable data cable. The network Type-C port is used for communication between Linkr and the management computer or router. When directly connected to a management computer, it can be accessed via `linkr-usb.local` (see below). ::: ## Step 2: Confirm the Device Is Ready After powering on, observe the **system status LED next to the FN key**: -| Indicator | Meaning | -| --- | --- | -| Flashing blue | Starting up, please wait | +| Indicator | Meaning | +| -------------- | ----------------------------------- | +| Flashing blue | Starting up, please wait | | **Solid blue** | System is normal, you can access it | -| Solid green | Someone is remotely using it | +| Solid green | Someone is remotely using it | You can also observe the **HDMI-side video LED**: it lights up to indicate that a video signal from the target machine has been detected. @@ -63,8 +63,8 @@ We recommend using [linkr.now](https://linkr.now) to discover the device on the 1. Open **https://linkr.now** in the browser on the management computer. 2. Follow the on-page prompts to **grant local network access** (the browser needs to allow mDNS / local network discovery). -3. (Optional) **Short-press the FN key once** on the KVM to help the page identify your device. -4. Select your KVM in the device list and enter the management interface. +3. (Optional) **Short-press the FN key once** on Linkr to help the page identify your device. +4. Select your Linkr in the device list and enter the management interface. ![img](/img/linkr/linkr-now-0.png) @@ -74,20 +74,20 @@ We recommend using [linkr.now](https://linkr.now) to discover the device on the If linkr.now cannot discover the device, try the following: -| Method | Address | Applicable Scenario | -| --- | --- | --- | -| mDNS (LAN) | `https://linkr.local` | The network Type-C is connected to a router, or already connected to the same LAN via Wi-Fi | -| mDNS (USB direct) | `https://linkr-usb.local` | The network Type-C is directly connected to a management computer, no router required | -| mDNS (initialized) | `https://linkr-.local` | After the initial configuration is complete, this address can also be used in LAN mode | -| Device IP | `https://` | Direct access when the IP is known | -| Hotspot | Connect to the Wi-Fi `linkr-` and then use the address above | Initial configuration when no router network is available | +| Method | Address | Applicable Scenario | +| ------------------ | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| mDNS (LAN) | `https://linkr.local` | The network Type-C is connected to a router, or already connected to the same LAN via Wi-Fi | +| mDNS (USB direct) | `https://linkr-usb.local` | The network Type-C is directly connected to a management computer, no router required | +| mDNS (initialized) | `https://linkr-.local` | After the initial configuration is complete, this address can also be used in LAN mode | +| Device IP | `https://` | Direct access when the IP is known | +| Hotspot | Connect to the Wi-Fi `linkr-` and then use the address above | Initial configuration when no router network is available | #### mDNS Domain Name Description -The KVM automatically switches the mDNS hostname according to how the network Type-C is connected: +Linkr automatically switches the mDNS hostname according to how the network Type-C is connected: - **Connected to a router / switch, or joined the LAN via Wi-Fi**: Uses `linkr.local` (factory default); after the initial configuration is complete, `linkr-.local` is also available. -- **Directly connected to a management computer**: The KVM communicates with the management computer over the USB network, and the mDNS domain name is **`linkr-usb.local`**, which is suitable for out-of-the-box use without a router. +- **Directly connected to a management computer**: Linkr communicates with the management computer over the USB network, and the mDNS domain name is **`linkr-usb.local`**, which is suitable for out-of-the-box use without a router. :::tip USB Direct Connection Access After plugging the network Type-C into a management computer, enter `https://linkr-usb.local` in the browser address bar to open the management interface (no need to go through linkr.now). @@ -97,17 +97,17 @@ After plugging the network Type-C into a management computer, enter `https://lin When accessing over HTTPS, the browser may warn that the certificate is not trusted (self-signed certificate). Just choose to continue. ::: -If the page shows "Connection Lost", please check: whether the KVM's blue LED is solid on, whether the management computer and the KVM are on the same network, and whether the network cable / Wi-Fi is working. See [FAQ](#faq) below for details. +If the page shows "Connection Lost", please check: whether Linkr's blue LED is solid on, whether the management computer and Linkr are on the same network, and whether the network cable / Wi-Fi is working. See [FAQ](#faq) below for details. ## Step 4: Initial Configuration (New Device) A factory-uninitialized device will enter the **Initial Configuration** page. Please set: -| Item | Required | Description | -| --- | --- | --- | -| Username | Required | 1-20 characters, only letters, numbers, `-`; cannot start or end with `-`; cannot be `usb` | -| Login password | Required | At least 6 characters; the page shows password strength | -| Device name | Optional | Used to distinguish devices; the page validates domain name uniqueness after entry | +| Item | Required | Description | +| -------------- | -------- | ------------------------------------------------------------------------------------------ | +| Username | Required | 1-20 characters, only letters, numbers, `-`; cannot start or end with `-`; cannot be `usb` | +| Login password | Required | At least 6 characters; the page shows password strength | +| Device name | Optional | Used to distinguish devices; the page validates domain name uniqueness after entry | Submit the form to complete initialization. In LAN mode, the device's mDNS name will become `linkr-.local`; for direct USB connection to a management computer, `linkr-usb.local` is still used. @@ -138,22 +138,22 @@ Quick verification that everything is working: 2. Click and move on the screen to confirm that the mouse can control the target computer. 3. Type on the keyboard to confirm that the input takes effect. -For a detailed description of the functions, see the [User Interface Guide](./page-display). +For a detailed description of the functions, see the [User Interface Guide](./usage). ## Recommended Initial Settings After completing the first connection, we recommend configuring the following as needed: -| Setting | Entry | Documentation | -| --- | --- | --- | -| Connect to Wi-Fi | Left sidebar → Network Settings | [User Interface Guide](./page-display) | -| Change device name | System Settings → Device Name | [User Interface Guide](./page-display) | -| Remote access (external network) | Advanced Settings → Tailscale | [Tailscale Remote Access](./tailscale) | -| Firmware upgrade | System Settings → System Update | [Firmware Update](./firmware-update) | +| Setting | Entry | Documentation | +| -------------------------------- | ------------------------------- | --------------------------------------------------------- | +| Connect to Wi-Fi | Left sidebar → Network Settings | [User Interface Guide](./usage) | +| Change device name | System Settings → Device Name | [User Interface Guide](./usage) | +| Remote access (external network) | Advanced Settings → Tailscale | [Tailscale Remote Access](./advanced-usage/remote-access) | +| Firmware upgrade | System Settings → System Update | [Firmware Update](./firmware-update) | ## Full Process Overview -``` +```text Wiring (HDMI + OTG + Network) ↓ Solid blue system LED + video LED on @@ -171,16 +171,16 @@ Configure network, Tailscale, firmware, etc. as needed ### linkr.now Cannot Find the Device -- Confirm the KVM system LED is solid blue. -- Confirm the management computer and the KVM are on the same LAN (or connected via hotspot). +- Confirm the Linkr system LED is solid blue. +- Confirm the management computer and Linkr are on the same LAN (or connected via hotspot). - The browser needs to allow local network access. Try a short press of the FN key and then refresh the page. - LAN mode: Use `https://linkr.local` or `https://linkr-.local` instead. - USB direct mode: Use `https://linkr-usb.local` instead. -- Or enter the KVM's IP address directly. +- Or enter Linkr's IP address directly. ### Page Shows "Connection Lost" -- Check that the KVM's power and network are normal. +- Check that Linkr's power and network are normal. - Make sure the network cable is plugged in tightly, or Wi-Fi is properly configured. - Click **Refresh** on the page to retry. @@ -188,7 +188,7 @@ Configure network, Tailscale, firmware, etc. as needed - Confirm the target computer is powered on and has HDMI output. - Check that the HDMI cable is firmly connected. -- Observe whether the KVM's **video status LED** is on; flashing means the signal is abnormal. +- Observe whether Linkr's **video status LED** is on; flashing means the signal is abnormal. ### Mouse and Keyboard Are Not Responding @@ -201,10 +201,12 @@ Configure network, Tailscale, firmware, etc. as needed - Double-check the username case and the password. - If you forgot the password, long-press the FN key for 10 seconds to restore factory settings and reinitialize. -For more questions, see [FAQ](./faq). +For more questions, see [FAQ](#faq). ## Next Steps -- [User Interface Guide](./page-display) — Complete interface and feature description +- [User Interface Guide](./usage) — Complete interface and feature description - [Product Overview](./product-introduction) — Interfaces, indicator LEDs, specifications -- [Feature Details](./feature-details) — Tailscale, WOL, access tokens, and other advanced features +- [Tailscale Remote Access](./advanced-usage/remote-access) — Secure remote access +- [Wake on LAN](./advanced-usage/wake-on-lan) — Remotely wake the target host +- [Access Tokens](./access-token) — API access and automation diff --git a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/product-introduction.mdx b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/product-introduction.mdx new file mode 100644 index 0000000000..81e5c8ca54 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/product-introduction.mdx @@ -0,0 +1,132 @@ +--- +id: product-introduction +sidebar_position: 0 +title: Product Overview +--- + +# Product Overview + +Radxa Linkr is a web-based remote control tool that delivers a keyboard/mouse-driven remote display solution. It captures the video output of a target host over HDMI and emulates keyboard/mouse input over USB, allowing you to remotely view and control the target computer from any browser-equipped terminal — no dedicated client software required. + +The device is compact, supports wired Ethernet, Wi-Fi, and hotspot connectivity, and ships with built-in capabilities such as Tailscale, Wake on LAN, and access tokens. It is well suited for home labs, remote operations and maintenance, and embedded development scenarios. + +## Product Positioning + +Radxa Linkr is positioned as a **lightweight, ready-to-use hardware solution for remote keyboard/mouse display**: + +- **Plug and play**: Connect to the target host via HDMI + USB Type-C and use it directly from a browser-based management page. +- **Web-first**: Remote video, keyboard/mouse control, networking, and system management are all unified in the web console. +- **Scenario-friendly**: Equally suitable for remote maintenance of desktop PCs, development boards, and headless servers. + +Compared with traditional rack-mount remote control appliances or pure-software remote desktop solutions, Radxa Linkr strikes a balance between cost, deployment complexity, and ease of use, making it ideal for individual developers, small teams, and educational scenarios. + +## Target Users + +| User Group | Typical Scenarios | +| -------------------------------- | ------------------------------------------------------------------------------------------ | +| Developers and makers | Remotely debug development boards, install and troubleshoot systems without a display | +| Home lab users | Manage home NAS, soft routers, and backup PCs without extra monitors or keyboards | +| Operations and technical support | Remotely assist users with computer operations, capture screens, and send control commands | +| Education and training | Classroom demonstrations, unified remote access and management of lab environments | + +## Core Value + +- **Access from anywhere**: Connect to the management interface from a LAN or over the Internet (in combination with Tailscale) +- **Full remote control**: Video capture + keyboard/mouse injection for an experience close to local operation +- **Unified management**: Network configuration, firmware upgrade, virtual disk mounting, and API integration are all in the same web interface +- **Extensible integration**: Access tokens support public APIs for screenshots, control, and more, enabling automation and monitoring + +## Product Appearance + +Linkr uses a compact design, with the HDMI port, USB Type-C ports, the FN function key, and status indicator LEDs distributed on the front and side panels. The actual appearance is subject to the physical product. Refer to the product packaging or official materials for illustrative diagrams. + +![img](/img/linkr/linkr.jpg) + +## Interfaces and Connections + +| Interface | Purpose | +| -------------------- | ------------------------------------------------------------------------------------------------------ | +| HDMI male port | Connects to the target host, captures the video signal | +| USB Type-C (OTG) | Power supply and data transfer (emulates keyboard, mouse, and other HID devices on the target machine) | +| USB Type-C (network) | Wired Ethernet communication | +| Wi-Fi | Connect to a wireless network | +| Hotspot | The device acts as an AP to share the network | + +### Connection Description + +1. **HDMI male port**: Connects to the HDMI video output of the target host to capture the video. +2. **USB Type-C (OTG)**: Provides both power and a data channel; emulates USB HID devices (keyboard/mouse) on the target machine. +3. **USB Type-C (network)**: 100 Mbps wired network for the Linkr device's own network communication. +4. **Wi-Fi**: Connects to an existing wireless network, eliminating the need for cabling. +5. **Hotspot**: Linkr can act as a hotspot for other terminals to access the management interface or share the network. + +Typical wiring: the HDMI port connects to the target machine's video output; the OTG Type-C port connects to the target machine's USB port (power + keyboard/mouse); the network Type-C port or Wi-Fi provides network connectivity. + +## LED Indicators + +There is one indicator LED on each side of the device's **FN key**: + +- **The one closer to the HDMI side**: Video (HDMI) status LED +- **The one farther from the HDMI side**: System status LED (RGB, indicates operating state by color) + +### System Status LED + +| LED State | Description | +| -------------- | ------------------------------------------- | +| Flashing blue | System is starting up | +| Solid blue | System is running normally | +| Solid green | In active use (an active connection exists) | +| Flashing white | Firmware is being upgraded | +| Solid white | System is being reset | + +### HDMI / Video Status LED + +| LED State | Description | +| --------- | ---------------------------------- | +| Off | No video signal | +| On | Video signal is present | +| Flashing | Video link is abnormal or in error | + +By observing the indicator LEDs, you can quickly determine the state of the device and the video link without opening the web interface. + +## FN Button + +| Action | Function | +| ------------------------------------- | ----------------------------------------------------------------------------------------------- | +| **Long press for 10 seconds or more** | Reset the system (restore all configuration to factory defaults) | +| **Short press once** | Device identification (used for the device discovery feature on [linkr.now](https://linkr.now)) | + +:::caution Note +A long-press reset of the FN key clears all local configuration (including network, account, Tailscale bindings, etc.). Make sure to back up any required information before performing this action. +::: + +## Specifications + +| Item | Description | +| --------------- | --------------------------------------- | +| Video encoding | Up to 2K@30fps, supports H.264 or MJPEG | +| Video transport | WebRTC, WebSocket | +| Ethernet | 100 Mbps | +| USB network | 100 Mbps | +| Storage | 16 GB eMMC | +| Onboard Wi-Fi | Supported | +| USB | 1× USB (Host/Device) | +| Power | USB 5 V | + +## Software Capabilities Overview + +In addition to the hardware remote control capabilities, the Linkr firmware and the web management interface also provide: + +| Feature | Description | Documentation | +| ------------------ | --------------------------------------------------------------------- | --------------------------------------------------------- | +| Web remote console | Video, keyboard/mouse, screenshots, recording, virtual keyboard, etc. | [User Interface Guide](./usage) | +| Tailscale | Built-in VPN, access the device remotely without a public IP | [Tailscale Remote Access](./advanced-usage/remote-access) | +| Wake on LAN | Send a magic packet on the LAN to wake the target host | [Wake on LAN](./advanced-usage/wake-on-lan) | +| Access tokens | API keys that support screenshot and control endpoints | [Access Tokens](./access-token) | + +## Related Links + +- [Getting Started Guide](./getting-started) +- [Tailscale Remote Access](./advanced-usage/remote-access) +- [Wake on LAN](./advanced-usage/wake-on-lan) +- [FAQ](./getting-started#faq) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/usage.mdx b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/usage.mdx similarity index 96% rename from i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/usage.mdx rename to i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/usage.mdx index ce55099c7b..6c2707a9ab 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr-kvm/usage.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/linkr/linkr/usage.mdx @@ -17,7 +17,7 @@ The Linkr Web is a web-based console for remotely managing target devices (compu - Manage virtual disk mounts `ISO/IMG` - Perform system-level management `user, password, device name, upgrade, reset, API Key` -In short: it combines a **remote KVM client and a device management backend** into a single web page. +In short: it combines a **remote keyboard/mouse video client and a device management backend** into a single web page. *** @@ -437,7 +437,7 @@ Functions: Purpose: -- Used by scripts / automation tools to access the API. For detailed documentation, see [here](/linkr/linkr-kvm/access-token) +- Used by scripts / automation tools to access the API. For detailed documentation, see [here](/linkr/linkr/access-token) :::warning @@ -544,7 +544,7 @@ Includes: Tailscale, MAC device wakeup Purpose: -- Configure the Tailscale network for secure cross-device communication. For detailed documentation, see [here](/linkr/linkr-kvm/advanced-usage/remote-access) +- Configure the Tailscale network for secure cross-device communication. For detailed documentation, see [here](/linkr/linkr/advanced-usage/remote-access) - Used for remote access, file sharing, VPN, and other scenarios :::tip @@ -557,7 +557,7 @@ Before using Tailscale, make sure Linkr can connect to the external network via Purpose: -- Configure MAC device wakeup to start the device remotely. For detailed documentation, see [here](/linkr/linkr-kvm/advanced-usage/wake-on-lan) +- Configure MAC device wakeup to start the device remotely. For detailed documentation, see [here](/linkr/linkr/advanced-usage/wake-on-lan) - Used to wake the device when no power is available, keeping the connection alive *** @@ -605,7 +605,7 @@ We recommend getting familiar with the system in this order: ## One-Sentence Summary -If you treat this system as a web-based remote KVM console and a device management center combined, you can quickly understand all the pages: +If you treat this system as a web-based remote keyboard/mouse video console and a device management center combined, you can quickly understand all the pages: - Middle: view the screen - Bottom: instant control diff --git a/i18n/en/docusaurus-theme-classic/navbar.json b/i18n/en/docusaurus-theme-classic/navbar.json index 978927c193..ab10bd366e 100644 --- a/i18n/en/docusaurus-theme-classic/navbar.json +++ b/i18n/en/docusaurus-theme-classic/navbar.json @@ -227,9 +227,9 @@ "message": "Single Board Computers", "description": "Navbar item with label 主板" }, - "item.label.远程控制工具": { - "message": "Linkr KVM", - "description": "Navbar item with label 远程控制工具" + "item.label.灵控": { + "message": "Linkr", + "description": "Navbar item with label 灵控" }, "logo.alt": { "message": "Radxa",