netbox-attachments 11.2.2

Netbox plugin to manage attachments for any model

NetBox Attachments Plugin

NetBox plugin for attaching files to NetBox objects.

Overview

netbox-attachments adds an attachment model and UI/API workflows to upload, link, and manage files against NetBox models.

• Project documentation: docs/index.md
• Installation guide: docs/installation.md
• Configuration reference: docs/configuration.md
• Usage guide: docs/usage.md
• Compatibility policy: docs/compatibility.md
• Release process: docs/release-process.md

Compatibility

Supported now:

• NetBox: 4.5.x – 4.6.x
• Plugin: 11.x
• Python: 3.12, 3.13, 3.14

Compatibility details and legacy version notes are documented in docs/compatibility.md.

Upgrading to NetBox 4.6 with existing attachments? A foreign-key error in migration 0007 can occur because NetBox 4.6 populates core_objecttype via a post-migrate signal. See the NetBox 4.6 upgrade notes and the fix_attachment_object_types management command (issue #107).

Installation

Install from PyPI:

pip install netbox-attachments

Enable the plugin in configuration.py:

PLUGINS = ["netbox_attachments"]

Create storage directory and set permissions:

mkdir -p /opt/netbox/netbox/media/netbox-attachments
chown netbox /opt/netbox/netbox/media/netbox-attachments

Run migrations:

python3 manage.py migrate netbox_attachments

Full installation details: docs/installation.md.

Configuration

Plugin settings are configured via PLUGINS_CONFIG["netbox_attachments"].

PLUGINS_CONFIG = {
    "netbox_attachments": {
        "applied_scope": "model",
        "scope_filter": ["dcim.device", "ipam.prefix", "tenancy"],
        "display_default": "right_page",
        "create_add_button": True,  # show top "Attachments" dropdown in additional_tab mode
        "display_setting": {"ipam.vlan": "left_page"},
    }
}

Complete settings reference: docs/configuration.md.

API

Attachment APIs are exposed under:

• /api/plugins/netbox-attachments/netbox-attachments/
• /api/plugins/netbox-attachments/netbox-attachment-assignments/

Workflow:

1. Upload/create attachment via netbox-attachments.
2. Link it to an object via netbox-attachment-assignments.

Additional usage details: docs/usage.md.

Testing

Primary local command:

make test

Packaging check:

python -m build

Support

• Bug reports and feature requests: GitHub Issues
• NetBox community support: NetDev Community Slack and GitHub Discussions in netbox-community

Contributing

Contribution workflow and expectations are documented in CONTRIBUTING.md.

Release Notes

Project release history follows Keep a Changelog:

• CHANGELOG.md

Screenshots

• Attachment List
• Attachment Detail
• Object Attachments Tab
• Create Assignment

License

Licensed under Apache 2.0. See LICENSE.