{"id":2898,"date":"2025-07-27T22:02:32","date_gmt":"2023-01-05T22:57:06","guid":{"rendered":""},"modified":"2025-02-02T00:46:19","modified_gmt":"2025-02-01T23:46:19","slug":"how-to-install-netbox-network-documentation-and-management-tool-on-ubuntu-22-04","status":"publish","type":"post","link":"https:\/\/netcloud24.com\/knowledgebase\/how-to-install-netbox-network-documentation-and-management-tool-on-ubuntu-22-04\/","title":{"rendered":"Linux VPS & VPS Windows Setup Guide | NetCloud24 NetBox Network Documentation and Management Tool on Ubuntu 22.04"},"content":{"rendered":"

\u00a0<\/p>\n<\/p>\n

\n

\u00a0<\/h1>\n<\/header>\n
\n

NetBox is an open-source network documentation and management tool that allows users to manage IP addresses, devices, racks, and more. It is widely used for managing data center infrastructure and network automation. In this guide, we will walk through the steps to install NetBox on Ubuntu 22.04. Whether you\u2019re setting it up on a local server or deploying it on a , this guide will help you get NetBox up and running efficiently.<\/p>\n

\n

Step 1: Update Your System<\/h2>\n

Before installing any new software, it\u2019s important to update your system. Run the following commands to ensure your Ubuntu 22.04 system is up to date:<\/p>\n

sudo apt update && sudo apt upgrade<\/code><\/pre>\n
This step ensures that your system has the latest software updates and security patches. Keeping your system updated is important whether you\u2019re hosting locally or on a UK Windows VPS<\/a>.<\/p>\n<\/section>\n
\n
Step 2: Install Required Dependencies<\/h2>\n
NetBox requires several dependencies, including PostgreSQL, Redis, and Python packages. To install these dependencies, run the following command:<\/p>\n
\r\nsudo apt install -y python3 python3-pip python3-venv libpq-dev postgresql postgresql-contrib redis-server nginx\r\n            <\/code><\/pre>\n
These dependencies are necessary to run NetBox, whether you\u2019re deploying it locally or on a Windows VPSVirtual Private Server hosting<\/a> environment.<\/p>\n<\/section>\n
\n
Step 3: Configure PostgreSQL<\/h2>\n
After installing PostgreSQL, you need to create a database and user for NetBox. Log in to the PostgreSQL shell with the following command:<\/p>\n
sudo -u postgres psql<\/code><\/pre>\n
Create a new database and user for NetBox:<\/p>\n
\r\nCREATE DATABASE netbox;\r\nCREATE USER netbox WITH PASSWORD 'yourpassword';\r\nALTER ROLE netbox SET client_encoding TO 'utf8';\r\nALTER ROLE netbox SET default_transaction_isolation TO 'read committed';\r\nALTER ROLE netbox SET timezone TO 'UTC';\r\nGRANT ALL PRIVILEGES ON DATABASE netbox TO netbox;\r\n\\q\r\n            <\/code><\/pre>\n
This creates a database and user for NetBox and assigns the necessary privileges. This setup will work whether you’re using a local server or deploying on a Windows VPS hosting UK<\/a>.<\/p>\n<\/section>\n
\n
Step 4: Download and Set Up NetBox<\/h2>\n
Now, download the latest stable version of NetBox. Navigate to the \/opt<\/code> directory:<\/p>\n
cd \/opt<\/code><\/pre>\n
Clone the NetBox repository from GitHub:<\/p>\n
sudo git clone -b master https:\/\/github.com\/netbox-community\/netbox.git<\/code><\/pre>\n
Once the repository is cloned, navigate into the NetBox directory:<\/p>\n
cd netbox<\/code><\/pre>\n
Create a Python virtual environment for NetBox and activate it:<\/p>\n
\r\nsudo python3 -m venv \/opt\/netbox\/venv\r\nsource \/opt\/netbox\/venv\/bin\/activate\r\n            <\/code><\/pre>\n
Install the required Python dependencies:<\/p>\n
pip install -r requirements.txt<\/code><\/pre>\n<\/section>\n
\n
Step 5: Configure NetBox<\/h2>\n
Copy the example configuration file and open it for editing:<\/p>\n
\r\nsudo cp \/opt\/netbox\/netbox\/netbox\/configuration_example.py \/opt\/netbox\/netbox\/netbox\/configuration.py\r\nsudo nano \/opt\/netbox\/netbox\/netbox\/configuration.py\r\n            <\/code><\/pre>\n
Update the ALLOWED_HOSTS<\/code> setting with your server\u2019s IP address or domain name:<\/p>\n
ALLOWED_HOSTS = ['your-server-ip', 'your-domain.com']<\/code><\/pre>\n
Next, configure the database settings with the PostgreSQL credentials you created earlier:<\/p>\n
\r\nDATABASE = {\r\n    'NAME': 'netbox',\r\n    'USER': 'netbox',\r\n    'PASSWORD': 'yourpassword',\r\n    'HOST': 'localhost',\r\n    'PORT': '',\r\n}\r\n            <\/code><\/pre>\n
Save and exit the file. This configuration works for both local and cloud-based environments such as Microsoft SQL VPS Windows<\/a>.<\/p>\n<\/section>\n
\n
Step 6: Initialize NetBox<\/h2>\n
Run the following command to apply database migrations and create a superuser for NetBox:<\/p>\n
\r\ncd \/opt\/netbox\/netbox\/\r\npython3 manage.py migrate\r\npython3 manage.py createsuperuser\r\npython3 manage.py collectstatic\r\n            <\/code><\/pre>\n
During the createsuperuser<\/code> process, you will be prompted to enter a username, email, and password for the superuser account.<\/p>\n<\/section>\n
\n
Step 7: Set Up Gunicorn and Nginx<\/h2>\n
To run NetBox in production, you\u2019ll need to configure Gunicorn and Nginx. Create a systemd service file for Gunicorn:<\/p>\n
sudo nano \/etc\/systemd\/system\/netbox.service<\/code><\/pre>\n
Add the following configuration:<\/p>\n
\r\n[Unit]\r\nDescription=NetBox WSGI Service\r\nAfter=network.target\r\n\r\n[Service]\r\nType=simple\r\nUser=root\r\nGroup=root\r\nWorkingDirectory=\/opt\/netbox\/netbox\/\r\nExecStart=\/opt\/netbox\/venv\/bin\/gunicorn --workers 3 --bind 0.0.0.0:8001 netbox.wsgi\r\n\r\n[Install]\r\nWantedBy=multi-user.target\r\n            <\/code><\/pre>\n
Save the file, reload systemd, and start the NetBox service:<\/p>\n
\r\nsudo systemctl daemon-reload\r\nsudo systemctl start netbox\r\nsudo systemctl enable netbox\r\n            <\/code><\/pre>\n
Now configure Nginx to act as a reverse proxy. Create a configuration file for NetBox:<\/p>\n
sudo nano \/etc\/nginx\/sites-available\/netbox<\/code><\/pre>\n
Add the following configuration:<\/p>\n
\r\nserver {\r\n    listen 80;\r\n    server_name your-server-ip;\r\n\r\n    location \/ {\r\n        proxy_pass http:\/\/127.0.0.1:8001;\r\n        proxy_set_header Host $host;\r\n        proxy_set_header X-Real-IP $remote_addr;\r\n        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\r\n        proxy_set_header X-Forwarded-Proto $scheme;\r\n    }\r\n\r\n    location \/static\/ {\r\n        alias \/opt\/netbox\/netbox\/static\/;\r\n    }\r\n}\r\n            <\/code><\/pre>\n
Save the file, enable the site, and restart Nginx:<\/p>\n
\r\nsudo ln -s \/etc\/nginx\/sites-available\/netbox \/etc\/nginx\/sites-enabled\/\r\nsudo systemctl restart nginx\r\n            <\/code><\/pre>\n
This setup is ideal for both local servers and hosting on a Windows VPS hosting UK<\/a> platform.<\/p>\n<\/section>\n
\n
Step 8: Access NetBox<\/h2>\n
NetBox should now be accessible via your server\u2019s IP address or domain name. Open a browser and navigate to http:\/\/your-server-ip\/<\/code> to access the NetBox login page. Log in using the superuser credentials you created earlier.<\/p>\n<\/section>\n