mirror of
https://github.com/netbox-community/netbox.git
synced 2025-07-14 01:41:22 -06:00
076d16ca6b
* 19073 allow plugins to be marked as hidden or disabled in plugins table * 19073 allow plugins to be marked as hidden or disabled in plugins table * 19073 allow plugins to be marked as hidden or disabled in plugins table * 19073 review changes * Rename 'unlinked' to 'static' & update docs --------- Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>
54 lines
1.6 KiB
Markdown
54 lines
1.6 KiB
Markdown
# Plugin Parameters
|
|
|
|
## PLUGINS
|
|
|
|
Default: Empty
|
|
|
|
A list of installed [NetBox plugins](../plugins/index.md) to enable. Plugins will not take effect unless they are listed here.
|
|
|
|
!!! warning
|
|
Plugins extend NetBox by allowing external code to run with the same access and privileges as NetBox itself. Only install plugins from trusted sources. The NetBox maintainers make absolutely no guarantees about the integrity or security of your installation with plugins enabled.
|
|
|
|
---
|
|
|
|
## PLUGINS_CONFIG
|
|
|
|
Default: Empty
|
|
|
|
This parameter holds configuration settings for individual NetBox plugins. It is defined as a dictionary, with each key using the name of an installed plugin. The specific parameters supported are unique to each plugin: Reference the plugin's documentation to determine the supported parameters. An example configuration is shown below:
|
|
|
|
```python
|
|
PLUGINS_CONFIG = {
|
|
'plugin1': {
|
|
'foo': 123,
|
|
'bar': True
|
|
},
|
|
'plugin2': {
|
|
'foo': 456,
|
|
},
|
|
}
|
|
```
|
|
|
|
Note that a plugin must be listed in `PLUGINS` for its configuration to take effect.
|
|
|
|
---
|
|
|
|
## PLUGINS_CATALOG_CONFIG
|
|
|
|
Default: Empty
|
|
|
|
This parameter controls how individual plugins are displayed in the plugins catalog under Admin > System > Plugins. Adding a plugin to the `hidden` list will omit that plugin from the catalog. Adding a plugin to the `static` list will display the plugin, but not link to the plugin details or upgrade instructions.
|
|
|
|
An example configuration is shown below:
|
|
|
|
```python
|
|
PLUGINS_CATALOG_CONFIG = {
|
|
'hidden': [
|
|
'plugin1',
|
|
],
|
|
'static': [
|
|
'plugin2',
|
|
],
|
|
}
|
|
```
|