NetBox QR Code

This NetBox plugin generates printable QR code labels for objects in NetBox. Labels are rendered directly on an object's detail view, and each object type can carry several independent label designs — different sizes, different content, or different layouts for the same device.

Supported object types are Device, Module, Rack, Cable, Location, Power Feed, and Power Panel, plus Asset when netbox-inventory is installed.

See the compatibility matrix for supported NetBox versions.

Installation

Brief installation instructions are provided below. For a complete installation guide, please refer to the included documentation.

1. Activate the NetBox virtual environment:

$ source /opt/netbox/venv/bin/activate

2. Install the plugin from PyPI:

$ pip install netbox-qrcode

3. Add netbox_qrcode to PLUGINS in configuration.py:

PLUGINS = [
    # ...
    'netbox_qrcode',
]

4. Add netbox-qrcode to local_requirements.txt so the plugin survives future upgrades, then restart NetBox:

$ sudo systemctl restart netbox netbox-rq

This plugin requires no database migrations.

Documentation

• Introduction — what the plugin does and how labels are assembled
• Installation — full installation guide
• Configuration — reference for every configuration parameter
• Label Examples — worked label designs you can copy
• Printing — printer and browser settings for accurate output
• Change Log

Contributing

Issues and pull requests are welcomed. Please note that pull requests are accepted only for approved issues.

This repository follows the same two-branch model as NetBox itself:

• feature — active development of future releases. Base your pull requests on this branch.
• main — the released code. Releases are cut from here; feature is merged into main to release.

GitHub defaults the base branch to main, so remember to switch the base to feature when opening a pull request.