NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-16 04:02:52 -06:00
Code Issues Actions 7 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
Show Stats 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 (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) ### 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`. 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 (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 ## Configuration
Move into the NetBox configuration directory and make a copy of `configuration.example.py` named `configuration.py`. Move into the NetBox configuration directory and make a copy of `configuration.example.py` named `configuration.py`.

18
docs/installation/5-ldap.md
View File

@ -4,24 +4,34 @@ This guide explains how to implement LDAP authentication using an external serve
## Install Requirements ## Install Requirements
### Install openldap-devel ### Install System Packages
On Ubuntu: On Ubuntu:
```no-highlight ```no-highlight
sudo apt-get install -y libldap2-dev libsasl2-dev libssl-dev # apt-get install -y libldap2-dev libsasl2-dev libssl-dev
``` ```
On CentOS: On CentOS:
```no-highlight ```no-highlight
sudo yum install -y openldap-devel # yum install -y openldap-devel
``` ```
### Install django-auth-ldap ### Install django-auth-ldap
Activate the Python virtual environment and install the `django-auth-ldap` package using pip:
```no-highlight ```no-highlight
pip3 install django-auth-ldap # cd /opt/netbox/
# source venv/bin/activate
(venv) # pip3 install django-auth-ldap
```
Once installed, add the package to `local_requirements.txt` to ensure it is re-installed during future rebuilds of the virtual environment:
```no-highlight
(venv) # echo django-auth-ldap >> local_requirements.txt
``` ```
## Configuration ## Configuration

5
docs/installation/upgrading.md
View File

@ -64,7 +64,7 @@ This guide assumes that NetBox is installed at `/opt/netbox`. Pull down the most
## Run the Upgrade Script ## Run the Upgrade Script
Once the new code is in place, run the upgrade script: Once the new code is in place, verify that any optional Python packages required by your deployment (e.g. `napalm` or `django-auth-ldap`) are listed in `local_requirements.txt`. Then, run the upgrade script:
```no-highlight ```no-highlight
# ./upgrade.sh # ./upgrade.sh
@ -73,7 +73,8 @@ Once the new code is in place, run the upgrade script:
This script: This script:
* Destroys and rebuilds the Python virtual environment * Destroys and rebuilds the Python virtual environment
* Installs all required Python packages * Installs all required Python packages (listed in `requirements.txt`)
* Installs any additional packages from `local_requirements.txt`
* Applies any database migrations that were included in the release * Applies any database migrations that were included in the release
* Collects all static files to be served by the HTTP service * Collects all static files to be served by the HTTP service
* Deletes stale content types from the database * Deletes stale content types from the database

14
upgrade.sh
View File

@ -34,11 +34,21 @@ COMMAND="pip3 install wheel"
echo "Installing Python system packages ($COMMAND)..." echo "Installing Python system packages ($COMMAND)..."
eval $COMMAND || exit 1 eval $COMMAND || exit 1
# Install Python packages # Install required Python packages
COMMAND="pip3 install -r requirements.txt" COMMAND="pip3 install -r requirements.txt"
echo "Installing dependencies ($COMMAND)..." echo "Installing core dependencies ($COMMAND)..."
eval $COMMAND || exit 1 eval $COMMAND || exit 1
# Install optional packages (if any)
if [ -f "local_requirements.txt" ]
then
COMMAND="pip3 install -r local_requirements.txt"
echo "Installing local dependencies ($COMMAND)..."
eval $COMMAND || exit 1
else
echo "Skipping local dependencies (local_requirements.txt not found)"
fi
# Apply any database migrations # Apply any database migrations
COMMAND="python3 netbox/manage.py migrate" COMMAND="python3 netbox/manage.py migrate"
echo "Applying database migrations ($COMMAND)..." echo "Applying database migrations ($COMMAND)..."