Plugin Parameters

PLUGINS

Default: []

A list of installed NetBox plugins 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: []

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:

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:

PLUGINS_CATALOG_CONFIG = {
    'hidden': [
        'plugin1',
    ],
    'static': [
        'plugin2',
    ],
}