{% extends 'base/layout.html' %} {% block title %}{{ plugin.name }} Added{% endblock %} {% block breadcrumbs %} {% endblock %} {% block content %}

{% if install_method == "requirements" %} Added {{ plugin.name }} to Requirements {% else %} Successfully Installed {{ plugin.name }} {% endif %}

{% if install_method == "requirements" %}
Container Restart Required

The package has been added to requirements-extra.txt. You need to restart the NetBox container to install and activate it.

Step 1: Edit configuration/plugins.py

Add the plugin to your plugins configuration:

{{ config_snippet }}
Step 2: Restart the Container

Restart the NetBox container to install the package and load the plugin:

cd /path/to/netbox-docker
docker-compose down && docker-compose up -d

The container will automatically install packages from requirements-extra.txt on startup, run migrations, and collect static files.

{% else %}
Action Required

The package has been installed via pip, but you need to complete the following steps to activate it.

Step 1: Edit configuration.py

Add the following to your NetBox configuration file:

{{ config_snippet }}
Step 2: Run Migrations

Execute the following command to apply any database changes:

{{ commands.migrate }}
Step 3: Collect Static Files

Execute the following command to collect plugin static assets:

{{ commands.collectstatic }}
Step 4: Restart NetBox

Restart your NetBox service to load the plugin:

# Docker Compose
{{ commands.restart_docker }}

# Systemd
{{ commands.restart_systemd }}
{% endif %}
{% endblock %}