From b2430d17235e1df9b5ae98ffe5244879105ca63e Mon Sep 17 00:00:00 2001 From: mattieserver Date: Fri, 17 Apr 2020 11:13:10 +0200 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 496efbe..3546920 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,25 @@ -# netbox-topology-views +# Netbox Topology Views Plugin -## preview +Create topology views/maps from your devices in netbox. +Support to filter on name, site and device role. + +## Preview ![preview image](doc/img/preview.png?raw=true "preview") -## install +## Install -Add 'netbox_topology_views' to the PLUGINS array in your django configuration file. -Then run python3 manage.py collectstatic --no-input +Run `pip install netbox-topology-views` in your virtual env. + +Add 'netbox_topology_views' to the PLUGINS array in your django configuration file. + +Then run `python3 manage.py collectstatic --no-input` + +### Custom field: coordinates There is also support for custom fiels. If you create a custom field "coordinates" for "dcim > device" with type "text" and name "coordinates" you will see the same layout every time. -## use +## Use -go to /plugins/topology-views/ view your topologies \ No newline at end of file +Go to the plugins tab in the navbar and click topology or go to NETBOX_URL/plugins/topology-views/ view your topologies