跳转至

Docker 安装

本文介绍如何使用 Docker 部署 One-KVM。

前提条件

  • 系统要求：Linux 操作系统（推荐 Debian/Ubuntu），安装好 Docker 软件。
  • 硬件准备：启用 USB OTG 或插好 CH340+CH9329 HID 线（用于 HID 模拟），插好 USB 视频采集卡。

启动容器

容器分为 one-kvm 和 one-kvm-full 两个版本，区别是前者只有 One-KVM 主程序和 ttyd 程序，后者会附带第三方软件来实现一些可选的扩展功能（如 gotsc 和 easytier-core）。可以根据自己的需求选择对应的镜像。

1
2
3
4
docker run --name one-kvm -itd --privileged=true \
  -v /dev:/dev  -v /sys/:/sys \
  --net=host \
  silentwind0/one-kvm-full

如果网络条件不佳，可使用阿里云镜像仓库加速下载，将命令中的 silentwind0/one-kvm-full 替换为 registry.cn-hangzhou.aliyuncs.com/silentwind/one-kvm-full，silentwind0/one-kvm同理。

访问 Web 界面

打开浏览器访问 http://<设备IP>:8080

首次访问

首次访问时，系统会引导您完成初始配置，包括创建管理员账户。

OTG 使用说明

如果你使用需要使用 OTG ，请确保系统开启 OTG 功能并使能了 OTG 端口。

执行 ls /sys/class/udc 命令返回为空说明你的设备没有 USB OTG 端口或没有开启设置 USB 端口为 OTG 模式，如果是后者可尝试修改设备树 dtb。

执行 ls /sys/kernel/config 命令返回的文件中如果没有 usb_gadget 可能是没有加载 libcomposite 内核模块，可以手动加载或在 /etc/modprobe.d/ 目录下新建内核模块自动加载规则文件。手动加载命令为 modprobe libcomposite,需要在 IPKVM 程序启动之前加载。

最后一步就是使能 OTG 端口为 device 状态。如果设备树 dtb 中 USB OTG端口配置属性 dr_mode 为 peripheral,则开机后OTG 端口为 device 状态。但更常见的情况是设备树 dtb 中 USB OTG 端口配置属性 dr_mode 为 otg，需要手动使能。这个使能命令因不同 CPU 平台（全志、晶晨、瑞芯微等）而异，具体命令可能需要查看文档或网络上查找对应资料。确定有效后把命令可以放入 /etc/rc.local 开机自启脚本里面，便宜开机自动使能 OTG 端口。

实例：晶晨平台 OTG 使能命令

1
2
3
4
#查看当前 USB OTG 状态
cat /sys/devices/platform/soc/*/usb_role/*/role
#手动使能 OTG 端口
echo "device" > /sys/devices/platform/soc/*/usb_role/*/role

配置选项

环境变量

变量名 默认值 说明
TZ UTC 时区设置
HTTP_PORT 8080 HTTP 端口
HTTPS_PORT 8443 HTTPS 端口
ENABLE_HTTPS false 是否启用 HTTPS 服务（值：true/false）
DATA_DIR /data 数据目录
VERBOSE 0 日志详细程度：1（-v）、2（-vv）、3（-vvv），数值越大日志越详细

说明

  • 启用 HTTPS 时，无需额外挂载证书文件，系统使用默认自签名证书。
  • --privileged=true 和 -v /dev:/dev -v /sys:/sys 是硬件访问必需的配置，目前不可省略。后面会支持细化目录和权限。
  • --net=host 模式确保端口映射直接生效，无需额外配置 -p 参数映射端口。

继续阅读：用户界面