This tutorial will guide you through the steps to successfully install NetBox on Ubuntu Server latest. NetBox is open-source, IP address management (IPAM) and data center infrastructure management (DCIM) tool. For this installation, we will be using the package manager "pip" and "Python3".
Before proceeding with the installation process, it's always a good idea to update your system to the latest package version:
sudo apt update
sudo apt upgrade
Install the required packages to run NetBox on Ubuntu:
sudo apt install git python3-pip python3-dev python3-venv build-essential libxml2-dev libxslt1-dev zlib1g-dev redis
It's not recommended to run NetBox as the root user, so we will need to create a new user to run the application. Replace 'netboxuser' with the desired username:
sudo adduser netboxuser
Clone the NetBox repository from Github to the home directory of the new user we just created:
sudo su - netboxuser
cd ~
git clone -b master https://github.com/digitalocean/netbox.git
To run NetBox, we will need to create a virtual environment. Run the command below to create a virtual environment:
cd ~/netbox
python3 -m venv netbox_venv
Activate the virtual environment:
source ~/netbox/netbox_venv/bin/activate
Now, install the required Python libraries using "pip":
pip3 install -r requirements.txt
Copy the configuration.example.py file to configuration.py by running the following command:
cp ~/netbox/netbox/netbox/configuration.example.py ~/netbox/netbox/netbox/configuration.py
Do note that you should configure the file according to your server's settings.
nano ~/netbox/netbox/netbox/configuration.py
To use NetBox, you will require a superuser, which will also allow you to log in to the admin interface.
# Run the following commands in the virtual environment created in Step 5.
python3 ~/netbox/netbox/manage.py createsuperuser
Follow along with the prompts/input that the application requires.
After creating a new superuser, refresh the database schema by running:
python3 ~/netbox/netbox/manage.py migrate
Activate the virtual environment once again:
cd ~/netbox
source netbox_venv/bin/activate
Start up NetBox using Gunicorn. Default port for Gunicorn is 8000:
gunicorn netbox.wsgi:application --bind=0.0.0.0:8000 --workers=4 --timeout 120 --log-level=info --log-file=-
Do note that you should also start the Redis server by switching to the netboxuser (use sudo su - netboxuser if necessary) and running:
redis-server &
Open up your browser, and in the address bar, type in your server's IP address followed by ':8000' at the end. Example - http://12.34.567.890:8000/
Success! You should now be able to access Netbox on your Ubuntu Server.
In conclusion, we've successfully installed NetBox on Ubuntu Server. We can now use the tool to manage and organize our IP addresses and infrastructure management.
This project is licensed under the MIT License.
If you want to self-host in an easy, hands free way, need an external IP address, or simply want your data in your own hands, give IPv6.rs a try!
Alternatively, for the best virtual desktop, try Shells!
