NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-22 20:12:00 -06:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Updated Plugins (markdown)

Jeremy Stretch 2022-03-18 08:37:43 -04:00
parent 05838fc531
commit 516c1b0f3f
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Plugins.md

@ -1,15 +1,20 @@
# Intro to Plugins
[Plugins](https://netbox.readthedocs.io/en/stable/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 and views, but cannot interfere with existing components. A NetBox user may opt to install plugins provided by the community or build his or her own.
[Plugins](https://netbox.readthedocs.io/en/stable/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](https://github.com/netbox-community/netbox/wiki/Community-Contributions#plugins). You can also search for GitHub repositories with the [`netbox-plugin`](https://github.com/topics/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 Development Tutorial](https://github.com/netbox-community/netbox-plugin-tutorial) (requires NetBox v3.2+)
* [Plugins Documentation](https://netbox.readthedocs.io/en/stable/plugins/#plugins)
# Publishing Plugins
### Plugin Support
NetBox plugins published on GitHub should apply the [netbox-plugin](https://github.com/topics/netbox-plugin) topic. This will help interested users find new plugins.
# Plugin Support
Each plugin is not maintained by the NetBox core and are in varying states. Please open feature requests and other issues with the plugin project directly. If a developer needs to request a feature or bug fix for the plugins function within the core NetBox repository, they can do so as normally.
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.)