estel/netbox
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

Closes #4322: Introduce and document local_requirements.txt support for installation/upgrade of optional dependencies

Browse Source
This commit is contained in:
Jeremy Stretch
2020-03-09 14:22:27 -04:00
parent 0eaec6bd83
commit ab2ea5697f
4 changed files with 41 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/installation/3-netbox.md
View File

@@ -103,6 +103,12 @@ NetBox supports integration with the [NAPALM automation](https://napalm-automati
(venv) # pip3 install napalm
```
To ensure NAPALM is automatically re-installed during future upgrades, create a file named `local_requirements.txt` in the NetBox root directory (alongside `requirements.txt`) and list the `napalm` package:
```no-highlight
# echo napalm >> local_requirements.txt
```
### Remote File Storage (Optional)
By default, NetBox will use the local filesystem to storage uploaded files. To use a remote filesystem, install the [`django-storages`](https://django-storages.readthedocs.io/en/stable/) library and configure your [desired backend](../../configuration/optional-settings/#storage_backend) in `configuration.py`.
@@ -111,6 +117,12 @@ By default, NetBox will use the local filesystem to storage uploaded files. To u
(venv) # pip3 install django-storages
```
Don't forget to add the `django-storages` package to `local_requirements.txt` to ensure it gets re-installed during future upgrades:
```no-highlight
# echo django-storages >> local_requirements.txt
```
## Configuration
Move into the NetBox configuration directory and make a copy of `configuration.example.py` named `configuration.py`.