Skip to content

Installing the Plugin Using PyPI

Read This First

The current repository code targets NetBox 4.5.x, but the repository is ahead of the latest published PyPI build of netbox-proxbox.

If you need the code documented in this repository, use Installing the Plugin Using Git instead.

Use the PyPI package path only if you intentionally want the currently published package and have verified its compatibility separately.

Generic Package Install Flow

source /opt/netbox/venv/bin/activate
pip install netbox-proxbox

cd /opt/netbox/netbox
python3 manage.py migrate netbox_proxbox
python3 manage.py collectstatic --no-input
sudo systemctl restart netbox

Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:

PLUGINS = ["netbox_proxbox"]

Recommendation

For NetBox 4.5.x, prefer the Git/source installation path documented in this repository.

Next Step

The plugin still requires the separate backend service. Continue with Backend Setup.