koenvdkruk/robo-recorder-2000

RoboRecorder2000 集成 Robot Framework - Docker 部署指南

本文档描述如何使用Docker运行RoboRecorder2000。

快速开始

1. 构建并运行容器：

   bash
   ./manage.sh build
   ./manage.sh start
   

2. 访问Web界面：
   • 在浏览器中打开 http://localhost:8080
   • 查看带Robot Framework时间线集成的VNC录制内容
   • Web界面头部会显示Docker状态
3. 使用REST API（新增）：
   • API地址：http://localhost:8080/api/
   • 可控制录制、上传output.xml等
   • 详情见 API_README.md 和 API_QUICK_REFERENCE.md

管理脚本

使用manage.sh脚本简化容器管理：

bash
# 构建容器
./manage.sh build

# 以开发模式启动（带日志）
./manage.sh start

# 后台启动
./manage.sh start bg

# 以生产模式启动（带nginx）
./manage.sh start prod

# 检查状态
./manage.sh status

# 查看日志
./manage.sh logs

# 停止容器
./manage.sh stop

# 完全清理
./manage.sh cleanup full

Docker架构

该Docker设置包含：

• VNC录制：自动检测VNC显示并录制（RoboRecorder2000）
• Robot Framework处理：实时处理Robot Framework输出
• Web服务器：内置HTTP服务器用于查看结果
• 外部配置：容器外的配置文件便于更新

配置

外部配置文件（robot_config_output.ini）

运行时行为由挂载到容器/app/config/robot_config_output.ini的外部INI配置文件驱动（只读）。

示例robot_config_output.ini：

ini
[robot_output]
output_file = /opt/workspace/robot-framework/output.xml
webhook_url = https://your-webhook-url
session_dir = /app/filmpjes
parse_timeout = 30

[recording]
vnc_displays = :0,:1,:2,:3,:4,:5,:6,:7,:8,:9
video_quality = medium
frame_rate = 15
resolution = 1920x1080

[web_server]
port = 8080
host = 0.0.0.0
auto_open = false

[logging]
level = INFO
max_size_mb = 100
backup_count = 5

卷挂载

• ./robot_config_output.ini → /app/config/robot_config_output.ini（只读）
• ./filmpjes → /app/filmpjes（录制内容和会话）
• ./logs → /app/logs（应用日志）
• /opt/workspace/robot-framework → /opt/workspace/robot-framework（只读）

注意：容器默认不再需要显式挂载主机/proc或X11套接字。若您的自定义环境需要暴露显示或进程图，请在添加主机卷前参考下方高级部分。

环境与配置

推荐的配置方式是通过挂载到/app/config/robot_config_output.ini的外部INI文件。容器启动时会读取该文件的设置。若您的环境需要X11转发或主机进程访问，仍可传递环境变量或挂载卷，但这些属于高级用例，默认设置无需使用。

Docker命令

开发模式

bash
# 构建并运行（带日志）
docker-compose up

# 后台运行
docker-compose up -d

# 查看日志
docker-compose logs -f

# 停止容器
docker-compose down

生产模式（带Nginx）

bash
# 启动Nginx反向代理
docker-compose --profile production up -d

# 通过Nginx访问
# http://localhost（80端口）

手动Docker命令

bash
# 构建镜像
docker build -t robo-recorder-2000:latest .

# 手动运行容器
docker run -d \
   --name robo-recorder-2000 \
  --network host \
  --privileged \
   -v ./robot_config_output.ini:/app/config/robot_config_output.ini:ro \
   -v ./filmpjes:/app/filmpjes \
   -v ./logs:/app/logs \
   -v /opt/workspace/robot-framework:/opt/workspace/robot-framework:ro \
   docker.xuanyuan.run/robo-recorder-2000:latest

容器特性

进程管理

• 自动重启：失败进程自动重启
• 信号处理：收到SIGTERM/SIGINT时优雅关闭
• 健康检查：内置健康监控
• 进程隔离：使用非root用户增强安全性

Web API端点

• GET / - 主VNC查看界面
• GET /api/sessions - 列出所有录制会话
• GET /api/config - 查看配置
• GET /api/status - 容器和进程状态

安全特性

• 非root用户：容器以rfuser（UID 1000）运行
• 只读挂载：配置和Robot Framework输出为只读
• 权限控制：仅保留VNC访问所需的必要权限

主机系统要求

X11访问

容器需要访问主机X11服务器以进行VNC录制：

bash
# 临时允许X11访问
xhost +local:

# 更安全的方式 - 添加特定用户
xhost +SI:localuser:rfuser

进程访问

容器需要读取主机进程以检测VNC：

• 挂载/proc为只读卷
• 容器使用HOST_PROC=/host/proc访问主机进程

Robot Framework集成

• Robot Framework的output