casperklein/homeassistant-netbox Docker 镜像 - 轩辕镜像

Netbox for Home Assistant

镜像概述

Netbox for Home Assistant是一个基于Netbox的Home Assistant插件。Netbox是一款开源的网络管理与文档记录web应用，旨在帮助用户高效管理和记录计算机网络架构、设备、IP地址、机架布局、线缆连接等网络资源，适用于家庭网络、小型办公网络等场景的网络管理需求。

核心功能与特性

• 网络资源管理：支持网络设备、IP地址、前缀、VLAN、机架、线缆等网络资源的记录与管理
• Web界面访问：提供直观的web界面，便于可视化查看和操作网络资源
• 安全访问：支持HTTPS加密访问，保障网络管理数据安全
• 灵活配置：支持自定义Netbox配置，可扩展安装Netbox插件
• 多架构支持：支持amd64和aarch64架构

使用场景与适用范围

适用于在Home Assistant环境中需要管理家庭网络、小型办公网络的用户，帮助用户：

• 记录网络拓扑结构及设备连接关系
• 管理IP地址分配与使用情况
• 跟踪网络设备的物理位置（如机架布局）
• 记录线缆连接信息，便于故障排查
• 扩展网络管理功能（通过安装Netbox插件）

安装方法

前提条件

• 已安装Home Assistant系统
• 可访问互联网（用于下载插件及依赖）

安装步骤

1. 向Home Assistant添加插件仓库：[***]
   
2. 在Home Assistant插件商店中找到并安装“netbox”插件
3. 在插件选项中设置user（用户名）和password（密码）
   此设置将在插件启动后创建Netbox超级用户，创建成功后需从插件选项中移除这些凭据，否则插件无法启动
4. 启动插件
5. 点击“打开Web界面”按钮访问Netbox

配置说明

注意：配置更改后需重启插件方可生效。

配置示例

json
{
  "user": "admin",
  "password": "your_secure_password",
  "https": true,
  "certfile": "fullchain.pem",
  "keyfile": "privatekey.pem",
  "LOGIN_REQUIRED": true,
  "debug": false
}

注意：以上仅为示例，请勿直接复制使用！请根据实际需求创建配置。

配置选项详解

user / password

• 作用：设置Netbox超级用户的用户名和密码，插件启动时将创建该用户
• 重要提示：仅在首次创建用户时使用，成功创建后需从配置中移除这两个参数，否则插件无法启动。创建结果可通过插件日志确认。

https

• 类型：布尔值（true/false）
• 作用：启用/禁用Web界面的HTTPS访问，true为启用，false为禁用（默认禁用）

certfile

• 类型：字符串
• 作用：HTTPS证书文件名称，需包含证书链
• 要求：文件必须存储在Home Assistant的/ssl目录中（Home Assistant默认SSL目录），若文件不存在，插件启动将失败

keyfile

• 类型：字符串
• 作用：HTTPS私钥文件名称
• 要求：文件必须存储在Home Assistant的/ssl目录中，若文件不存在，插件启动将失败

LOGIN_REQUIRED

• 类型：布尔值（true/false）
• 作用：控制用户访问权限，false允许用户查看大部分数据（但不可修改），true（默认）要求所有用户登录后访问

debug

• 类型：布尔值（true/false）
• 作用：启用调试模式后，合并后的Netbox配置文件（默认配置+自定义配置）将保存至addon_configs/0da538cf_netbox/configuration-merged.py，便于排查配置问题

自定义Netbox配置

Netbox支持通过配置文件扩展功能（如安装插件），具体方法如下：

扩展配置（configuration.py）

• 若文件addon_configs/0da538cf_netbox/configuration.py存在，其内容将追加至Netbox默认配置中
• 用于配置Netbox插件、自定义设置等

示例：

python
# addon_configs/0da538cf_netbox/configuration.py
PLUGINS = ['netbox_bgp', 'netbox_ipcalculator', 'netbox_qrcode', 'netbox_metatype_importer']

PLUGINS_CONFIG = {
    'netbox_metatype_importer': {
        'github_token': 'your_github_token'  # 替换为实际GitHub Token
    }
}

安装依赖（requirements.txt）

• 若文件addon_configs/0da538cf_netbox/requirements.txt存在，插件启动时将通过pip安装文件中列出的依赖包
• 用于安装Netbox插件或其他依赖库

示例：

txt
# addon_configs/0da538cf_netbox/requirements.txt
netbox-bgp
netbox-ipcalculator
netbox-qrcode
netbox-metatype-importer

注意：依赖包需从互联网下载，因此插件启动时需保证网络连接正常。

截图展示

主页面

!主页面截图

机架布局

!机架布局截图

前缀层级

!前缀层级截图

线缆追踪

!线缆追踪截图