OpenRemote Docker 镜像文档

镜像概述和主要用途

OpenRemote 是一个开源的物联网 (IoT) 平台，提供设备连接、数据管理、规则引擎和可视化仪表盘等功能。该 Docker 镜像封装了 OpenRemote 平台的完整运行环境，包括后端服务、Web 管理界面和相关依赖组件，旨在简化部署流程并确保环境一致性。

主要用途包括：

• 物联网设备的集中管理与监控
• 实时数据采集、存储与分析
• 自动化规则引擎与事件处理
• 自定义仪表板与报表生成
• 多租户环境下的资源隔离与权限控制

核心功能和特性

设备连接与集成

• 支持多种协议：MQTT、HTTP、CoAP、Bluetooth、Zigbee、Modbus 等
• 设备配置自动发现与注册
• 自定义协议适配器开发框架

数据处理与存储

• 时序数据高效存储与查询
• 实时数据流处理引擎
• 数据转换与规范化规则
• 历史数据压缩与归档策略

规则引擎

• 基于事件的条件触发机制
• 可视化规则编辑器
• 复杂场景的状态机建模
• 实时与批量处理模式

可视化与用户界面

• 可定制的仪表盘与 widgets
• 响应式设计，支持多设备访问
• 地图集成与地理空间可视化
• 自定义报表生成工具

安全与权限

• 细粒度的 RBAC (基于角色的访问控制)
• OAuth 2.0 / OpenID Connect 认证集成
• 设备通信加密与数据隐私保护
• 审计日志与操作追踪

平台扩展

• RESTful API 与 WebSocket 接口
• 插件式架构，支持功能扩展
• 多语言支持
• 容器化部署，支持水平扩展

使用场景和适用范围

适用场景

• 智能家居与楼宇自动化系统
• 工业物联网 (IIoT) 监控与控制
• 城市基础设施管理（智能城市）
• 能源管理与环境监测
• 物流与资产追踪
• 健康***设备监控

适用规模

• 小型部署：单节点运行，支持数百台设备
• 中型部署：多节点集群，支持数千台设备
• 大型部署：分布式架构，支持数万至数十万设备

使用方法和配置说明

前提条件

• Docker Engine 19.03+
• Docker Compose 1.25+
• 至少 4GB RAM (推荐 8GB+)
• 20GB 可用磁盘空间

基本部署

使用 docker run 快速启动

bash
docker run -d --name openremote \
  -p 8080:8080 \
  -p 8883:8883 \
  -e OR_ADMIN_PASSWORD=secret \
  -v openremote-data:/opt/openremote/data \
  openremote/main:latest

使用 docker-compose 部署 (推荐)

创建 docker-compose.yml 文件：

yaml
version: '3.8'

services:
  openremote:
    image: openremote/main:latest
    restart: always
    ports:
      - "8080:8080"   # HTTP
      - "8443:8443"   # HTTPS
      - "8883:8883"   # MQTT
    environment:
      - OR_ADMIN_PASSWORD=secret
      - OR_SETUP_WIZARD=false
      - OR_HOSTNAME=localhost
      - OR_HTTP_PORT=8080
      - OR_HTTPS_PORT=8443
    volumes:
      - openremote-data:/opt/openremote/data
    networks:
      - openremote-net

networks:
  openremote-net:
    driver: bridge

volumes:
  openremote-data:

启动服务：

bash
docker-compose up -d

首次访问

1. 服务启动后，通过浏览器访问 http://<hostname>:8080
2. 使用默认凭据登录：
   • 用户名：admin
   • 密码：启动时设置的 OR_ADMIN_PASSWORD 值
3. 完成初始设置向导或导入现有配置

持久化数据

容器使用 /opt/openremote/data 目录存储持久化数据，包括：

• 配置文件
• 数据库文件
• 设备状态
• 日志记录
• 媒体资源

建议使用 Docker 卷或绑定挂载确保数据持久化。

配置参数和环境变量

核心环境变量

高级配置

可通过挂载自定义配置文件覆盖默认设置：

bash
-v ./custom-config:/opt/openremote/deployment/import

配置文件结构：

custom-config/
├── assets/           # 静态资源
├── rules/            # 规则定义
├── things/           # 设备配置
├── users/            # 用户与权限配置
└── app.json          # 应用全局配置

维护与管理

日志查看

bash
docker logs -f openremote

备份数据

bash
docker exec -it openremote /opt/openremote/bin/backup.sh

更新镜像

bash
docker-compose pull
docker-compose up -d

监控状态

bash
docker exec -it openremote /opt/openremote/bin/status.sh

故障排除

常见问题解决

1. 服务启动失败

   • 检查系统资源是否满足要求
   • 查看日志文件定位错误原因
   • 确保数据卷权限正确

2. 设备连接问题

   • 验证网络连接与端口映射
   • 检查设备凭证与协议配置
   • 查看设备适配器日志

3. 性能优化

   • 增加 JVM 内存分配：-e JAVA_OPTS="-Xms2g -Xmx4g"
   • 调整数据库连接池大小
   • 优化时序数据保留策略

4. 证书管理

   • 自定义 SSL 证书：挂载证书到 /opt/openremote/deployment/certs
   • 自动证书更新：配置 ACME 客户端集成

版本信息与更新

• 镜像标签与版本对应关系：openremote/main:latest (最新稳定版)，openremote/main:x.y.z (特定版本)
• 版本更新日志：GitHub Releases
• 重大更新建议先备份数据并查阅迁移指南

相关资源

• ***文档：OpenRemote Documentation
• GitHub 仓库：[***]
• 社区论坛：OpenRemote Community
• API 参考：http://<hostname>:8080/api/docs
• 示例项目：OpenRemote Demos