From c6a6893c1014f42249ba5fd9089e31193d8dc9a5 Mon Sep 17 00:00:00 2001 From: mattieserver Date: Fri, 24 Apr 2020 12:45:49 +0200 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 3546920..bc42cfd 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,19 @@ Then run `python3 manage.py collectstatic --no-input` 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. +## Configure + +| Setting | Default value | Description | +| ------------- |-------------| -----| +| device_img | 'access-switch,core-switch,firewall,router,distribution-switch,backup,storage,wan-network,wireless-ap,server,internal-switch,isp-cpe-material,non-racked-devices,power-units' | The slug of the device roles that you have a image for. | +| preselected_device_roles | 'Firewall,Router,Distribution Switch,Core Switch,Internal Switch,Access Switch,Server,Storage,Backup,Wireless AP' | The full name of the device roles you want to pre select in the global view. | + +### Custom Images + +You upload you own custom images to the netbox static dir (`static/netbox_topology_views/img/`). +These images need to be named after de device role slug and have the .png format/extension. +If you add your own image you also need to add the slug to the `device_img` setting. + ## Use Go to the plugins tab in the navbar and click topology or go to NETBOX_URL/plugins/topology-views/ view your topologies