From bc0b77f96286c37927e0c7c5151b97ee61566a0b Mon Sep 17 00:00:00 2001 From: Frank Niessink Date: Mon, 10 Jan 2022 14:39:59 +0100 Subject: [PATCH 1/3] More detailed instructions. --- README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2200d1f..122ea03 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,25 @@ ### Installation Guide -Depending on running in Docker (see the netbox-docker repository) add netbox_slm to the plugin_requirements.txt (requires a valid pypi version) +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`. -``` -netbox-slm==0.9 +Next, follow the [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: + +- added `netbox_slm` to the `PLUGINS` list in `configuration/configuration.py`, +- created a `plugin_requirements.txt` with `netbox-slm==0.9` as contents, and +- created a `Dockerfile-SLM` with contents: + +```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 + +COPY ./plugin_requirements.txt / +RUN /opt/netbox/venv/bin/pip install --no-warn-script-location -r /plugin_requirements.txt ``` -Change the configuration.py to include the plugin: - -``` -PLUGINS = [ - 'netbox_slm', -] -``` +Build the image: `docker compose build --no-cache` +Run Netbox with the SLM plugin: `docker compose up -d` ### Releasing Guide From e926f01141691c0a2d737ad835882bc6a331df26 Mon Sep 17 00:00:00 2001 From: Frank Niessink Date: Mon, 10 Jan 2022 14:56:05 +0100 Subject: [PATCH 2/3] Fix instructions. --- README.md | 33 +++++++++++++++++++++++++-------- 1 file changed, 25 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 122ea03..35ea1fb 100644 --- a/README.md +++ b/README.md @@ -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`. -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: - -- added `netbox_slm` to the `PLUGINS` list in `configuration/configuration.py`, -- created a `plugin_requirements.txt` with `netbox-slm==0.9` as contents, and -- created a `Dockerfile-SLM` with contents: +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. +3. Create a `Dockerfile-SLM` with contents: ```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 @@ -23,8 +21,27 @@ COPY ./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` -Run Netbox with the SLM plugin: `docker compose up -d` +4. Create a `docker-compose.override.yml` with contents: + +```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 From 3ed18c576716fe82923ea7e3e6e842bd27e3a75b Mon Sep 17 00:00:00 2001 From: Frank Niessink Date: Mon, 10 Jan 2022 14:57:58 +0100 Subject: [PATCH 3/3] Improve wording. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 35ea1fb..05e1fad 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ 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 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: +Next, follow these instructions (based on the generic [Netbox plugin instructions](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins)) to install the Netbox SLM plugin: 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.