diff --git a/README.md b/README.md index a5026f93..36c07b2e 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,97 @@ -

logo

-

简体中文

-

 

+
+ One-KVM Logo +

One-KVM

+

基于 PiKVM 的 DIY IP-KVM 解决方案

+ + [![GitHub stars](https://img.shields.io/github/stars/mofeng-git/One-KVM?style=social)](https://github.com/mofeng-git/One-KVM/stargazers) + [![GitHub forks](https://img.shields.io/github/forks/mofeng-git/One-KVM?style=social)](https://github.com/mofeng-git/One-KVM/network/members) + [![GitHub issues](https://img.shields.io/github/issues/mofeng-git/One-KVM)](https://github.com/mofeng-git/One-KVM/issues) + [![GitHub license](https://img.shields.io/github/license/mofeng-git/One-KVM)](https://github.com/mofeng-git/One-KVM/blob/master/LICENSE) + +

+ 📖 详细文档 • + 🚀 在线演示 • + ⚡ 快速开始 • + 📊 功能介绍 +

+
-### 项目介绍 +--- -**One-KVM** 是一款基于经济实惠的硬件和强大的开源 [PiKVM](https://github.com/pikvm/pikvm) 软件进行二次开发的 DIY IP-KVM 解决方案。它旨在为您提供**BIOS 级别**的远程服务器或工作站管理能力，如同您亲身坐在屏幕前操作一般。 +## 📋 目录 -**核心优势：** +- [项目概述](#项目概述) +- [功能介绍](#功能介绍) +- [快速开始](#快速开始) +- [贡献指南](#贡献指南) +- [其他](#其他) -* **完全无侵入:** 无需在目标机器上安装任何软件或驱动，不依赖操作系统，可远程访问 BIOS/UEFI 设置、进行系统安装或故障排查。 -* **低成本实现:** 利用常见的廉价硬件（如旧安卓盒子、开发板等）即可搭建，大幅降低 KVM over IP 的门槛。 -* **功能丰富:** 在 PiKVM 基础上，增加了 Docker 部署、视频录制、简体中文界面优化等多项实用功能 (详见下方功能对比)。 -* **部署灵活:** 支持 Docker 快速部署，并为特定硬件平台（如玩客云、我家云等）提供开箱即用的整合包。 +## 📖 项目概述 -无论您是需要管理家庭实验室、办公室服务器，还是希望为特定嵌入式设备添加远程管理能力，One-KVM 都提供了一个高性价比且功能强大的选择。 +**One-KVM** 是基于开源 [PiKVM](https://github.com/pikvm/pikvm) 项目进行二次开发的 DIY IP-KVM 解决方案。该方案利用成本较低的硬件设备，实现 BIOS 级别的远程服务器或工作站管理功能。 -**快速访问:** +### 应用场景 -* **详细使用文档:** [https://one-kvm.mofeng.run](https://one-kvm.mofeng.run) -* **在线演示:** [https://kvmd-demo.mofeng.run](https://kvmd-demo.mofeng.run) +- **家庭实验室主机管理** - 远程管理服务器和开发设备 +- **服务器远程维护** - 无需物理接触即可进行系统维护 +- **系统故障处理** - 远程解决系统启动和 BIOS 相关问题 ![One-KVM 界面截图](https://github.com/user-attachments/assets/a7848bca-e43c-434e-b812-27a45fad7910) -### 软件功能 +## 📊 功能介绍 -表格仅为 One-KVM 与其他基于 PiKVM 的项目的功能对比，无不良导向，如有错漏请联系更正。 +### 核心特性 -| 功能 | One-KVM | PiKVM | ArmKVM | BLIKVM | -| :-------------------: | :-------------: | :-----------------------: | :---------: | :---------: | -| 系统开源 | √ | √ | √ | √ | -| 简体中文 WebUI | √ | x | √ | √ | -| 远程视频流 | MJPEG/H.264 | MJPEG/H.264 | MJPEG/H.264 | MJPEG/H.264 | -| H.264 视频编码 | CPU | GPU | 未知 | GPU | -| 远程音频流 | √ | √ | √ | √ | -| 远程鼠键控制 | OTG/CH9329 | OTG/CH9329/Pico/Bluetooth | OTG | OTG | -| VNC 控制 | √ | √ | √ | √ | -| ATX 电源控制 | GPIO/USB 继电器 | GPIO | GPIO | GPIO | -| 虚拟存储驱动器挂载 | √ | √ | √ | √ | -| 2.2G 以上 CD-ROM 挂载 | x | x | √ | √ | -| WOL 远程唤醒 | √ | √ | √ | √ | -| 网页剪切板 | √ | √ | √ | √ | -| OCR 文字识别 | √ | √ | √ | √ | -| 网页终端 | √ | √ | √ | √ | -| 网络串口终端 | x | x | √ | √ | -| HDMI 切换器支持 | √ | √ | √ | √ | -| 视频录制 | √ | x | x | x | -| Docker 部署 | √ | x | x | x | -| 官方商业化成品 | x | √ | √ | √ | -| 技术支持 | √ | √ | √ | √ | +| 特性 | 描述 | 优势 | +|------|------|------| +| **无侵入性** | 无需在目标机器上安装软件或驱动 | 不依赖操作系统，可访问 BIOS/UEFI 设置 | +| **成本效益** | 利用常见硬件设备（如电视盒子、开发板等） | 降低 KVM over IP 的实现成本 | +| **功能扩展** | 在 PiKVM 基础上增加实用功能 | Docker 部署、视频录制、中文界面 | +| **部署方式** | 支持 Docker 部署和硬件整合包 | 为特定硬件平台提供预配置方案 | -### 快速开始 +### 项目限制 -更多详细内容可以查阅 [One-KVM文档](https://one-kvm.mofeng.run/)。 +本项目为个人维护的开源项目，资源有限，无商业运营计划 -**方式一：Docker 镜像部署（推荐）** +- 不提供内置免费内网穿透服务，相关问题请自行解决 +- 不提供24×7小时技术支持服务 +- 不承诺系统稳定性和合规性，使用风险需自行承担 +- 尽力优化用户体验，但仍需要一定的技术基础 -Docker 版本可以使用 OTG 或 CH9329 作为虚拟 HID ，支持 amd64、arm64、armv7 架构的 Linux 系统安装。 +### 功能对比 -**脚本部署** +> 💡 **说明：** 以下表格展示了 One-KVM 与其他基于 PiKVM 项目的功能对比，仅供参考。如有遗漏或错误，欢迎联系更正。 + +| 功能特性 | One-KVM | PiKVM | ArmKVM | BLIKVM | +|:--------:|:-------:|:-----:|:------:|:------:| +| 简体中文 WebUI | ✅ | ❌ | ✅ | ✅ | +| 远程视频流 | MJPEG/H.264 | MJPEG/H.264 | MJPEG/H.264 | MJPEG/H.264 | +| H.264 视频编码 | CPU | GPU | 未知 | GPU | +| 远程音频流 | ✅ | ✅ | ✅ | ✅ | +| 远程鼠键控制 | OTG/CH9329 | OTG/CH9329/Pico/Bluetooth | OTG | OTG | +| VNC 控制 | ✅ | ✅ | ✅ | ✅ | +| ATX 电源控制 | GPIO/USB 继电器 | GPIO | GPIO | GPIO | +| 虚拟存储驱动器挂载 | ✅ | ✅ | ✅ | ✅ | +| 网页终端 | ✅ | ✅ | ✅ | ✅ | +| Docker 部署 | ✅ | ❌ | ❌ | ❌ | +| 商业化运营 | ❌ | ✅ | ✅ | ✅ | + +## ⚡ 快速开始 + +### 方式一：Docker 镜像部署（推荐） + +Docker 版本支持 OTG 或 CH9329 作为虚拟 HID，兼容 amd64、arm64、armv7 架构的 Linux 系统。 + +#### 一键脚本部署 ```bash curl -sSL https://one-kvm.mofeng.run/quick_start.sh -o quick_start.sh && bash quick_start.sh ``` -**手动部署** +#### 手动部署 + +**使用 OTG 作为虚拟 HID：** -如果使用 OTG 作为虚拟 HID，可以使用如下部署命令： ```bash sudo docker run --name kvmd -itd --privileged=true \ -v /lib/modules:/lib/modules:ro -v /dev:/dev \ @@ -74,7 +100,8 @@ sudo docker run --name kvmd -itd --privileged=true \ silentwind0/kvmd ``` -如果使用 CH9329 作为虚拟 HID，可以使用如下部署命令： +**使用 CH9329 作为虚拟 HID：** + ```bash sudo docker run --name kvmd -itd \ --device /dev/video0:/dev/video0 \ @@ -84,118 +111,159 @@ sudo docker run --name kvmd -itd \ silentwind0/kvmd ``` -**方式二：直刷 One-KVM 整合包** +### 方式二：直刷 One-KVM 整合包 -对于部分平台硬件，本项目制作了深度适配的 One-KVM 打包镜像，开箱即用，刷好后启动设备就可以开始使用 One-KVM。免费 One-KVM 整合包也可以在本项目 Releases 页可以找到。 +针对特定硬件平台，提供了预配置的 One-KVM 打包镜像，简化部署流程，实现开箱即用。 -| 整合包适配概况 | | | | -| :-------------: | :-------------: | :-------------: | :-------------: | -| **固件型号** | **固件代号** | **硬件情况** | **最新版本** | -| 玩客云 | Onecloud | USB 采集卡、OTG | 241018 | -| 私家云二代 | Cumebox2 | USB 采集卡、OTG | 241004 | -| Vmare | Vmare-uefi | USB 采集卡、CH9329 | 241004 | -| Virtualbox | Virtualbox-uefi | USB 采集卡、CH9329 | 241004 | -| s905l3a 通用包 | E900v22c | USB 采集卡、OTG | 241004 | -| 我家云 | Chainedbox | USB 采集卡、OTG | 241004 | -| 龙芯久久派 | 2k0300 | USB 采集卡、CH9329 | 241025 | +#### 固件下载 -### 文件下载 +**GitHub 下载：** +- **GitHub Releases：** [https://github.com/mofeng-git/One-KVM/releases](https://github.com/mofeng-git/One-KVM/releases) -Github：https://github.com/mofeng-git/One-KVM/releases +**其他下载方式：** +- **免登录下载：** [https://pan.huang1111.cn/s/mxkx3T1](https://pan.huang1111.cn/s/mxkx3T1) （由 Huang1111公益计划 提供） +- **百度网盘：** [https://pan.baidu.com/s/166-2Y8PBF4SbHXFkGmFJYg?pwd=o9aj](https://pan.baidu.com/s/166-2Y8PBF4SbHXFkGmFJYg?pwd=o9aj) （提取码：o9aj） -免登录高速下载地址：https://pan.huang1111.cn/s/mxkx3T1 （由 Huang1111公益计划 赞助） +#### 支持的硬件平台 -百度网盘（需登录）：https://pan.baidu.com/s/166-2Y8PBF4SbHXFkGmFJYg?pwd=o9aj +| 固件型号 | 固件代号 | 硬件配置 | 最新版本 | 状态 | +|:--------:|:--------:|:--------:|:--------:|:----:| +| 玩客云 | Onecloud | USB 采集卡、OTG | 241018 | ✅ | +| 私家云二代 | Cumebox2 | USB 采集卡、OTG | 241004 | ✅ | +| Vmare | Vmare-uefi | USB 采集卡、CH9329 | 241004 | ✅ | +| Virtualbox | Virtualbox-uefi | USB 采集卡、CH9329 | 241004 | ✅ | +| s905l3a 通用包 | E900v22c | USB 采集卡、OTG | 241004 | ✅ | +| 我家云 | Chainedbox | USB 采集卡、OTG | 241004 | ✅ | +| 龙芯久久派 | 2k0300 | USB 采集卡、CH9329 | 241025 | ✅ | -### 赞助方式 +## 🤝 贡献指南 -这个项目基于众多开源项目二次开发，作者为此花费了大量的时间和精力进行测试和维护。若此项目对您有用，您可以考虑通过 **[为爱发电](https://afdian.com/a/silentwind)** 赞助一笔小钱支持作者。作者将能有更多的金钱来测试和维护 One-KVM 的各种配置，并在项目上投入更多的时间和精力。 +欢迎各种形式的贡献！ -**感谢名单** +### 如何贡献 + +1. **Fork 本仓库** +2. **创建功能分支：** `git checkout -b feature/AmazingFeature` +3. **提交更改：** `git commit -m 'Add some AmazingFeature'` +4. **推送到分支：** `git push origin feature/AmazingFeature` +5. **提交 Pull Request** + +### 报告问题 + +如果您发现了问题，请： +1. 使用 [GitHub Issues](https://github.com/mofeng-git/One-KVM/issues) 报告 +2. 提供详细的错误信息和复现步骤 +3. 包含您的硬件配置和系统信息 + +### 赞助支持 + +本项目基于多个优秀开源项目进行二次开发，作者投入了大量时间进行测试和维护。如果您觉得这个项目有价值，欢迎通过 **[为爱发电](https://afdian.com/a/silentwind)** 支持项目发展。 + +#### 感谢名单
+点击查看感谢名单 -浩龙的电子嵌入式之路（赞助） +- 浩龙的电子嵌入式之路 -Tsuki（赞助） +- Tsuki -H_xiaoming +- H_xiaoming -0蓝蓝0 +- 0蓝蓝0 -fairybl +- fairybl -Will +- Will -浩龙的电子嵌入式之路 +- 浩龙的电子嵌入式之路 -自.知 +- 自.知 -观棋不语٩ ི۶ +- 观棋不语٩ ི۶ -爱发电用户_a57a4 +- 爱发电用户_a57a4 -爱发电用户_2c769 +- 爱发电用户_2c769 -霜序 +- 霜序 -[远方](https://runyf.cn/)（闲鱼用户名：小远技术店铺） +- 远方（闲鱼用户名：小远技术店铺） -爱发电用户_399fc +- 爱发电用户_399fc -[斐斐の](https://www.mmuaa.com/) +- 斐斐の -爱发电用户_09451 +- 爱发电用户_09451 -超高校级的錆鱼 +- 超高校级的錆鱼 -爱发电用户_08cff +- 爱发电用户_08cff -guoke +- guoke -mgt +- mgt -姜沢掵 +- 姜沢掵 -ui_beam +- ui_beam -爱发电用户_c0dd7 +- 爱发电用户_c0dd7 -爱发电用户_dnjK +- 爱发电用户_dnjK -忍者胖猪 +- 忍者胖猪 -永遠の願い +- 永遠の願い -爱发电用户_GBrF +- 爱发电用户_GBrF -爱发电用户_fd65c +- 爱发电用户_fd65c -爱发电用户_vhNa +- 爱发电用户_vhNa -爱发电用户_Xu6S +- 爱发电用户_Xu6S -moss +- moss -woshididi +- woshididi -爱发电用户_a0fd1 +- 爱发电用户_a0fd1 -爱发电用户_f6bH +- 爱发电用户_f6bH + +- 码农 + +- 爱发电用户_6639f + +- jeron + +- 爱发电用户_CN7y + +- 爱发电用户_Up6w + +- 爱发电用户_e3202 + +- ...... -......
-本项目 CDN 加速及安全防护由 [Tencent EdgeOne](https://edgeone.ai/zh?from=github) 赞助 +#### 赞助商 + +本项目得到以下赞助商的支持： + +**CDN 加速及安全防护：** +- **[Tencent EdgeOne](https://edgeone.ai/zh?from=github)** - 提供 CDN 加速及安全防护服务 + ![Tencent EdgeOne](https://edgeone.ai/media/34fe3a45-492d-4ea4-ae5d-ea1087ca7b4b.png) -本项目使用了下列开源项目： -1. [pikvm/pikvm: Open and inexpensive DIY IP-KVM based on Raspberry Pi (github.com)](https://github.com/pikvm/pikvm) +**文件存储服务：** +- **[Huang1111公益计划](https://pan.huang1111.cn/s/mxkx3T1)** - 提供免登录下载服务 -### 项目状态 +## 📚 其他 -[![Star History Chart](https://api.star-history.com/svg?repos=mofeng-git/One-KVM&type=Date)](https://star-history.com/#mofeng-git/One-KVM&Date) - -![Github](https://repobeats.axiom.co/api/embed/7cfaab47e31073107771a7179078aa2a6c3f1108.svg "Repobeats analytics image") +### 使用的开源项目 +本项目基于以下优秀开源项目进行二次开发： +- [PiKVM](https://github.com/pikvm/pikvm) - 开源的 DIY IP-KVM 解决方案 \ No newline at end of file