NetBox QR Code 插件使用教程

1. 项目的目录结构及介绍

NetBox QR Code 插件的目录结构如下：

netbox-qrcode/
├── docs/
│   └── img/
├── github/
│   └── workflows/
├── netbox_qrcode/
├── .gitignore
├── CODEOWNERS
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.md
├── setup.py

• docs/：包含插件的文档和截图。
• github/workflows/：包含 GitHub Actions 的工作流配置。
• netbox_qrcode/：插件的核心代码目录。
• .gitignore：Git 忽略文件配置。
• CODEOWNERS：代码所有者配置。
• LICENSE：插件的许可证（Apache-2.0）。
• MANIFEST.in：Python 包的清单文件。
• Makefile：用于构建和管理的 Makefile。
• README.md：项目的说明文档。
• setup.py：Python 包的安装脚本。

2. 项目的启动文件介绍

NetBox QR Code 插件的启动文件主要是 setup.py，它负责插件的安装和分发。通过运行 pip install . 命令，可以安装该插件。

3. 项目的配置文件介绍

插件的配置文件主要在 NetBox 的配置文件中进行设置。以下是配置插件的步骤：

1. 激活 NetBox 的虚拟环境：

   source /opt/netbox/venv/bin/activate
   

2. 安装插件：

   pip install netbox-qrcode
   

3. 在 NetBox 的配置文件 /opt/netbox/netbox/netbox/configuration.py 中启用插件：

   PLUGINS = ['netbox_qrcode']
   

4. 重启 NetBox 服务。

插件的配置选项包括：

• with_text：布尔值，默认值为 True，表示是否在 QR 码图像中添加文本标签。
• text_template：Jinja2 模板，使用 [[ obj ]] 作为上下文，可以输出设备、机架等信息。例如：

  'text_template': 'Name: [[ obj.name ]]\nSite: [[ obj.site ]]'
  

• text_fields：字符串列表，默认值为 ['name']，表示要显示的文本字段。

通过这些配置选项，可以自定义 QR 码的生成方式和显示内容。