PiKVM 项目安装与使用教程

PiKVM 项目安装与使用教程

kvmd The main PiKVM daemon 项目地址: https://gitcode.com/gh_mirrors/kv/kvmd

1. 项目目录结构及介绍

PiKVM 项目的目录结构如下：

kvmd/
├── bin/
│   ├── kvmd
│   └── kvmd-webterm
├── configs/
│   ├── kvmd.yaml
│   └── nginx.conf
├── docs/
│   ├── README.md
│   └── CONTRIBUTING.md
├── src/
│   ├── kvmd/
│   └── web/
└── tests/
    ├── test_kvmd.py
    └── test_web.py

目录介绍

• bin/: 包含项目的可执行文件，如 kvmd 和 kvmd-webterm。
• configs/: 包含项目的配置文件，如 kvmd.yaml 和 nginx.conf。
• docs/: 包含项目的文档文件，如 README.md 和 CONTRIBUTING.md。
• src/: 包含项目的源代码，分为 kvmd 和 web 两个主要模块。
• tests/: 包含项目的测试文件，如 test_kvmd.py 和 test_web.py。

2. 项目启动文件介绍

项目的启动文件主要位于 bin/ 目录下：

• kvmd: 这是 PiKVM 的主守护进程，负责管理 KVM 设备和提供远程访问功能。
• kvmd-webterm: 这是一个 Web 终端，允许用户通过浏览器访问和管理 KVM 设备。

启动命令

# 启动主守护进程
./bin/kvmd

# 启动 Web 终端
./bin/kvmd-webterm

3. 项目配置文件介绍

项目的配置文件主要位于 configs/ 目录下：

• kvmd.yaml: 这是 PiKVM 的主配置文件，包含各种设置，如设备连接、用户权限、日志级别等。
• nginx.conf: 这是 Nginx 的配置文件，用于配置 Web 服务器的相关设置。

配置文件示例

kvmd.yaml:

# 设备连接配置
devices:
  - type: usb
    id: 1
    name: "USB Device 1"

# 用户权限配置
users:
  - username: admin
    password: admin123
    permissions:
      - read
      - write

# 日志配置
logging:
  level: info

nginx.conf:

server {
    listen 80;
    server_name localhost;

    location / {
        proxy_pass http://127.0.0.1:8080;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

通过以上配置文件，您可以自定义 PiKVM 的行为和功能。

kvmd The main PiKVM daemon 项目地址: https://gitcode.com/gh_mirrors/kv/kvmd