Plugin Upgrade

This guide explains how to upgrade the NetBox Toolkit Plugin to a newer version.

Upgrade Process

1. Activate Virtual Environment

source /opt/netbox/venv/bin/activate

2. Upgrade the Plugin

pip install --upgrade netbox-toolkit-plugin

3. Apply Database Migrations

Apply any new database migrations that come with the updated version:

cd /opt/netbox/netbox
python3 manage.py migrate netbox_toolkit_plugin

4. Collect Static Files

Update static files (CSS, JavaScript) to ensure new features display correctly:

python3 manage.py collectstatic --no-input

5. Restart NetBox Services

Restart NetBox to load the new version:

sudo systemctl restart netbox netbox-rq

Getting Help

If you encounter issues during upgrade:

1. Check the Changelog for known issues
2. Review GitHub Issues
3. Ask in GitHub Discussions