Fix instructions.
This commit is contained in:
@@ -8,13 +8,11 @@
|
|||||||
|
|
||||||
When using the Docker version of Netbox, first follow the [netbox-docker quickstart](https://github.com/netbox-community/netbox-docker#quickstart) instructions to clone the netbox-docker repo and set up the `docker-compose.override.yml`.
|
When using the Docker version of Netbox, first follow the [netbox-docker quickstart](https://github.com/netbox-community/netbox-docker#quickstart) instructions to clone the netbox-docker repo and set up the `docker-compose.override.yml`.
|
||||||
|
|
||||||
Next, follow the [plugin instructions](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins) to install the Netbox SLM plugin.
|
Next, follow the following instructions (based on these generic [plugin instructions](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins)) to install the Netbox SLM plugin:
|
||||||
|
|
||||||
After following these instructions, you should have:
|
1. Add `netbox_slm` to the `PLUGINS` list in `configuration/configuration.py`.
|
||||||
|
2. Create a `plugin_requirements.txt` with `netbox-slm==0.9` as contents.
|
||||||
- added `netbox_slm` to the `PLUGINS` list in `configuration/configuration.py`,
|
3. Create a `Dockerfile-SLM` with contents:
|
||||||
- created a `plugin_requirements.txt` with `netbox-slm==0.9` as contents, and
|
|
||||||
- created a `Dockerfile-SLM` with contents:
|
|
||||||
|
|
||||||
```Dockerfile
|
```Dockerfile
|
||||||
FROM netboxcommunity/netbox:v3.0.9 # The Netbox SLM plugin currently only works with v3.0.9 of Netbox due to backwards incompatible changes in newer version of Netbox
|
FROM netboxcommunity/netbox:v3.0.9 # The Netbox SLM plugin currently only works with v3.0.9 of Netbox due to backwards incompatible changes in newer version of Netbox
|
||||||
@@ -23,8 +21,27 @@ COPY ./plugin_requirements.txt /
|
|||||||
RUN /opt/netbox/venv/bin/pip install --no-warn-script-location -r /plugin_requirements.txt
|
RUN /opt/netbox/venv/bin/pip install --no-warn-script-location -r /plugin_requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
Build the image: `docker compose build --no-cache`
|
4. Create a `docker-compose.override.yml` with contents:
|
||||||
Run Netbox with the SLM plugin: `docker compose up -d`
|
|
||||||
|
```yaml
|
||||||
|
version: '3.4'
|
||||||
|
services:
|
||||||
|
netbox:
|
||||||
|
ports:
|
||||||
|
- 8000:8080
|
||||||
|
build:
|
||||||
|
context: .
|
||||||
|
dockerfile: Dockerfile-SLM
|
||||||
|
image: netbox:slm
|
||||||
|
netbox-worker:
|
||||||
|
image: netbox:slm
|
||||||
|
netbox-housekeeping:
|
||||||
|
image: netbox:slm
|
||||||
|
```
|
||||||
|
|
||||||
|
Now, build the image: `docker compose build --no-cache`
|
||||||
|
|
||||||
|
And finally, run Netbox with the SLM plugin: `docker compose up`
|
||||||
|
|
||||||
### Releasing Guide
|
### Releasing Guide
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user