Install the Latest Code

As with the initial installation, you can upgrade NetBox by either downloading the latest release package or by cloning the master branch of the git repository.

Option A: Download a Release

Download the latest stable release from GitHub as a tarball or ZIP archive. Extract it to your desired path. In this example, we'll use /opt/netbox.

Download and extract the latest version:

# wget https://github.com/digitalocean/netbox/archive/vX.Y.Z.tar.gz
# tar -xzf vX.Y.Z.tar.gz -C /opt
# cd /opt/
# ln -sfn netbox-X.Y.Z/ netbox

Copy the 'configuration.py' you created when first installing to the new version:

# cp netbox-X.Y.Z/netbox/netbox/configuration.py netbox/netbox/netbox/configuration.py

Be sure to replicate your uploaded media as well. (The exact action necessary will depend on where you choose to store your media, but in general moving or copying the media directory will suffice.)

# cp -pr netbox-X.Y.Z/netbox/media/ netbox/netbox/

Also make sure to copy over any reports that you've made. Note that if you made them in a separate directory (/opt/netbox-reports for example), then you will not need to copy them - the config file that you copied earlier will point to the correct location.

# cp -r /opt/netbox-X.Y.X/netbox/reports /opt/netbox/netbox/reports/

If you followed the original installation guide to set up gunicorn, be sure to copy its configuration as well:

# cp netbox-X.Y.Z/gunicorn_config.py netbox/gunicorn_config.py

Copy the LDAP configuration if using LDAP:

# cp netbox-X.Y.Z/netbox/netbox/ldap_config.py netbox/netbox/netbox/ldap_config.py

Option B: Clone the Git Repository (latest master release)

This guide assumes that NetBox is installed at /opt/netbox. Pull down the most recent iteration of the master branch:

# cd /opt/netbox
# git checkout master
# git pull origin master
# git status

Run the Upgrade Script

Once the new code is in place, run the upgrade script (which may need to be run as root depending on how your environment is configured).

# ./upgrade.sh

Warning

The upgrade script will prefer Python3 and pip3 if both executables are available. To force it to use Python2 and pip, use the -2 argument as below. Note that Python 2 will no longer be supported in NetBox v2.5.

# ./upgrade.sh -2

This script:

  • Installs or upgrades any new required Python packages
  • Applies any database migrations that were included in the release
  • Collects all static files to be served by the HTTP service

Note

It's possible that the upgrade script will display a notice warning of unreflected database migrations:

Your models have changes that are not yet reflected in a migration, and so won't be applied.
Run 'manage.py makemigrations' to make new migrations, and then re-run 'manage.py migrate' to apply them.

This may occur due to semantic differences in environment, and can be safely ignored. Never attempt to create new migrations unless you are intentionally modifying the database schema.

Restart the WSGI Service

Finally, restart the WSGI service to run the new code. If you followed this guide for the initial installation, this is done using supervisorctl:

# sudo supervisorctl restart netbox

If using webhooks, also restart the Redis worker:

# sudo supervisorctl restart netbox-rqworker