jcmendez/hass-configurator-docker

HASS Configurator

镜像概述和主要用途

HASS Configurator是一个小型Web应用（通过浏览器访问），提供文件系统浏览器和文本编辑器，用于修改其运行所在机器上的文件。它专为简化Home Assistant的配置而创建，基于Ace editor，支持多种代码/标记语言的语法高亮。YAML文件（Home Assistant配置文件的默认语言）在编辑时会自动检查语法错误。

重要提示：该配置器从CDN获取JavaScript库、CSS和字体，因此客户端设备离线时无法使用。仅支持Python 3。

核心功能和特性

• 基于Web的编辑器，支持语法高亮和YAML自动语法检查
• 文件上传和下载功能
• 提供可用触发器、事件、实体、条件和服务的列表，选中元素会插入到编辑器的光标位置
• Home Assistant事件观察器（通过WebSocket连接Home Assistant，查看所有发生的事件）
• 一键重启Home Assistant
• SSL支持
• 可选的身份验证和IP过滤，增强安全性
• 直接链接到Home Assistant文档和图标
• 执行shell命令
• Git仓库中暂存和提交更改，创建和切换分支，推送到SSH远程仓库
• 可自定义编辑器设置（使用localStorage保存）
• 独立模式，隐藏左侧Home Assistant相关面板（触发器、实体等）。设置HASS_API为None或使用命令行标志-s/--standalone启用此模式

截图

!https://github.com/danielperna84/hass-configurator/blob/master/screenshots/main.png

使用场景和适用范围

适用于需要通过Web界面便捷管理Home Assistant配置文件的用户，尤其适合希望在编辑时获得语法检查、快速插入Home Assistant相关元素、直接重启服务或集成Git版本控制的场景。

警告：此工具允许浏览文件系统和修改文件，请注意编辑的文件，不当操作可能损坏系统关键部分。

使用方法和配置说明

安装

安装方法详见Wiki：https://github.com/danielperna84/hass-configurator/wiki/Installation

配置

自定义配置器行为的可用选项详见Wiki：https://github.com/danielperna84/hass-configurator/wiki/Configuration

保持运行

由于配置器脚本本身不是服务，需要额外步骤以保持运行。相关信息详见Wiki：https://github.com/danielperna84/hass-configurator/wiki/Daemonizing

API

提供API用于以编程方式添加/删除ALLOWED_NETWORKS和BANNED_IPS中的IP地址/网络。使用方法详见Wiki：https://github.com/danielperna84/hass-configurator/wiki/API

嵌入到Home Assistant

正确设置配置器后，可使用Home Assistant的panel_iframe组件将其直接嵌入Home Assistant UI。示例配置如下：

yaml
panel_iframe:
  configurator:
    title: 配置器
    icon: mdi:wrench
    url: http://1.2.3.4:3218

重要提示：将配置器端口转发并嵌入Home Assistant时需谨慎。如果不通过要求身份验证和/或基于客户端IP地址阻止来限制访问，配置将暴露到互联网！