VncProxy 开源项目安装与使用教程

VncProxy 开源项目安装与使用教程

VncProxy 是一个基于 Golang 实现的 VNC 远程桌面代理组件，它提供了对 RFB 协议的全面解析，支持VNC代理、录制与回放视频（RBS格式）、截图以及多种编码格式。此文档旨在指导您了解项目结构、启动方法和配置详情。

1. 项目目录结构及介绍

VncProxy 的项目结构清晰，便于理解和开发：

• bin: 包含编译后生成的可执行文件。
• cmd:
  • proxy: 启动VNC代理服务的相关命令和逻辑。
  • recorder: 录制VNC会话到RBS文件的命令和逻辑。
  • player: 播放RBS文件或通过VNC代理提供回显服务。
  • video: 将VNC会话转制成视频文件。
  • screenshot: 获取VNC服务器的屏幕快照。
• docs: 相关文档。
• encodings: 支持的各种编码格式实现。
• handler: 消息处理器模块。
• internal, rfb, sessions, security, vnc: 核心功能模块，包括RFB协议处理、会话管理等。
• LICENSE: 许可证文件，遵循 Apache-2.0 许可证。
• README.md: 项目介绍和快速指南。

2. 项目的启动文件介绍

主要脚本及命令

• 在 cmd 目录下每个子目录中都含有用于特定功能的可执行文件编译模板，如 proxy, recorder, player, video, 和 screenshot。
• 编译与启动:
  • 运行 ./build.sh 可编译全部应用，或使用 -s 参数指定应用名来编译特定部分，例如：./build.sh -s proxy 仅编译代理服务。
  • 应用可通过其命令行工具启动，例如，启动TCP服务可以用：

    ./proxy start tcpServer --vncHost=IP_ADDRESS --vncPort=PORT --tcpHost=0.0.0.0 --tcpPort=8989 --proxyPassword=YOUR_PASSWORD
    

3. 项目的配置文件介绍

VncProxy 的配置主要依赖于命令行参数。虽然没有传统意义上的独立配置文件，但通过命令行参数实现了高度的配置灵活性：

• 代理服务配置:

  • vncHost, vncPort, vncPassword: 分别指定了目标VNC服务器的地址、端口和访问密码。
  • tcpHost, tcpPort: 指定代理服务监听的主机地址和端口。
  • proxyPassword: 设置连接到代理时所需的密码。
  • debug: 添加此标志启动调试模式。

• 录制服务 (recorder) 配置:

  • rbsFile: 录制的目标RBS文件路径。
  • 同样需要指定VNC服务器的相关连接参数和可选的调试模式。

• 对于 播放器 (player) 和 截图 (screenshot) 功能，也有类似的命令行参数来指定文件路径、VNC连接详细信息等。

请注意，尽管配置是动态的且通过命令行参数设置，复杂部署可能需要脚本化这些命令，以适应不同的环境需求。此外，对于持续运行和生产环境，考虑将命令行参数外部化（比如使用环境变量或自定义配置脚本）是个好习惯。