NetBox Copilot Quickstart Guide

What is NetBox Copilot?

NetBox Copilot is an AI-powered assistant for every NetBox to explore, understand, and act on your NetBox data. It provides intelligent search, data insights, and contextual assistance directly within your NetBox interface.

Public Preview Notice: NetBox Copilot is currently in public preview (beta). You may encounter rough edges, and we're actively refining the product based on user feedback. We encourage you to share your experiences to help us improve.

How to Enable Copilot

There are three ways to enable NetBox Copilot in your environment:

Option 1: NetBox Cloud (Recommended)

If you're using NetBox Cloud, enabling Copilot is simple:

1. Email support@netboxlabs.com with your NetBox instance hostname
2. We'll quickly enable Copilot for your instance
3. Refresh your NetBox interface and Copilot will appear

Option 2: Add Script Tag to Template

For self-hosted NetBox installations, you can permanently enable Copilot by adding a script tag to your base template:

1. Locate your NetBox installation's base template file:

   • Typically found at: /opt/netbox/netbox/templates/base.html
   • Or in your custom templates directory if you're using template overrides

2. Add the following script tag before the closing </body> tag:

{% if request.user.is_authenticated %}
<!-- NetBox Copilot -->
<script src="https://static.copilot.netboxlabs.ai/load.js" defer></script>
{% endif %}

3. Restart your NetBox service to apply the changes

Option 3: Temporary Enable via Console

For quick testing or evaluation, you can temporarily enable Copilot using your browser's developer console:

1. Open your NetBox instance in a web browser
2. Open the developer console (F12 or right-click → Inspect → Console)
3. Paste and run the following code:

const script = document.createElement('script');
script.src = 'https://static.copilot.netboxlabs.ai/load.js';
document.head.appendChild(script);

4. Copilot will appear in the bottom-right corner of your NetBox interface
5. Note: This method only enables Copilot for the current browser session

Using NetBox Copilot

Account Setup

• If you don't already have a NetBox Cloud account, you'll need to create one
• You can do this directly in Copilot quickly and easily when you first open it
• If you already have a NetBox Cloud account, you can log in with your existing credentials

Getting Started

• Once enabled, Copilot appears as a chat interface in the bottom-right corner of your NetBox interface
• Quick tip: Press Ctrl+I (or Cmd+I on Mac) to quickly expand or collapse the Copilot interface
• Using Copilot is intuitive - just start chatting! Ask questions about your data, request help finding specific objects, or get insights about your network infrastructure

Compatibility

NetBox Copilot is compatible with:

• Any recent NetBox version
• Strongly recommended: NetBox 4.2.x or newer for the best experience
• All modern web browsers (Chrome, Firefox, Safari, Edge)

Limitations

During the public preview, NetBox Copilot has the following limitations:

Read-Only Access

• Copilot is explicitly unable to make any changes to your NetBox data
• It can only read and analyze existing information
• All interactions are safe and non-destructive

Usage Limits

• Limited usage credits are provided during the public preview phase
• If you run out of credits and want to continue using Copilot, email product@netboxlabs.com with your login details
• We'll provide additional credits to support your evaluation

Getting Help & Providing Feedback

We're here to help and value your feedback:

• Issues enabling Copilot?
• Encountering strange or persistent behavior?
• Have suggestions to improve the product experience?

Please email product@netboxlabs.com with:

• Your login details (email address used for Copilot)
• Description of the issue or feedback
• Your NetBox instance details (if applicable)

Your feedback is crucial in helping us refine NetBox Copilot during this public preview phase. Thank you for being an early adopter!