causticlab/hass-configurator-docker

hass-configurator-docker

Linux x32/64和ARM（树莓派）架构的hass-configurator构建版本。

镜像概述和主要用途

hass-configurator-docker是Home Assistant配置工具（hass-configurator）的Docker化实现，支持多架构部署（Linux x32/64及ARM）。该镜像提供Web界面，允许用户通过浏览器编辑、管理Home Assistant的配置文件，简化配置流程，并支持GIT集成以实现配置版本控制。

核心功能和特性

• 多架构支持：兼容Linux x32/64和ARM架构，适用于普通服务器及树莓派等设备。
• Web配置界面：提供直观的Web界面，方便编辑Home Assistant配置文件。
• GIT集成：支持通过SSH或HTTPS方式集成GIT，实现配置文件的版本管理。
• 灵活配置：支持通过配置文件（settings.conf）或环境变量进行参数配置。
• 持久化存储：通过卷挂载实现配置文件和Home Assistant配置的持久化。

使用场景和适用范围

适用于使用Docker部署Home Assistant的用户，需要通过Web界面便捷管理配置文件的场景，尤其适合希望通过GIT进行配置版本控制、多人协作管理Home Assistant配置的用户。

使用方法和配置说明

Docker Compose示例

以下是docker-compose.yaml配置示例：

yaml
  hass-configurator:
    image: "docker.xuanyuan.run/causticlab/hass-configurator-docker:latest"
    restart: always
    ports:
      - "3218:3218/tcp"
    networks:
      - hass-network
    volumes:
      - "./data/configurator-config:/config"  # 映射配置工具自身配置
      - "./data/config:/hass-config"          # 映射Home Assistant配置目录

配置说明

1. 目录映射：

   • 必须将Home Assistant的配置目录映射到容器的/hass-config路径。
   • 配置工具自身的配置目录需映射到容器的/config路径，且配置文件必须命名为settings.conf。

2. 环境变量配置： 从0.3.3版本开始，支持通过环境变量设置配置参数，但仍需映射Home Assistant配置目录（/hass-config）。

GIT集成

如需使用GIT集成功能，可选择以下任一方式：

方式1：挂载SSH文件

yaml
  hass-configurator:
    volumes:
      - "/path/.ssh/id_rsa:/root/.ssh/id_rsa:ro"        # SSH私钥（只读）
      - "/path/.ssh/id_rsa.pub:/root/.ssh/id_rsa.pub:ro"  # SSH公钥（只读）
      - "/path/.ssh/known_hosts:/root/.ssh/known_hosts:rw"  # 已知主机（读写）

方式2：使用HTTPS与GitHub Token

通过以下格式的链接使用HTTPS方式（需GitHub用户名和Token）：

https://<github用户名>:<token>@github.com/<github用户名>/<仓库名>.git

DockerHub标签说明

• 0.4.1及以上版本：采用多架构容器，标签格式为版本号（如0.4.1）或latest（最新版）。
• 0.3.3版本：为保持向后兼容，Docker Hub同时提供旧版标签；2018-12-23起，还提供特定架构的latest标签（如针对特定架构的最新版）。

本地构建

如需本地构建镜像，可使用以下命令：

bash
docker build -f . --build-arg HC_BUILD_VERSION=<HASS_CONFIGURATOR版本> . -t <镜像名称> --no-cache

参数说明

--build-arg HC_BUILD_VERSION=<HASS_CONFIGURATOR版本>：指定要安装的hass-configurator版本。例如，若当前最新版本为0.4.0，可使用--build-arg HC_BUILD_VERSION=0.4.0。

相关链接

• 原仓库（danielperna84）：https://github.com/danielperna84/hass-configurator
• Docker镜像（Docker Hub）：https://hub.docker.com/r/causticlab/hass-configurator-docker/
• GitHub仓库：https://github.com/CausticLab/hass-configurator-docker