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:
1. Install the 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)
},
}
3. Run Database Migrations¶
Apply the database migrations to create the necessary tables:
4. Collect Static Files¶
Collect static files to ensure the plugin's CSS and JavaScript are properly served:
5. Restart NetBox Services¶
Restart the NetBox services to apply the changes:
Next Steps:¶
- Create commands
- Set up permissions
- Debug logging (Optional)
Upgrading¶
To upgrade to a newer version of the plugin:
-
Install the new version:
-
Apply any new migrations:
-
Collect static files:
-
Restart NetBox services: