magnolia/vncrecorderd

mgnl/vncrecorder 镜像文档

镜像概述

mgnl/vncrecorder是一个用于录制VNC服务器会话的Docker镜像，通过gRPC API提供录制控制功能，支持自定义录制参数（如帧率、视频质量），并将录制文件存储在指定目录。适用于需要捕获VNC会话内容的场景，如集成测试过程记录、远程桌面操作审计等。

核心功能与特性

• gRPC API控制：通过gRPC API（默认端口3000）实现录制的启动、停止和删除操作
• 自定义录制参数：可配置帧率（默认60 FPS）和视频质量（0-51，0为最佳质量）
• 灵活存储：支持将录制文件挂载到主机指定目录
• 网络适配：可配置与VNC服务器所在网络桥接，确保网络连通性

使用场景

• Selenium自动化测试过程中的屏幕录制
• 远程桌面操作记录与审计
• VNC服务器会话内容存档
• 集成测试中的可视化结果记录

使用方法

Docker Compose部署示例

yaml
version: '3.5'

services:
  vncrecorder:
    image: mgnl/vncrecorder:1.0-alpine
    env_file:
      - .env  # 环境变量配置文件
    expose:
      - 3000  # gRPC API端口
    ports:
      - 3000:3000  # 映射gRPC API端口到主机
    volumes:
      - /path/to/recordings/dir:/recordings  # 挂载录制文件存储目录
    networks:
      - mgnl-integration-tests  # 与VNC服务器相同的网络

networks:
  mgnl-integration-tests:
    external: true  # 使用已存在的网络

环境变量配置（.env文件）

创建.env文件配置以下参数：

# gRPC API端口，用于启动/停止/删除录制操作
GRPC_PORT=3000

# VNC服务器密码
# 默认值：secret
VNC_PASSWORD=secret

# VNC服务器端口（可被gRPC API覆盖）
# 默认值：5900
VNC_PORT=5900

# 录制帧率（每秒帧数）
# 较低帧率会生成更长的视频
# 默认值：60
VNC_FRAME_RATE=10

# 视频质量控制参数（范围0-51）
# 0 = 最佳质量（文件体积大），51 = 最差质量（文件体积小）
# 推荐范围：10-20
# 默认值：0
VNC_CONSTANT_RATE_FACTOR=10

# 容器运行网络
# 需与selenium-standalone容器或运行VNC服务器的selenium节点网络一致
SELENIUM_BRIDGE_NETWORK=mgnl-integration-tests

# 主机录制文件存储目录（留空则使用默认容器内路径）
RECORDINGS_DIR=

参数说明

使用注意事项

1. 确保容器网络（SELENIUM_BRIDGE_NETWORK）与VNC服务器所在网络一致，否则无法连接VNC服务
2. 录制文件目录需在volumes中正确映射，否则录制文件将仅保存在容器内部
3. 调整VNC_CONSTANT_RATE_FACTOR参数平衡视频质量与文件大小，推荐值10-20
4. 降低VNC_FRAME_RATE可减少资源占用，但会影响视频流畅度