NetBox QR-二维码插件安装汉化教程

本文最后更新于 2024年7月18日中午

简介

本文章主要介绍安装QR插件并进行中文字体支持、字段汉化、增加下载功能，自定义显示字段等。

Netbox 的QR插件，用于给各种实体生成二维码标签，用于贴在实体上。二维码为实体的netbox网址。

Netbox系列文章：https://songxwn.com/categories/NetBox/

适用于 Netbox 4.0.3 、netbox_qrcode 0.0.12

安装

source /opt/netbox/venv/bin/activate
# 进入netbox虚拟python环境
pip install netbox-qrcode
# 安装相关包

中文字体支持和汉化、下载功能增加

cd /opt/netbox/venv/lib/python3.11/site-packages/netbox_qrcode/fonts/
# 切换到库的字体目录
wget -O SourceHanSansSC.ttf https://mirrors.bfsu.edu.cn/adobe-fonts/source-han-sans/OTF/SimplifiedChinese/SourceHanSansSC-Normal.otf
# 下载开源字体到字体目录
cd /opt/netbox/venv/lib/python3.11/site-packages/netbox_qrcode/templates/netbox_qrcode
# 进入库的Web模板目录
mv qrcode3.html /tmp
# 移动原文件到临时目录
wget -O qrcode3.html https://songxwn.com/file/qrcode3.html.file
# 下载汉化和增加下载功能的QR替换模板（可选）

开启和配置

cd /opt/netbox/netbox/netbox
# 进入目录
sudo -u netbox vim configuration.py
# 以netbox 用户打开文件

配置示例

PLUGINS = ['netbox_qrcode']
# 插件开启列表
PLUGINS_CONFIG = {
    'netbox_qrcode': {
        'with_text': True,  # 是否开启文字显示
        'text_fields': ['name', 'serial'],
        'font': 'SourceHanSansSC',  # 指定上面下载的中文开源字体
        'custom_text': '所属： Songxwn.com',
        'text_location': 'right',  # 文字显示方向为右边
        'qr_version': 1,           # QR版本
        'qr_error_correction': 0,
        'qr_box_size': 6,
        'qr_border': 4,
        # per object options
        'cable': None,  # disable QR code for Cable object
        'rack': {
            'text_template': '{{ obj.name }}\n租户: {{ obj.tenant }}\n站点: {{ obj.site }}',
            'qr_box_size': 6,
            'custom_text': None,
        },  # 机柜二维码生成开启并定义显示文字的字段
        'device': {
            'text_template': '{{ obj.name }}\n带外管理IP: {{ obj.oob_ip }}\n主IPv4地址: {{ obj.primary_ip }}\n序列号: {{ obj.serial }}\n位置: {{ obj.location }}\n机柜: {{ obj.rack }} - U位: {{ obj.position }}',
            
            'qr_box_size': 6,
            'custom_text': None,
        } # 设备二维码生成开启并定义显示文字的字段
    }
}
# 插件自定配置