Plugin Installation Instructions

Prerequisites

Install the Plugin:

The plugin is available as a Python package on PyPI, and you can install it using pip:
```
pip install ipfabric_netbox
```
Ensure Automatic Reinstallation:

To make sure the plugin is automatically reinstalled during future upgrades, follow these steps:
- Create a file named local_requirements.txt in the NetBox root directory if it doesn’t already exist.
- Inside the local_requirements.txt file, add the ipfabric_netbox package.
Enable the Plugin:

After installing the plugin, you need to enable it in the NetBox configuration file (configuration.py).
- Open configuration.py and locate the PLUGINS list.
- Add 'ipfabric_netbox' to the PLUGINS list as shown below:
```
PLUGINS = ['ipfabric_netbox']
```
Run the Upgrade Script:

To apply the changes, run the NetBox upgrade script. You can use the following command:
```
sudo /opt/netbox/upgrade.sh
```
Restart Services (if necessary):

After running the upgrade script, you may need to restart services. Refer to the documentation for more details on restarting services:
```
sudo systemctl restart netbox netbox-rq
```

These steps will ensure the successful installation and activation of the plugin within your NetBox environment.

If you would like to install our default transform maps see the following documentation.