Installing The Backend With pip

This is the simplest non-Docker path for the proxbox-api backend.

Install

mkdir -p /opt/proxbox-api
cd /opt/proxbox-api
python3 -m venv venv
source venv/bin/activate
pip install proxbox-api==0.0.2.post3

Start Manually

/opt/proxbox-api/venv/bin/uvicorn proxbox_api.main:app --host 0.0.0.0 --port 8800 --app-dir /opt/proxbox-api

Once started, the backend should answer on http://<host>:8800.

Run With systemd

This repository includes a sample unit file at contrib/proxbox.service.

sudo cp -v /opt/netbox/netbox/netbox-proxbox/contrib/proxbox.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable --now proxbox
sudo systemctl status proxbox

Next Step

After the backend is running, create the ProxBox API (FastAPI) endpoint object in NetBox and test a sync from the Proxbox home page.