mirror of
https://github.com/mofeng-git/One-KVM.git
synced 2026-07-29 05:41:46 +08:00
docs: 更新说明
This commit is contained in:
mofeng-git
27
README.en.md
27
README.en.md
@@ -22,6 +22,8 @@ Goals: an open, lightweight, easy-to-use IP-KVM stack.
|
||||
- **Lightweight**: shipped as a binary with minimal moving parts for deployment.
|
||||
- **Easy to use**: no hand-edited config files required; settings are done in the web UI.
|
||||
|
||||
For more information, see the [One-KVM Rust documentation](https://docs.one-kvm.cn/).
|
||||
|
||||
> **One-KVM (Python)** is no longer maintained. If you still need it, see <https://github.com/mofeng-git/One-KVM/tree/python>.
|
||||
|
||||
<div align="center">
|
||||
@@ -32,7 +34,7 @@ Goals: an open, lightweight, easy-to-use IP-KVM stack.
|
||||
|
||||
## Features
|
||||
|
||||
### Core
|
||||
**Core**
|
||||
|
||||
| Area | Capabilities |
|
||||
|------|----------------|
|
||||
@@ -40,11 +42,9 @@ Goals: an open, lightweight, easy-to-use IP-KVM stack.
|
||||
| Video encoding | VAAPI / QSV / RKMPP / V4L2 M2M hardware paths, with software fallback |
|
||||
| Keyboard & mouse | USB OTG HID or CH340 + CH9329 HID; absolute / relative mouse |
|
||||
| Virtual media | USB mass storage; ISO/IMG mount and Ventoy-style virtual USB |
|
||||
| ATX power | GPIO or USB relay; power and reset control |
|
||||
| ATX power | GPIO or USB relay; power control |
|
||||
| Audio | ALSA capture + Opus (HTTP / WebRTC) |
|
||||
|
||||
The web UI supports visual configuration and Chinese/English locales. Built-ins include a web terminal (ttyd), intranet tunnel (gostc), P2P (EasyTier), RustDesk protocol (optional cross-platform remote access), and RTSP streaming.
|
||||
|
||||
## Installation
|
||||
|
||||
Release artifacts are on [GitHub Releases](https://github.com/mofeng-git/One-KVM/releases). Below are short paths for common setups. For **system requirements, hardware, Docker env vars, USB OTG**, and full troubleshooting, see the [One-KVM documentation](https://docs.one-kvm.cn/) (Chinese; use a translator if needed).
|
||||
@@ -216,15 +216,22 @@ One-KVM builds on many great open-source projects; a lot of time goes into testi
|
||||
|
||||
- 爱发电用户_d3d9c
|
||||
|
||||
- 爱发电用户_97b41
|
||||
|
||||
- 偶然
|
||||
|
||||
- 爱发电用户_dba45
|
||||
|
||||
- 爱发电用户_d4f8b
|
||||
|
||||
- 故人。
|
||||
|
||||
- ......
|
||||
|
||||
</details>
|
||||
|
||||
### Sponsors
|
||||
|
||||
**Mirror Download Services:**
|
||||
- **[Chongqing University Open Source Software Mirror](https://mirrors.cqu.edu.cn/)** — provides mirror download services
|
||||
|
||||
**File hosting**
|
||||
|
||||
- **[Huang1111 public-interest program](https://pan.huang1111.cn/s/mxkx3T1)** — login-free downloads
|
||||
@@ -236,3 +243,9 @@ One-KVM builds on many great open-source projects; a lot of time goes into testi
|
||||
|
||||
|
||||
林枫云 offers premium network routes, high-frequency game servers, and high-bandwidth servers in China and abroad.
|
||||
|
||||
- **[Beta Network](https://my.beita.cc/?ref=github_onekvm)** — project server sponsorship
|
||||
|
||||
|
||||
|
||||
Remote computers, consumer GPU servers, and dedicated physical machines with fully automated online delivery.
|
||||
|
||||
27
README.md
27
README.md
@@ -12,7 +12,7 @@
|
||||
|
||||
---
|
||||
|
||||
## 📖 项目概述
|
||||
## 项目概述
|
||||
|
||||
**One-KVM Rust** 是一个用 Rust 编写的轻量级 IP-KVM 解决方案，可通过网络远程管理服务器和工作站，实现 BIOS 级远程控制。
|
||||
|
||||
@@ -22,6 +22,8 @@
|
||||
- **轻量**：以二进制文件形式分发，无繁杂的依赖项，部署过程简单。
|
||||
- **易用**：无需手动编辑配置文件，参数设置均可通过网页界面完成。
|
||||
|
||||
更多内容可访问 [One-KVM Rust 文档站点](https://docs.one-kvm.cn/)。
|
||||
|
||||
> **One-KVM Python** 已停止开发，如有需要可访问 <https://github.com/mofeng-git/One-KVM/tree/python>。
|
||||
|
||||
<div align="center">
|
||||
@@ -30,9 +32,9 @@
|
||||
|
||||
</div>
|
||||
|
||||
## 📊 功能介绍
|
||||
## 功能介绍
|
||||
|
||||
### 核心功能
|
||||
**核心功能**
|
||||
|
||||
| 功能 | 能力说明 |
|
||||
|------|------|
|
||||
@@ -40,12 +42,10 @@
|
||||
| 视频编码 | VAAPI/QSV/RKMPP/V4L2M2M 硬件编码支持，以及软件编码兜底 |
|
||||
| 键鼠控制 | USB OTG HID 或 CH340 + CH9329 HID，支持绝对/相对鼠标模式 |
|
||||
| 虚拟媒体 | USB Mass Storage，支持 ISO/IMG 镜像挂载和 Ventoy 虚拟U盘模式 |
|
||||
| ATX 电源控制 | GPIO /USB 继电器，支持控制电源、重启按钮 |
|
||||
| ATX 电源控制 | GPIO/USB 继电器，支持电源控制 |
|
||||
| 音频传输 | ALSA 采集 + Opus 编码（HTTP/WebRTC） |
|
||||
|
||||
此外提供基于 Web UI 的可视化配置与中英文界面；并集成 Web 终端（ttyd）、内网穿透（gostc）、P2P 组网（EasyTier）、RustDesk 协议（扩展跨平台远程访问）以及 RTSP 推流等能力。
|
||||
|
||||
## ⚡ 安装使用
|
||||
## 安装使用
|
||||
|
||||
构建产物见 [GitHub Releases](https://github.com/mofeng-git/One-KVM/releases)。以下为常见安装方式的简要步骤；**系统要求、硬件准备、Docker 环境变量与 USB OTG 等完整说明**请查阅 [One-KVM Rust 文档站点](https://docs.one-kvm.cn/)。
|
||||
|
||||
@@ -210,6 +210,16 @@ One-KVM 已上架飞牛 **应用市场**，在 NAS 上直接搜索安装即可
|
||||
|
||||
- 爱发电用户_d3d9c
|
||||
|
||||
- 爱发电用户_97b41
|
||||
|
||||
- 偶然
|
||||
|
||||
- 爱发电用户_dba45
|
||||
|
||||
- 爱发电用户_d4f8b
|
||||
|
||||
- 故人。
|
||||
|
||||
- ......
|
||||
|
||||
</details>
|
||||
@@ -218,9 +228,6 @@ One-KVM 已上架飞牛 **应用市场**，在 NAS 上直接搜索安装即可
|
||||
|
||||
本项目得到以下赞助商的支持：
|
||||
|
||||
**镜像下载服务：**
|
||||
- **[重庆大学开源软件镜像站](https://mirrors.cqu.edu.cn/)** - 提供镜像站下载服务
|
||||
|
||||
**文件存储服务：**
|
||||
- **[Huang1111公益计划](https://pan.huang1111.cn/s/mxkx3T1)** - 提供免登录下载服务
|
||||
|
||||
|
||||
Reference in New Issue
Block a user