首页
/ Homer项目与Pi-hole v6 API兼容性升级指南

Homer项目与Pi-hole v6 API兼容性升级指南

2025-05-23 17:44:22作者:翟萌耘Ralph

背景概述

Homer作为一款开源的仪表盘工具,常被用于整合各类服务的状态监控。其中对Pi-hole广告拦截服务的支持是其重要功能之一。随着Pi-hole升级至v6版本,其API架构发生了重大变更,从传统接口迁移至RESTful风格,这直接影响了Homer现有的集成方案。

API变更深度解析

Pi-hole v6引入了全新的认证机制和数据结构:

  1. 认证流程重构
    新版API采用会话令牌机制,需先通过密码认证获取SID:

    POST /api/auth
    Headers: { "accept": "application/json" }
    Body: { "password": "your_password" }
    

    成功后将返回包含sid字段的响应,该令牌需用于后续所有API请求的sid头字段。

  2. 数据端点优化
    核心统计接口变更为:

    GET /api/stats/summary
    Headers: { "sid": "获取的令牌值" }
    

    响应中的关键指标位于queries对象内,特别是percent_blocked字段直接提供拦截百分比。

  3. 响应结构规范化
    相较于v5的平面结构,v6采用嵌套JSON格式,更符合REST规范,例如:

    {
      "queries": {
        "total": 1500,
        "blocked": 300,
        "percent_blocked": 20
      }
    }
    

技术实现方案

针对此次升级,Homer项目组提出了两种技术路线:

方案A:直接适配v6 API

  • 完全基于新API规范实现
  • 需要用户配置密码认证
  • 代码结构简洁,维护成本低

方案B:双版本兼容方案

  • 自动检测Pi-hole版本
  • 对v5保留原有接口支持
  • 对v6采用新认证流程
  • 增加版本过渡缓冲期

最终采纳方案B,因其具备更好的向后兼容性,给予用户充分的升级窗口期。实现时通过以下技术点确保稳定性:

  1. 版本探测机制
    主动请求API端点,根据响应特征判断版本

  2. 认证模块封装
    将令牌获取流程抽象为独立服务模块

  3. 错误处理增强
    针对认证失败、版本不匹配等场景增加友好提示

用户升级指南

现有用户需注意:

  1. 若Pi-hole已升级至v6:

    • 在Homer配置中添加password字段
    • 移除旧的API密钥配置
    • 验证端点URL是否更新为/api路径
  2. 仍运行v5版本的用户:

    • 可继续使用现有配置
    • 建议规划升级路径
  3. 配置示例:

    - name: "Pi-hole"
      type: "pihole"
      url: "http://pi.hole"
      password: "your_admin_password"
      # 原有api_key字段不再需要
    

最佳实践建议

  1. 为Homer创建专用API账户
  2. 定期轮换认证密码
  3. 监控API调用成功率
  4. 考虑使用HTTPS加密通信

此次升级体现了Homer项目对生态兼容性的重视,通过优雅的过渡方案确保用户体验的连贯性。开发者可借此机会审视自身的集成实现,为未来的API演进做好准备。

登录后查看全文
热门项目推荐
相关项目推荐