openhab/openhab-cloud

openHAB Cloud Docker镜像文档

镜像概述和主要用途

openHAB Cloud是openHAB开源家庭自动化软件的配套云服务与后端。作为openHAB实例的云端伴侣，其主要用途是为openHAB用户提供安全的远程访问能力，支持通过互联网远程监控、控制家庭自动化系统，同时实现设备数据收集、移动设备通知推送、第三方云服务集成等扩展功能。

核心功能和特性

• 用户管理前端：提供用户注册、登录及权限管理界面，支持多用户场景。
• 安全远程访问：通过加密通道实现openHAB实例的远程访问，保障数据传输安全性。
• 远程代理访问：支持通过代理服务器间接连接openHAB实例，无需暴露本地网络。
• 设备注册与管理：提供设备注册表功能，集中管理openHAB实例中的智能设备信息。
• 消息服务：支持向用户移动设备推送事件通知（如设备状态变更提醒）。
• 数据管理与持久化：收集并存储设备运行统计数据，支持数据可视化与历史记录查询。
• 第三方云服务集成：作为核心后端集成点，支持与云服务（如IFTTT）联动，扩展自动化场景。
• OAuth2应用支持：提供OAuth2认证框架，支持第三方应用安全接入与授权。

使用场景和适用范围

适用场景

• 远程家庭监控与控制：用户需通过互联网实时查看家庭设备状态并远程操作（如远程开关灯、调节温控）。
• 多实例集中管理：管理员需统一管理多个openHAB实例，配置设备参数与用户权限。
• 跨平台自动化联动：集成IFTTT等服务实现跨设备/平台场景（如“当智能门锁开启时自动开灯”）。
• 设备数据统计分析：长期收集设备运行数据，生成能耗报表或设备使用频率分析。
• 移动事件通知：家庭异常事件（如门窗异常开启、传感器报警）实时推送至移动设备。

适用用户

• openHAB家庭自动化系统用户
• 家庭智能设备管理员
• 需要扩展云端功能的家庭自动化场景开发者

使用方法和配置说明

部署方式

推荐使用Docker Compose部署，简化MongoDB（数据存储）、Redis（缓存/会话）等依赖服务的管理。详细配置可参考https://github.com/openhab/openhab-cloud/blob/main/deployment/docker-compose%E3%80%82

Docker Compose配置示例

创建docker-compose.yml文件，示例配置如下（根据实际环境调整参数）：

yaml
version: '3'

services:
  openhab-cloud:
    image: openhab/openhab-cloud:latest
    ports:
      - "80:3000"  # 映射容器内3000端口至主机80端口（可根据需求调整）
    environment:
      - NODE_ENV=production              # 运行环境（development/production）
      - MONGO_URI=mongodb://mongo:27017/openhab-cloud  # MongoDB连接地址
      - REDIS_URI=redis://redis:6379     # Redis连接地址（用于缓存/会话）
      - JWT_SECRET=your_secure_jwt_key   # JWT签名密钥（需替换为高强度随机字符串）
      - DOMAIN=your-domain.com           # 服务域名（用于生成远程访问链接）
      - PORT=3000                        # 容器内服务监听端口
    depends_on:
      - mongo
      - redis
    restart: unless-stopped  # 异常退出后自动重启

  mongo:  # 数据存储依赖
    image: mongo:latest
    volumes:
      - mongo-data:/data/db  # 持久化MongoDB数据
    restart: unless-stopped

  redis:  # 缓存/会话依赖
    image: redis:alpine
    volumes:
      - redis-data:/data  # 持久化Redis数据
    restart: unless-stopped

volumes:
  mongo-data:  # MongoDB数据卷
  redis-data:  # Redis数据卷

启动服务

在docker-compose.yml文件所在目录执行以下命令启动服务：

bash
docker-compose up -d

核心配置参数说明

openHAB Cloud主要通过环境变量配置，以下为关键参数（完整列表请参考https://github.com/openhab/openhab-cloud/%EF%BC%89%EF%BC%9A

注意事项

• 首次部署需确保MongoDB和Redis服务正常启动，openHAB Cloud依赖这两个服务进行数据存储和缓存。
• JWT_SECRET需使用高强度随机字符串（推荐通过openssl rand -hex 32生成），避免使用默认值或弱密钥。
• 生产环境中建议通过反向代理（如Nginx）配置HTTPS，确保远程访问的传输层安全。

补充信息

• 源代码与文档：完整配置及源代码请访问https://github.com/openhab/openhab-cloud/%E3%80%82
• 许可证：遵循EPL-2.0开源许可证。
• 社区支持：可通过GitHub Issues提交问题或参与讨论。