Skip to content

Plugins

Jeremy Stretch edited this page Mar 18, 2022 · 20 revisions

Intro to Plugins

Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can introduce their own models, views, and other resources, but cannot interfere with core components. A NetBox user may opt to install plugins provided by the community or build his or her own.

Plugins are supported on NetBox v2.8 and later.

Finding Plugins

You can find a curated list of popular plugins on our wiki. You can also search for GitHub repositories with the netbox-plugin topic applied.

Developing Plugins

Anyone is free and welcome to develop a plugin for NetBox. This can be a project that you use internally within your organization, an open source project, or even a commercial product. To get started with a plugin, we suggest first completing the official development tutorial. This will walk you through the process of creating a plugin from scratch. From there, the plugins framework documentation should have everything you need.

Plugin Support

Please note that each plugin is its own project and maintained by its respective owner(s). The NetBox core team cannot provide assistance with plugin-specific issues. If you run into a problem installing or using a plugin, please consult the plugin's documentation to determine where to ask for help. (Generally, users will be advised to submit an issue to the plugin's repository on GitHub or elsewhere.)

Clone this wiki locally