fridayai/friday

Friday 家庭自动化助手镜像文档

镜像概述

Friday 是一款开源的家庭自动化助手，提供一站式家庭智能设备管理与自动化规则配置解决方案。该镜像封装了Friday的核心服务，支持快速部署，帮助用户轻松构建个性化的智能家居系统，实现设备联动、场景自动化等功能。

核心功能与特性

• 多设备兼容：支持主流智能家居协议（如Wi-Fi、蓝牙、Zigbee等），兼容多种品牌智能设备（灯光、温控器、传感器等）。
• 自动化规则引擎：支持基于时间、事件（如设备状态变化、传感器触发）的自定义自动化规则，实现场景化控制（如"回家模式"自动开灯、开空调）。
• 开源可扩展：基于开源架构，支持用户自定义插件开发，扩展设备支持范围或功能模块。
• 跨平台访问：提供Web管理界面及移动端API，支持多终端远程控制与监控。
• 数据本地化：支持本地数据存储，保障用户隐私与数据安全。

使用场景与适用范围

• 家庭智能设备集中管理：统一管控分散的智能设备，简化操作流程。
• 日常场景自动化：配置晨起、离家、回家、睡眠等场景的自动化执行。
• 定时任务与条件触发：如定时开关灯、温湿度异常时自动调节空调。
• 智能家居爱好者DIY：开发者可基于开源代码二次开发，定制专属功能。

使用方法与配置说明

基本部署（Docker Run）

bash
docker run -d \
  --name friday-home-assistant \
  -p 8080:8080 \
  -v /path/to/local/data:/app/data \
  --restart unless-stopped \
  docker.xuanyuan.run/friday-home-assistant:latest

参数说明：

• -p 8080:8080：映射Web管理界面端口（主机端口:容器端口）。
• -v /path/to/local/data:/app/data：挂载本地目录用于持久化存储设备配置、自动化规则等数据。

Docker Compose 配置

yaml
version: '3'
services:
  friday:
    image: docker.xuanyuan.run/friday-home-assistant:latest
    container_name: friday-home-assistant
    ports:
      - "8080:8080"
    volumes:
      - ./friday-data:/app/data
    restart: unless-stopped
    environment:
      - TZ=Asia/Shanghai  # 设置时区
      - LOG_LEVEL=info    # 日志级别（debug/info/warn/error）

环境变量配置

初始化与使用步骤

1. 启动容器：执行上述docker run或docker-compose up -d命令启动服务。
2. 访问管理界面：在浏览器中输入http://<主机IP>:8080，首次访问需完成初始化设置（创建管理员账户、配置设备接入方式）。
3. 添加设备：通过界面"设备管理"模块，按照指引添加智能设备（根据设备类型选择对应协议，如Wi-Fi设备需输入连接信息）。
4. 创建自动化规则：在"自动化"模块中，设置触发条件（如"当温湿度传感器检测到温度>26℃"）和执行动作（如"打开空调并设置为24℃"）。
5. 远程访问：配置端口映射或反向代理，实现外网远程访问与控制。

注意事项

• 确保宿主机网络环境支持设备通信（如Zigbee设备需配合网关，容器需与网关在同一网络）。
• 本地数据目录建议定期备份，避免配置丢失。
• 如需扩展设备支持，可参考官方文档开发自定义插件，并通过-v挂载插件目录至容器内/app/plugins路径。