From 9b606643eabc39e1e5f02d7265fe142abd4c1fcd Mon Sep 17 00:00:00 2001 From: mattieserver Date: Tue, 19 May 2020 19:50:56 +0200 Subject: [PATCH 1/4] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4d099cb..9059611 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # Netbox Topology Views Plugin Create topology views/maps from your devices in netbox. -Support to filter on name, site and device role. +The connections are based on the cables you created in netbox. +Support to filter on name, site, tag and device role. ## Preview @@ -62,4 +63,4 @@ Run `pip install netbox-topology-views --upgrade` in your venv. Run `python3 manage.py collectstatic --no-input` -Clear you browser cache. +Clear your browser cache. From 2e6dd7de23563068b019ea3498d4aa72d39ffb2f Mon Sep 17 00:00:00 2001 From: ryanmerolle Date: Sat, 23 May 2020 12:04:19 -0400 Subject: [PATCH 2/4] Update README to include local_requirements setup --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9059611..d4f7165 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,21 @@ Support to filter on name, site, tag and device role. ## Install +The plugin is available as a Python package and can be installed with pip. + Run `pip install netbox-topology-views` in your virtual env. -Add 'netbox_topology_views' to the PLUGINS array in your django configuration file. +To ensure NetBox Topology Views plugin is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the NetBox root directory (alongside `requirements.txt`) and list the `netbox-topology-views` package: + +```no-highlight +# echo netbox-topology-views >> local_requirements.txt +``` + +Once installed, the plugin needs to be enabled in your `configuration.py` + +```python +# In your configuration.py +PLUGINS = ["netbox-topology-views"] Then run `python3 manage.py collectstatic --no-input` From cd239ac6ae6857077c057feed6c99d64732e9d91 Mon Sep 17 00:00:00 2001 From: mattieserver Date: Sat, 23 May 2020 18:19:13 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d4f7165..20414ff 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ Once installed, the plugin needs to be enabled in your `configuration.py` ```python # In your configuration.py PLUGINS = ["netbox-topology-views"] +``` Then run `python3 manage.py collectstatic --no-input` From 41155843061c1157ddc4d0f3342a91fd0d56219e Mon Sep 17 00:00:00 2001 From: mattieserver Date: Sat, 23 May 2020 18:20:04 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 20414ff..fbb7381 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Once installed, the plugin needs to be enabled in your `configuration.py` ```python # In your configuration.py -PLUGINS = ["netbox-topology-views"] +PLUGINS = ["netbox_topology_views"] ``` Then run `python3 manage.py collectstatic --no-input`