Skip to content

Installation

This guide explains how to install the NetBox Toolkit Plugin in your NetBox environment.

Installation Steps

First activate your virtual environment and install the plugin:

source /opt/netbox/venv/bin/activate

1. Install the Plugin

pip install netbox-toolkit-plugin

2. Enable in NetBox

Add 'netbox_toolkit_plugin' to PLUGINS in your NetBox configuration 

# In your NetBox configuration.py
PLUGINS = [
    'netbox_toolkit_plugin',
    # ... other plugins
]

PLUGINS_CONFIG = {
    'netbox_toolkit_plugin': {
        'rate_limiting_enabled': True,      # Enable/disable rate limiting (default: True)
        'device_command_limit': 10,         # Max commands per device per time window (default: 10)
        'time_window_minutes': 5,           # Time window in minutes (default: 5)
        'bypass_users': [],                 # List of usernames who bypass rate limiting (default: [])
        'bypass_groups': [],                # List of group names who bypass rate limiting (default: [])
        'debug_logging': False,             # Enable debug logging for this plugin (default: False)
    },
}
See Plugin Configuration for more details.

3. Run Database Migrations

Apply the database migrations to create the necessary tables:

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

4. Collect Static Files

Collect static files to ensure the plugin's CSS and JavaScript are properly served:

cd /opt/netbox/netbox
python3 manage.py collectstatic

5. Restart NetBox Services

Restart the NetBox services to apply the changes:

sudo systemctl restart netbox netbox-rq

Next Steps:

Upgrading

To upgrade to a newer version of the plugin:

  1. Install the new version: 

    pip install --upgrade netbox-toolkit-plugin

  2. Apply any new migrations: 

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

  3. Collect static files: 

    python3 manage.py collectstatic

  4. Restart NetBox services: 

    sudo systemctl restart netbox netbox-rq