openhab/openhab

openHAB Docker容器

!https://github.com/openhab/openhab-docker/raw/main/openhab.png

![Build Status]([] ![EPL-2.0]([] ![CodeFactor]([] ![Gitter Chat]([]

目录

• openHAB Docker容器
  • 简介
  • 镜像变体
  • 使用方法
    • 使用Docker命名卷启动（适用于初学者）
      • 从命令行运行
      • 使用compose-file.yml运行
    • 运行带有libpcap支持的openHAB
    • 在Windows和macOS上运行
    • 使用Docker挂载主机目录启动（适用于高级用户）
    • 使用Ansible自动化Docker设置（适用于高级用户）
    • 访问控制台
    • 启动模式
  • 环境变量
    • 用户和组标识符
    • Java加密强度策略
  • 参数
    • 使用符号链接传递设备
  • 在openHAB启动前执行shell脚本
  • 升级
  • 常见问题
  • 构建镜像
  • 贡献

简介

用于构建openHAB（家庭自动化服务器）Docker容器的仓库。欢迎提出意见、建议和贡献！

openHAB - 一个与供应商和技术无关的开源家庭自动化软件。

镜像变体

openHAB Docker镜像可在Docker Hub的https://hub.docker.com/r/openhab/openhab/%E4%BB%93%E5%BA%93%E4%B8%AD%E8%8E%B7%E5%8F%96%E3%80%82

• 对于特定版本，使用：

  • openhab/openhab:<version>
  • openhab/openhab:<version>-<distribution>

• 对于最新稳定版本，使用：

  • openhab/openhab
  • openhab/openhab:latest
  • openhab/openhab:latest-<distribution>

• 对于具有里程碑或稳定成熟度的最新版本，使用：

  • openhab/openhab:milestone
  • openhab/openhab:milestone-<distribution>

• 对于最新快照版本，使用：

  • openhab/openhab:snapshot
  • openhab/openhab:snapshot-<distribution>

版本：

• 稳定版（Stable）： 经过全面测试的半年一次的openHAB官方版本。如果不需要最新增强功能并希望系统稳定，可在生产环境中使用稳定版。
  • 5.0.1 (https://github.com/openhab/openhab-distro/releases/tag/5.0.1)
  • 4.3.7 (https://github.com/openhab/openhab-distro/releases/tag/4.3.7)
• 里程碑版（Milestone）： 下一个openHAB版本的中间版本，大约每月发布一次。它们包含最近添加的功能和错误修复，是当前稳定版本和前沿但可能不稳定的快照版本之间的良好折中。
  • 5.1.0.M1 (https://github.com/openhab/openhab-distro/releases/tag/5.1.0.M1)
• 快照版（Snapshot）： 通常是1或2天前的版本，包含最新代码。用于使用最新代码测试最近的更改。请注意，某些快照可能不稳定，因此在生产环境中使用需自行承担风险！
  • 5.1.0-snapshot

发行版：

• debian - 基于Debian 13 "trixie"（未在标签中指定时的默认版本）(https://github.com/openhab/openhab-docker/blob/main/debian/Dockerfile)
• alpine - 基于Alpine 3.22 (https://github.com/openhab/openhab-docker/blob/main/alpine/Dockerfile)

Alpine镜像比Debian镜像小得多，但兼容性可能较差，因为使用了OpenJDK（有关已知缺点，请参见前提条件）。较旧的容器镜像可能使用较旧版本的Debian和Alpine基础镜像。

如果不确定自己的需求，建议使用openhab/openhab:5.0.1。

平台：

支持以下Docker平台（自动确定）：

• linux/amd64
• linux/arm64
• linux/arm/v7（Debian openHAB 4或更早版本，Alpine openHAB 2或更早版本）

使用方法

重要提示： 要能够使用UPnP进行发现，容器需要使用--net=host启动。

重要提示： 在容器中，openHAB默认以用户"openhab"（id 9001）运行。请参见下面的用户配置部分！

以下命令将在主机上以演示模式运行openHAB：

docker run --name openhab --net=host openhab/openhab:5.0.1

注意： 尽管这是启动openHAB的最简单方法，但不是推荐方法。要正确运行容器，请为目录指定主机卷。

使用Docker命名卷启动（适用于初学者）

以下配置使用Docker命名数据卷。即使删除或升级容器，这些卷也会保留。这是初学者的良好起点。卷在Docker卷目录中创建。可以使用docker inspect openhab定位主机系统上的目录（例如/var/lib/docker/volumes）。有关更多信息，请访问管理容器中的数据。

从命令行运行

shell
docker run \
  --name openhab \
  --net=host \
  -v /etc/localtime:/etc/localtime:ro \
  -v /etc/timezone:/etc/timezone:ro \
  -v openhab_addons:/openhab/addons \
  -v openhab_conf:/openhab/conf \
  -v openhab_userdata:/openhab/userdata \
  -e "CRYPTO_POLICY=unlimited" \
  -e "EXTRA_JAVA_OPTS=-Duser.timezone=Europe/Berlin" \
  -d \
  --restart=always \
  openhab/openhab:5.0.1

使用compose-file.yml运行

创建以下docker-compose.yml文件以使用本地目录，并使用docker compose up -d启动容器：

yaml
services:
  openhab:
    image: "openhab/openhab:5.0.1"
    restart: always
    network_mode: host
    volumes:
      - "/etc/localtime:/etc/localtime:ro"
      - "/etc/timezone:/etc/timezone:ro"
      - "./openhab_addons:/openhab/addons"
      - "./openhab_conf:/openhab/conf"
      - "./openhab_userdata:/openhab/userdata"
    environment:
      CRYPTO_POLICY: "unlimited"
      EXTRA_JAVA_OPTS: "-Duser.timezone=Europe/Berlin"
      OPENHAB_HTTP_PORT: "8080"
      OPENHAB_HTTPS_PORT: "8443"

创建以下docker-compose.yml文件以使用Docker卷，并使用docker compose up -d启动容器：

yaml
services:
  openhab:
    image: "openhab/openhab:5.0.1"
    restart: always
    network_mode: host
    volumes:
      - "/etc/localtime:/etc/localtime:ro"
      - "/etc/timezone:/etc/timezone:ro"
      - "openhab_addons:/openhab/addons"
      - "openhab_conf:/openhab/conf"
      - "openhab_userdata:/openhab/userdata"
    environment:
      CRYPTO_POLICY: "unlimited"
      EXTRA_JAVA_OPTS: "-Duser.timezone=Europe/Berlin"
      OPENHAB_HTTP_PORT: "8080"
      OPENHAB_HTTPS_PORT: "8443"

volumes:
  openhab_addons:
    driver: local
  openhab_conf:
    driver: local
  openhab_userdata:
    driver: local

运行带有libpcap支持的openHAB

可以通过配置额外的功能来运行所有带有libpcap支持的openHAB镜像。这允许在Docker容器中使用Amazon Dash Button Binding。创建以下docker-compose.yml文件，并使用docker compose up -d启动容器：

yaml
services:
  openhab:
    container_name: openhab
    image: "openhab/openhab:5.0.1"
    restart: always
    network_mode: host
    cap_add:
      - NET_ADMIN
      - NET_RAW
    volumes:
      - "/etc/localtime:/etc/localtime:ro"
      - "/etc/timezone:/etc/timezone:ro"
      - "./openhab_addons:/openhab/addons"
      - "./openhab_conf:/openhab/conf"
      - "./openhab_userdata:/openhab/userdata"

在Windows和macOS上运行

host网络驱动程序仅在Linux主机上有效，Docker在Windows和macOS上不支持。在Windows和macOS上，应通过向命令添加端口选项（-p 8080）或向docker-compose.yml添加ports部分来暴露端口。

yaml
services:
  openhab:
    image: "openhab/openhab:5.0.1"
    restart: always
    ports:
      - "8080:8080"
      - "8443:8443"
    volumes:
      - "./openhab_addons:/openhab/addons"
      - "./openhab_conf:/openhab/conf"
      - "./openhab_userdata:/openhab/userdata"
    environment:
      CRYPTO_POLICY: "unlimited"
      EXTRA_JAVA_OPTS: "-Duser.timezone=Europe/Berlin"
      OPENHAB_HTTP_PORT: "8080"
      OPENHAB_HTTPS_PORT: "8443"

使用Docker挂载主机目录启动（适用于高级用户）

可以挂载本地主机目录来存储配置文件。如果已遵循初学者指南，则无需阅读本部分。以下run命令将创建文件夹并为您复制初始配置文件。

shell
docker run \
  --name openhab \
  --net=host \
  -v /etc/localtime:/etc/localtime:ro \
  -v /etc/timezone:/etc/timezone:ro \
  -v /opt/openhab/addons:/openhab/addons \
  -v /opt/openhab/conf:/openhab/conf \
  -v /opt/openhab/userdata:/openhab/userdata \
  -e "CRYPTO_POLICY=unlimited" \
  -e "EXTRA_JAVA_OPTS=-Duser.timezone=Europe/Berlin" \
  openhab/openhab:5.0.1

使用Ansible自动化Docker设置（适用于高级用户）

如果使用Ansible控制环境，以下是一个示例playbook。可以通过运行ansible-playbook -i mycontainerhost, -t openhab run-containers.yml进行测试。卷行末尾的:Z用于SELinux系统。如果在其他地方运行，请将其替换为ro。

yaml
- name: ensure containers are running
  hosts: all
  tasks:

  - name: ensure openhab is up
    tags: openhab
    docker_container:
      name: openhab
      image: openhab/openhab:5.0.1
      state: started
      detach: yes
      ports:
        - 8080:8080
        - 8101:8101
        - 5007:5007
      volumes:
        - "/etc/localtime:/etc/localtime:ro"
        - "/etc/timezone:/etc/timezone:ro"
        - "/opt/openhab/addons:/openhab/addons:Z"
        - "/opt/openhab/conf:/openhab/conf:Z"
        - "/opt/openhab/userdata:/openhab/userdata:Z"
      keep_volumes: yes
      hostname: openhab.localnet
      memory: 512m
      pull: true
      restart_policy: unless-stopped
      env:
        CRYPTO_POLICY="unlimited"
        EXTRA_JAVA_OPTS="-Duser.timezone=Europe/Berlin"

访问控制台

可以使用以下命令连接到已运行的openHAB容器的控制台：

docker exec -it openhab /openhab/runtime/bin/client

登录的默认密码是：habopen

启动模式

服务器模式

当未提供TTY时，容器以服务器模式启动openHAB，例如：

docker run --detach --name openhab openhab/openhab:5.0.1

当容器以服务器模式运行时，还可以添加控制台日志器，使其将日志输出到stdout，以便可以使用以下命令检查名为"openhab"的容器的日志：

docker logs openhab

要在openHAB 3（或更高版本）中使用控制台日志器，请编辑userdata/etc/log4j2.xml并将以下appender添加到"Root logger"和"openhab.event"日志器配置中：<AppenderRef ref="STDOUT"/>

要在openHAB 2中使用控制台日志器，请编辑userdata/etc/org.ops4j.pax.logging.cfg，然后：

• 将appenderRefs行更新为：log4j2.rootLogger.appenderRefs = out, osgi, console
• 添加以下行：log4j2.rootLogger.appenderRef.console.ref = STDOUT

常规模式

当提供TTY时，openHAB以交互式控制台启动，例如：

docker run -it openhab/openhab:5.0.1

调试模式

使用以下命令启动调试模式：

docker run -it openhab/openhab:5.0.1 ./start_debug.sh

环境变量

• CRYPTO_POLICY=limited
• EXTRA_JAVA_OPTS=""
• EXTRA_SHELL_OPTS=""
• LC_ALL=en_US.UTF-8
• LANG=en_US.UTF-8
• LANGUAGE=en_US.UTF-8
• OPENHAB_HTTP_PORT=8080
• OPENHAB_HTTPS_PORT=8443
• USER_ID=9001
• GROUP_ID=9001

用户和组标识符

组ID默认与用户ID相同。容器中的openHAB用户默认运行时：

• uid=9001(openhab) gid=9001(openhab) groups=9001(openhab)

确保以下任一情况：

• 在Docker主机系统上创建具有相同uid和gid的用户

shell
groupadd -g 9001 openhab
useradd -u 9001 -g openhab -r -s /sbin/nologin openhab
usermod -a -G openhab myownuser

• 或使用自己的用户运行Docker容器，并通过环境变量将uid和gid传递给openHAB

shell
docker run \
(...)
-e USER