MrBlake/mrb-netbox-topology-views
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README to include local_requirements setup

Browse Source
This commit is contained in:
ryanmerolle
2020-05-23 12:04:19 -04:00
parent 26139cbb1c
commit 2e6dd7de23
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -1
View File
@@ -10,9 +10,21 @@ Support to filter on name, site, tag and device role.
## Install ## 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. 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` Then run `python3 manage.py collectstatic --no-input`