openremote/keycloak

OpenRemote Docker 镜像文档

镜像概述和主要用途

OpenRemote 是一个开源的物联网 (IoT) 平台，提供完整的设备管理、数据收集、规则引擎和可视化功能。该 Docker 镜像封装了 OpenRemote 平台的全部组件，包括管理界面、API 服务、数据库和消息代理，旨在简化部署流程并确保环境一致性。

主要用途：

• 构建自定义物联网解决方案
• 连接和管理各类 IoT 设备
• 收集、存储和分析设备数据
• 创建自定义仪表板和可视化界面
• 实现基于规则的自动化控制

核心功能和特性

设备管理

• 支持多种协议 (MQTT, HTTP, CoAP, Bluetooth, Modbus 等)
• 设备元数据建模和配置
• 自动发现和注册设备
• 设备生命周期管理

数据处理

• 实时和历史数据存储
• 数据转换和处理规则
• 事件驱动架构
• 警报和通知系统

可视化与用户界面

• 可定制的仪表板
• 拖放式界面编辑器
• 多租户支持
• 移动响应式设计

安全特性

• 基于角色的访问控制 (RBAC)
• OAuth 2.0 和 OpenID Connect 支持
• 设备认证和加密通信
• API 安全和速率限制

使用场景和适用范围

适用场景

• 智能家居和楼宇自动化系统
• 工业监控和预测性维护
• 环境监测和资源管理
• 智慧城市解决方案
• ***设备监控
• 农业物联网应用

适用范围

• 小型家庭自动化项目到大型企业部署
• 原型开发和生产环境
• 本地部署和云端部署
• 教育和商业用途

系统要求

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

安装与部署

使用 Docker Compose (推荐)

1. 创建项目目录并下载 docker-compose.yml:

   bash
   mkdir openremote && cd openremote
   curl -O https://raw.githubusercontent.com/openremote/openremote/main/docker-compose.yml
   

2. 创建环境配置文件:

   bash
   cat > .env << EOF
   OR_ADMIN_PASSWORD=securepassword
   OR_SETUP_WIZARD=false
   OR_HOSTNAME=localhost
   EOF
   

3. 启动服务:

   bash
   docker-compose up -d
   

4. 访问管理界面: 打开浏览器访问 https://localhost，使用默认凭据登录:

   • 用户名: admin
   • 密码: 环境变量 OR_ADMIN_PASSWORD 中设置的值

使用 Docker Run 命令

bash
docker run -d \
  --name openremote \
  -p 80:80 \
  -p 443:443 \
  -e OR_ADMIN_PASSWORD=securepassword \
  -e OR_HOSTNAME=localhost \
  -v openremote-data:/openremote/data \
  openremote/stack:latest

配置说明

环境变量

持久化数据

默认情况下，Docker Compose 配置会创建以下卷来持久化数据:

• openremote_postgres_data: 数据库数据
• openremote_keycloak_data: 身份验证服务数据
• openremote_proxy_conf: 代理配置
• openremote_manager_data: 应用程序数据

自定义配置

1. 创建 custom 目录并挂载到容器:

   yaml
   volumes:
     - ./custom:/openremote/custom
   

2. 在 custom 目录中添加自定义配置文件，例如:

   • deployment.yml: 部署配置
   • rules.js: 自定义规则
   • assets/: 静态资源

使用方法

访问管理界面

1. 打开浏览器，访问 https://<your-hostname>
2. 使用管理员凭据登录
3. 通过设置向导完成初始配置 (如果启用)

添加设备

1. 在管理界面中，导航到 "设备" -> "添加设备"
2. 选择设备类型或创建自定义类型
3. 配置设备属性和连接参数
4. 保存并激活设备

创建仪表板

1. 导航到 "资产" -> 选择资产 -> "仪表板"
2. 点击 "编辑" 进入编辑模式
3. 拖放组件到画布上
4. 配置组件数据源和外观
5. 保存仪表板

REST API 使用

OpenRemote 提供完整的 REST API，基础路径为 /api/v1:

bash
# 获取设备列表
curl -X GET https://<your-hostname>/api/v1/things \
  -H "Authorization: Bearer <access-token>"

# 更新设备属性
curl -X PUT https://<your-hostname>/api/v1/things/<thing-id>/attributes \
  -H "Authorization: Bearer <access-token>" \
  -H "Content-Type: application/json" \
  -d '{"status": "active"}'

维护与故障排除

查看日志

bash
# 查看所有服务日志
docker-compose logs -f

# 查看特定服务日志
docker-compose logs -f manager

备份数据

bash
# 创建数据备份脚本
docker-compose exec -T postgres pg_dump -U openremote openremote > backup.sql

更新镜像

bash
# 拉取最新镜像
docker-compose pull

# 重启服务
docker-compose up -d

常见问题

1. 无法访问界面:

   • 检查容器是否正在运行: docker-compose ps
   • 检查防火墙设置，确保端口 80 和 443 已开放
   • 查看代理服务日志: docker-compose logs proxy

2. 数据库连接问题:

   • 检查数据库服务状态: docker-compose logs postgres
   • 验证数据库凭据是否正确

3. 设备连接问题:

   • 检查 MQTT 服务状态: docker-compose logs mqtt
   • 验证设备连接参数和认证信息

高级配置

使用外部数据库

1. 修改 .env 文件:

   OR_DATABASE_VENDOR=POSTGRES
   OR_DATABASE_URL=jdbc:postgresql://external-db:5432/openremote
   OR_DATABASE_USER=dbuser
   OR_DATABASE_PASSWORD=dbpassword
   

2. 在 docker-compose.yml 中注释掉内置数据库服务

启用 HTTPS 证书

1. 将 SSL 证书文件放置在 ./custom/certs 目录
2. 修改环境变量:

   OR_SSL_CERTIFICATE=/openremote/custom/certs/cert.pem
   OR_SSL_PRIVATE_KEY=/openremote/custom/certs/key.pem
   

集群部署

对于生产环境的集群部署，请参考官方文档中的 Kubernetes 部署指南。

相关资源

• 官方文档: [***]
• GitHub 仓库: https://github.com/openremote/openremote
• 社区论坛: [***]
• API 文档: [***]
• 示例项目: https://github.com/openremote/demo

许可证信息

OpenRemote 采用 Mozilla Public License 2.0 (MPL 2.0) 许可证。有关详细信息，请参阅 https://github.com/openremote/openremote/blob/main/LICENSE.txt 文件。

版本信息

当前稳定版本: 3.3.2

镜像标签:

• latest: 最新稳定版
• 3.3: 3.3.x 系列稳定版
• 3.3.2: 特定版本
• snapshot: 开发快照版 (不稳定)