Installation¶

Requirements¶

The plugin has no dependencies of its own beyond NetBox, and it adds no database tables, so there is nothing to migrate.

Bare metal or VM¶

Install the package into NetBox's virtual environment:

source /opt/netbox/venv/bin/activate
pip install netbox-permissions-matrix-plugin

To keep it across NetBox upgrades, add it to local_requirements.txt:

echo netbox-permissions-matrix-plugin >> /opt/netbox/local_requirements.txt

Enable it in /opt/netbox/netbox/netbox/configuration.py:

PLUGINS = ["netbox_permissions_matrix_plugin"]

Collect the static files (the matrix page ships a small script and stylesheet) and restart NetBox:

cd /opt/netbox/netbox
python manage.py collectstatic --no-input
sudo systemctl restart netbox netbox-rq

netbox-docker¶

Add the package to plugin_requirements.txt:

netbox-permissions-matrix-plugin

Enable it in configuration/plugins.py:

PLUGINS = ["netbox_permissions_matrix_plugin"]

Then rebuild the image as described in the netbox-docker plugin guide. The image runs collectstatic on start.

Check that it works¶

Log in as a user who can view permissions and open Admin > Authentication > Permissions Matrix, right below Permissions. If the item is missing, see Configuration for the menu_placement setting, and check Admin > System > Plugins that the plugin is listed.

Uninstalling¶

Remove the plugin from PLUGINS, restart NetBox, then pip uninstall netbox-permissions-matrix-plugin. The permissions it created or changed are ordinary NetBox permissions and keep working.