netbox-community-netbox/docs/plugins/index.md

# Plugins

Plugins are packaged [Django](https://docs.djangoproject.com/) 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.

Please see the documented instructions for [installing a plugin](./installation.md) to get started.

## Capabilities

The NetBox plugin architecture allows for the following:

* **Add new data models.** A plugin can introduce one or more models to hold data. (A model is essentially a table in the SQL database.)
* **Add new URLs and views.** Plugins can register URLs under the `/plugins` root path to provide browsable views for users.
* **Add content to existing model templates.** A template content class can be used to inject custom HTML content within the view of a core NetBox model. This content can appear in the left side, right side, or bottom of the page.
* **Add navigation menu items.** Each plugin can register new links in the navigation menu. Each link may have a set of buttons for specific actions, similar to the built-in navigation items.
* **Add custom middleware.** Custom Django middleware can be registered by each plugin.
* **Declare configuration parameters.** Each plugin can define required, optional, and default configuration parameters within its unique namespace. Plug configuration parameter are defined by the user under `PLUGINS_CONFIG` in `configuration.py`.
* **Limit installation by NetBox version.** A plugin can specify a minimum and/or maximum NetBox version with which it is compatible.

## Limitations

Either by policy or by technical limitation, the interaction of plugins with NetBox core is restricted in certain ways. A plugin may not:

* **Modify core models.** Plugins may not alter, remove, or override core NetBox models in any way. This rule is in place to ensure the integrity of the core data model.
* **Register URLs outside the `/plugins` root.** All plugin URLs are restricted to this path to prevent path collisions with core or other plugins.
* **Override core templates.** Plugins can inject additional content where supported, but may not manipulate or remove core content.
* **Modify core settings.** A configuration registry is provided for plugins, however they cannot alter or delete the core configuration.
* **Disable core components.** Plugins are not permitted to disable or hide core NetBox components.
Initial documentation for plugins framework 2020-03-20 12:20:25 -04:00			`# Plugins`

			`Plugins are packaged [Django](https://docs.djangoproject.com/) 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.`

Closes #10696: Break out instructions for installing & removing plugins (#15757) * Closes #10696: Break out instructions for installing & rmeoving plugins * Misc cleanup 2024-04-17 11:58:14 -04:00			`Please see the documented instructions for [installing a plugin](./installation.md) to get started.`

Initial documentation for plugins framework 2020-03-20 12:20:25 -04:00			`## Capabilities`

			`The NetBox plugin architecture allows for the following:`

Revised plugins documentation 2020-03-26 11:09:20 -04:00			`* Add new data models. A plugin can introduce one or more models to hold data. (A model is essentially a table in the SQL database.)`
			* Add new URLs and views. Plugins can register URLs under the `/plugins` root path to provide browsable views for users.
Initial documentation for plugins framework 2020-03-20 12:20:25 -04:00			`* Add content to existing model templates. A template content class can be used to inject custom HTML content within the view of a core NetBox model. This content can appear in the left side, right side, or bottom of the page.`
			`* Add navigation menu items. Each plugin can register new links in the navigation menu. Each link may have a set of buttons for specific actions, similar to the built-in navigation items.`
			`* Add custom middleware. Custom Django middleware can be registered by each plugin.`
Revised plugins documentation 2020-03-26 11:09:20 -04:00			* Declare configuration parameters. Each plugin can define required, optional, and default configuration parameters within its unique namespace. Plug configuration parameter are defined by the user under `PLUGINS_CONFIG` in `configuration.py`.
Initial documentation for plugins framework 2020-03-20 12:20:25 -04:00			`* Limit installation by NetBox version. A plugin can specify a minimum and/or maximum NetBox version with which it is compatible.`

			`## Limitations`

Revised plugins documentation 2020-03-26 11:09:20 -04:00			`Either by policy or by technical limitation, the interaction of plugins with NetBox core is restricted in certain ways. A plugin may not:`
Initial documentation for plugins framework 2020-03-20 12:20:25 -04:00
			`* Modify core models. Plugins may not alter, remove, or override core NetBox models in any way. This rule is in place to ensure the integrity of the core data model.`
Revised plugins documentation 2020-03-26 11:09:20 -04:00			* Register URLs outside the `/plugins` root. All plugin URLs are restricted to this path to prevent path collisions with core or other plugins.
			`* Override core templates. Plugins can inject additional content where supported, but may not manipulate or remove core content.`
Initial documentation for plugins framework 2020-03-20 12:20:25 -04:00			`* Modify core settings. A configuration registry is provided for plugins, however they cannot alter or delete the core configuration.`
			`* Disable core components. Plugins are not permitted to disable or hide core NetBox components.`