mirror/netbox-docker
1
0
Fork 1
mirror of https://github.com/netbox-community/netbox-docker.git synced 2026-02-05 05:24:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added note to Section 2 to explain that netbox-secrets is an example. Added Note in DockerFile-Plugins regarding creation of static folders. Added note to step 3 to explain that netbox-secrets. Added Dependencies section to Troubleshooting Section

abatchx 2026-01-08 20:47:10 +00:00
parent 1af8b97c2f
commit c0771d29a9
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Using-Netbox-Plugins.md

@ -10,7 +10,9 @@ Lets start with a fresh install of netbox-docker.
## Step 2 - Modify New Files
### `plugin_requirements.txt`
This file contains a list of the NetBox Plugins (as **PyPi Python Packages**) to be installed during the building of the Docker image.
This file contains a list of the NetBox Plugins (as **PyPi Python Packages**) to be installed during the building of the Docker image.
For example if you wish to add the `netbox-secrets` plugin:
Add _netbox-secrets_ If you are using Netbox > 3.5:
```
@ -42,6 +44,8 @@ RUN DEBUG="true" SECRET_KEY="dummydummydummydummydummydummydummydummydummydummy"
> NOTE: If your plugins call for any static files, remember to add another `COPY configuration/custom-plugins.py /etc/netbox/config/custom-plugins.py` line to config.
> NOTE: if your plugins call for any static folders, remember to add a `RUN mkdir` in here e.g. `RUN mkdir -p /opt/netbox/netbox/static/netbox_topology_views/img` - See your plugins Wiki for specific details
### `docker-compose.override.yml`
As its name implies, this file can contain configuration overrides for `docker-compose.yml`
@ -62,7 +66,7 @@ services:
```
## Step 3 - Enable plugins in the configuration
To get plugins to work within NetBox you need to add some configuration to `configuration/plugins.py`.
To get plugins to work within NetBox you need to add some configuration to `configuration/plugins.py`. For example, when adding the `netbox-secrets` plugin:
For Netbox > 3.5:
@ -107,4 +111,9 @@ Your new custom NetBox Docker image has been created and is now running, with th
### Plugin does not load
The error is something like `django.core.exceptions.ImproperlyConfigured: Unable to import plugin nextbox-plugin: Module not found`.
Note that the plugin name for pip can be different from the name used to load the plugin. I.e. `netbox-plugin` for pip and `netbox_plugin` (note the underscore) for the config file.
Note that the plugin name for pip can be different from the name used to load the plugin. I.e. `netbox-plugin` for pip and `netbox_plugin` (note the underscore) for the config file.
### Dependencies
Your environment will require the following items installed:
`UV - https://docs.astral.sh/uv/`
`PIP - https://pypi.org/project/pip/`