Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 0 additions & 131 deletions docs/linkr/linkr-kvm/product-introduction.mdx

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
sidebar_position: 2
---

# Linkr KVM
# 瑞莎灵控

<DocCardList />
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 5

# 访问令牌

Linkr KVM 提供 **访问令牌(Access Token)** 功能,用于在无需 Web 登录会话的情况下,通过 API 以编程方式访问 KVM 的部分能力。适用于自动化脚本、监控集成、第三方工具调用等场景。
瑞莎灵控(Radxa Linkr)提供 **访问令牌(Access Token)** 功能,用于在无需 Web 登录会话的情况下,通过 API 以编程方式访问灵控的部分能力。适用于自动化脚本、监控集成、第三方工具调用等场景。

访问令牌等同于 API Key,创建后可用于调用设备的公开 API 接口。

Expand All @@ -13,15 +13,15 @@ Linkr KVM 提供 **访问令牌(Access Token)** 功能,用于在无需 Web
| 能力 | 说明 |
| ------------ | ------------------------------------------------------ |
| Web 界面管理 | 在系统设置中创建、查看名称、删除访问令牌 |
| 密码验证 | 生成新令牌时需输入 KVM 登录密码,防止未授权创建 |
| 密码验证 | 生成新令牌时需输入灵控登录密码,防止未授权创建 |
| 一次性展示 | 令牌明文仅在创建成功时显示一次,关闭弹窗后无法再次查看 |
| 持久保存 | 令牌保存在设备本地配置中,重启后仍然有效,直至手动删除 |

## 适用场景

- **远程截图**:定时获取 KVM 当前画面快照,用于监控或巡检
- **远程截图**:定时获取灵控当前画面快照,用于监控或巡检
- **远程控制**:通过 API 发送控制指令(键盘、鼠标等)
- **自动化集成**:将 KVM 接入 CI/CD、运维平台或自定义脚本
- **自动化集成**:将灵控接入 CI/CD、运维平台或自定义脚本

:::caution 安全提示
访问令牌拥有与创建者相当的 API 访问权限。请妥善保管,切勿提交到公开代码仓库或分享给不可信方。若令牌泄露,请立即在管理界面删除并重新生成。
Expand All @@ -31,7 +31,7 @@ Linkr KVM 提供 **访问令牌(Access Token)** 功能,用于在无需 Web

### 1. 进入系统设置

1. 打开 KVM 管理 Web 界面并登录。
1. 打开灵控管理 Web 界面并登录。
2. 点击左侧边栏的 **系统设置**(设置图标)。
3. 找到 **访问令牌** 折叠面板。

Expand All @@ -43,7 +43,7 @@ Linkr KVM 提供 **访问令牌(Access Token)** 功能,用于在无需 Web
- 必须以字母或数字开头,不能以 `-` 开头或结尾
- 最长 20 个字符
- 示例:`monitor-script`、`ci-deploy-01`
3. 填写 **用户密码**(必填):输入当前 KVM 管理账号的登录密码,用于身份验证。
3. 填写 **用户密码**(必填):输入当前灵控管理账号的登录密码,用于身份验证。
4. 点击绿色 **生成** 按钮。

### 3. 保存令牌
Expand All @@ -70,7 +70,7 @@ Linkr KVM 提供 **访问令牌(Access Token)** 功能,用于在无需 Web

在 HTTP 请求头中携带访问令牌:

```http
```text
Authorization: token <你的访问令牌>
```

Expand All @@ -82,7 +82,7 @@ curl -H "Authorization: token radxa_linkr_xxxxxxxx" \
--output snapshot.jpg
```

请将 `<kvm-ip>` 替换为 KVM 的实际 IP 地址或域名(本地局域网 IP、Tailscale IP 等均可)。
请将 `<kvm-ip>` 替换为灵控的实际 IP 地址或域名(本地局域网 IP、Tailscale IP 等均可)。

### 可用公开 API

Expand Down Expand Up @@ -113,7 +113,7 @@ curl -X POST \
"https://192.168.1.100/api/public/control"
```

控制数据的格式取决于 KVM 控制协议,具体字段请参考 API 文档或集成 SDK。
控制数据的格式取决于灵控控制协议,具体字段请参考 API 文档或集成 SDK。

### 认证失败

Expand All @@ -122,7 +122,7 @@ curl -X POST \
- `Authorization` 头格式是否为 `token <令牌>`(注意 `token` 与令牌之间有一个空格)
- 令牌是否完整、未被截断
- 该令牌是否已被删除
- KVM 设备 IP 或网络是否可达
- 灵控设备 IP 或网络是否可达

## 令牌格式说明

Expand All @@ -137,7 +137,7 @@ curl -X POST \
1. **最小权限原则**:为不同用途创建不同名称的令牌,便于单独吊销。
2. **定期轮换**:建议定期删除旧令牌并重新生成,尤其在人员变动或脚本迁移后。
3. **安全存储**:使用环境变量或密钥管理工具存放令牌,不要硬编码在源码中。
4. **HTTPS 访问**:生产环境建议通过 HTTPS 访问 KVM API,避免令牌在传输中被窃听。
4. **HTTPS 访问**:生产环境建议通过 HTTPS 访问灵控 API,避免令牌在传输中被窃听。
5. **及时吊销**:发现泄露或不再使用时,立即在系统设置中删除对应令牌。

## 常见问题
Expand All @@ -152,7 +152,7 @@ curl -X POST \

### 提示密码错误

生成令牌时输入的用户密码与 KVM 登录密码不一致。请使用当前管理账号的正确密码。
生成令牌时输入的用户密码与灵控登录密码不一致。请使用当前管理账号的正确密码。

### 提示名称已被占用

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 协调服务器负责节点发现与密钥交换,设备之间建立点对点加密连接。

Expand All @@ -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** 配置项。

Expand All @@ -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>
Expand All @@ -70,7 +70,7 @@ https://<设备主机名>.<你的-tailnet>.ts.net
```

:::tip 提示
通过 Tailscale 访问时,仍需使用 KVM 的本地登录凭据(用户名与密码),Tailscale 仅提供网络层连通性,不替代 KVM 的身份认证
通过 Tailscale 访问时,仍需使用灵控的本地登录凭据(用户名与密码),Tailscale 仅提供网络层连通性,不替代灵控的身份认证
:::

### 5. 解绑账号
Expand Down Expand Up @@ -98,21 +98,21 @@ Tailscale 客户端以内置二进制形式打包进固件:

### 与本地访问的关系

启用 Tailscale 不会影响 KVM 的本地网络访问方式。设备仍可通过局域网 IP、Wi-Fi 或 USB 网络等方式访问,Tailscale 作为额外的远程访问通道叠加使用。
启用 Tailscale 不会影响灵控的本地网络访问方式。设备仍可通过局域网 IP、Wi-Fi 或 USB 网络等方式访问,Tailscale 作为额外的远程访问通道叠加使用。

## 常见问题

### 绑定失败或长时间无响应

- 确认 KVM 设备已连接互联网
- 确认灵控设备已连接互联网
- 检查浏览器是否拦截了弹出窗口。
- 确认 Tailscale 协调服务器(`controlplane.tailscale.com`)未被防火墙阻断。
- 尝试关闭后重新启用 Tailscale,再次绑定。

### 启用后无法通过 Tailscale IP 访问

- 在 Tailscale 管理后台确认设备在线(Online)。
- 确认访问端与 KVM 在同一 Tailnet 内。
- 确认访问端与灵控在同一 Tailnet 内。
- 检查访问端 Tailscale 客户端是否已连接。
- 确认使用的是 `https://` 协议及正确的 Tailscale IP。

Expand Down
Loading
Loading