Updated Using Netbox Plugins (markdown)

Christian Mäder 2021-06-21 10:15:10 +02:00
parent d1ec79afbc
commit 5d65aedef1

@ -1,4 +1,4 @@
To utilise plugins that have been created by users within the [Netbox Community](https://github.com/netbox-community/netbox/wiki/Plugins) a custom image must be used.
To utilise plugins that have been created by users within the [NetBox Community](https://github.com/netbox-community/netbox/wiki/Plugins) a custom image must be used.
Lets start with a fresh install of netbox-docker.
@ -13,9 +13,9 @@ ntc-netbox-plugin-onboarding
```
> NOTE: These must be on PyPi to work.
## Netbox Configuration
## NetBox Configuration
To get plugins to work within Netbox you need to add some configuration to `configuration.py`.
To get plugins to work within NetBox you need to add some configuration to `configuration.py`.
```
PLUGINS = ["netbox_onboarding"]
@ -25,7 +25,7 @@ PLUGINS = ["netbox_onboarding"]
# }
# }
```
> NOTE: This can differ for every plugin. To learn more about this see the [Netbox documentation](https://netbox.readthedocs.io/en/stable/plugins/#enable-the-plugin).
> NOTE: This can differ for every plugin. To learn more about this see the [NetBox documentation](https://netbox.readthedocs.io/en/stable/plugins/#enable-the-plugin).
## Custom Docker File
@ -58,7 +58,7 @@ services:
netbox-worker:
image: netbox:latest-plugins
```
This configuration will change the ports `Netbox` will use. It will also select the build file created in previous steps and tell the `netbox-worker` service to now use the new image (netbox:latest-plugins) that has been created.
This configuration will change the ports `netbox` will use. It will also select the build file created in previous steps and tell the `netbox-worker` service to now use the new image (`netbox:latest-plugins`) that has been created.
## Build and Deploy
To build and deploy this in docker two commands are required.