If you’re interested in deploying Netbox on other systems, checkout:<\/p>\n\n\n\n
- \n
- How to Install NetBox on CentOS 7 with Apache and Supervisord<\/a><\/li>\n<\/ul>\n\n\n\n
Here are the steps for installing Install NetBox on Debian Linux.<\/p>\n\n\n\n
Step 1: Install required dependencies<\/h2>\n\n\n\n
Start by installing all dependency applications required to run NetBox:<\/p>\n\n\n\n
sudo apt update\nsudo apt -y install -y git gcc nginx redis supervisor python3 python3-dev python3-venv python3-pip python3-setuptools build-essential libxml2-dev libxslt1-dev libffi-dev graphviz libpq-dev libssl-dev zlib1g-dev vim<\/code><\/pre>\n\n\n\nStep 2: Install and configure PostgreSQL<\/h2>\n\n\n\n
NetBox uses PostgreSQL database server to store its data. So install PostgreSQL server on Debian:<\/p>\n\n\n\n
sudo apt update\ncurl -fsSL https:\/\/www.postgresql.org\/media\/keys\/ACCC4CF8.asc|sudo gpg --dearmor -o \/etc\/apt\/trusted.gpg.d\/postgresql.gpg\nRELEASE=$(lsb_release -cs)\nsudo sh -c 'echo \"deb http:\/\/apt.postgresql.org\/pub\/repos\/apt $(lsb_release -cs)-pgdg main\" > \/etc\/apt\/sources.list.d\/pgdg.list'\nsudo apt update\nsudo apt -y install postgresql-15<\/code><\/pre>\n\n\n\nThe Create a database and user for NetBox.<\/p>\n\n\n\n
$ sudo -u postgres psql<\/mark>\nCREATE DATABASE netbox<\/mark>;\nCREATE USER netbox WITH PASSWORD 'StrongPassword<\/mark>';\nALTER DATABASE netbox OWNER TO netbox;\n\\connect netbox;\nGRANT CREATE ON SCHEMA public TO netbox;\n\\q<\/code><\/pre>\n\n\n\nConfirm that you can login to database as
netbox<\/code> user.<\/p>\n\n\n\n$ psql -U netbox -h localhost -W<\/mark>\nPassword: \npsql (15.4 (Debian 15.4-2.pgdg120+1))\nSSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, compression: off)\nType \"help\" for help.\nnetbox=> \\q<\/mark><\/code><\/pre>\n\n\n\nStep 3: Install and configure Netbox<\/h2>\n\n\n\n
Switch to root user.<\/p>\n\n\n\n
sudo su -<\/code><\/pre>\n\n\n\nChange to
\/opt\/<\/code> directory and clone project code.<\/p>\n\n\n\ncd \/opt\/\ngit clone -b master https:\/\/github.com\/digitalocean\/netbox.git<\/code><\/pre>\n\n\n\nCreate a configuration file from provided example file.<\/p>\n\n\n\n
cd netbox\/netbox\/netbox\/\ncp configuration_example.py configuration.py<\/code><\/pre>\n\n\n\nEdit the configuration file and set allowed host and database login details:<\/p>\n\n\n\n
# vim configuration.py<\/mark>\n....\nALLOWED_HOSTS = ['*<\/mark>']\n....\nDATABASE = {\n 'NAME': 'netbox<\/mark>', # Database name\n 'USER': 'netbox<\/mark>', # PostgreSQL username\n 'PASSWORD': 'StrongPassword<\/mark>', # PostgreSQL password\n 'HOST': 'localhost', # Database server\n 'PORT': '', # Database port (leave blank for default)\n 'CONN_MAX_AGE': 300, # Max database connection age\n }<\/code><\/pre>\n\n\n\nGenerate Django SECRET Key:<\/p>\n\n\n\n
cd ..\/\n.\/generate_secret_key.py<\/code><\/pre>\n\n\n\nThen set the key on the file
\/opt\/netbox\/netbox\/netbox\/configuration.py<\/code><\/p>\n\n\n\nExample:<\/p>\n\n\n\n
# vim \/opt\/netbox\/netbox\/netbox\/configuration.py<\/mark>\nSECRET_KEY = 'L2lyoE^*DN)6w3PK_d$-pe5ZS@XmMQ4J9g!cvF1V=n0juWiATR<\/mark>'<\/code><\/pre>\n\n\n\nRun the Upgrade Script<\/h3>\n\n\n\n
The Upgrade Script automatically runs the following:<\/p>\n\n\n\n
- \n
- Creates a Python environment and installs all required Python packages<\/li>\n\n\n\n
- Run database schema migrations<\/li>\n\n\n\n
- Builds the documentation locally (for offline use)<\/li>\n\n\n\n
- Aggregate static resource files on disk<\/li>\n<\/ul>\n\n\n\n
\/opt\/netbox\/upgrade.sh<\/code><\/pre>\n\n\n\nSource environment.<\/p>\n\n\n\n
source \/opt\/netbox\/venv\/bin\/activate\ncd \/opt\/netbox\/netbox<\/code><\/pre>\n\n\n\nCreate admin user:<\/p>\n\n\n\n
# python3 manage.py createsuperuser<\/mark>\nUsername (leave blank to use 'root'): admin<\/mark>\nEmail address: admin@example.com<\/mark>\nPassword: <Enter Password><\/mark><\/em>\nPassword (again): <Re-enter Password><\/mark><\/em>\nSuperuser created successfully.<\/code><\/pre>\n\n\n\nProceed and schedule housekeeping tasks. This handles repetitive cleanup tasks.<\/p>\n\n\n\n
ln -s \/opt\/netbox\/contrib\/netbox-housekeeping.sh \/etc\/cron.daily\/netbox-housekeeping<\/code><\/pre>\n\n\n\nStep 4: Configure Netxbox system service<\/h2>\n\n\n\n
Install gunicorn using pip3:<\/p>\n\n\n\n
# pip3 install gunicorn<\/mark>\nRequirement already satisfied: gunicorn in \/opt\/netbox\/venv\/lib\/python3.11\/site-packages (21.2.0)\nRequirement already satisfied: packaging in \/opt\/netbox\/venv\/lib\/python3.11\/site-packages (from gunicorn) (23.1)<\/code><\/pre>\n\n\n\nInstall and configure the Gunicorn module<\/h3>\n\n\n\n
Netbox ships default Gunicorn<\/strong> configuration that can be copied to the Netbox<\/strong> path as below.<\/p>\n\n\n\n
cp \/opt\/netbox\/contrib\/gunicorn.py \/opt\/netbox\/gunicorn.py<\/code><\/pre>\n\n\n\nYou may wish to edit the file and make configurations for your Bind Ip and port.<\/p>\n\n\n\n
vim \/opt\/netbox\/gunicorn.py<\/code><\/pre>\n\n\n\nIn the file, add the below lines.<\/p>\n\n\n\n
bind = '127.0.0.1:8001'\n\nworkers = 5\n\nthreads = 3\n\ntimeout = 120\n\n# The maximum number of requests a worker can handle before being respawned\nmax_requests = 5000\nmax_requests_jitter = 500<\/code><\/pre>\n\n\n\nCreate a systemd service file.<\/h3>\n\n\n\n
To be able to manage Netbox like other system services, we need to create the system file.<\/p>\n\n\n\n
cp -v \/opt\/netbox\/contrib\/*.service \/etc\/systemd\/system\/\nsystemctl daemon-reload<\/code><\/pre>\n\n\n\nAdd netbox user:<\/p>\n\n\n\n
sudo groupadd --system netbox\nsudo useradd --system -g netbox netbox\nsudo chown --recursive netbox \/opt\/netbox<\/code><\/pre>\n\n\n\nStart and enable Netbox services.<\/p>\n\n\n\n
sudo systemctl start netbox netbox-rq\nsudo systemctl enable netbox netbox-rq<\/code><\/pre>\n\n\n\nConfirm service status.<\/p>\n\n\n\n
$ systemctl status netbox.service<\/mark>\n\u25cf netbox.service - NetBox WSGI Service\n Loaded: loaded (\/etc\/systemd\/system\/netbox.service; enabled; preset: enabled)\n Active: active (running)<\/mark> since Thu 2023-09-21 20:35:59 UTC; 18s ago\n Docs: https:\/\/docs.netbox.dev\/\n Main PID: 8240 (gunicorn)\n Tasks: 6 (limit: 4531)\n Memory: 558.6M\n CPU: 8.188s\n CGroup: \/system.slice\/netbox.service\n \u251c\u25008240 \/opt\/netbox\/venv\/bin\/python3 \/opt\/netbox\/venv\/bin\/gunicorn --pid \/var\/tmp\/netbox.pid --pythonpath \/opt\/netbox\/netbox --config \/opt\/netbox\/gunicorn.py netbox.wsgi\n \u251c\u25008245 \/opt\/netbox\/venv\/bin\/python3 \/opt\/netbox\/venv\/bin\/gunicorn --pid \/var\/tmp\/netbox.pid --pythonpath \/opt\/netbox\/netbox --config \/opt\/netbox\/gunicorn.py netbox.wsgi\n \u251c\u25008246 \/opt\/netbox\/venv\/bin\/python3 \/opt\/netbox\/venv\/bin\/gunicorn --pid \/var\/tmp\/netbox.pid --pythonpath \/opt\/netbox\/netbox --config \/opt\/netbox\/gunicorn.py netbox.wsgi\n \u251c\u25008247 \/opt\/netbox\/venv\/bin\/python3 \/opt\/netbox\/venv\/bin\/gunicorn --pid \/var\/tmp\/netbox.pid --pythonpath \/opt\/netbox\/netbox --config \/opt\/netbox\/gunicorn.py netbox.wsgi\n \u251c\u25008249 \/opt\/netbox\/venv\/bin\/python3 \/opt\/netbox\/venv\/bin\/gunicorn --pid \/var\/tmp\/netbox.pid --pythonpath \/opt\/netbox\/netbox --config \/opt\/netbox\/gunicorn.py netbox.wsgi\n \u2514\u25008263 \/opt\/netbox\/venv\/bin\/python3 \/opt\/netbox\/venv\/bin\/gunicorn --pid \/var\/tmp\/netbox.pid --pythonpath \/opt\/netbox\/netbox --config \/opt\/netbox\/gunicorn.py netbox.wsgi\n\nSep 21 20:35:59 deb12 systemd[1]: Started netbox.service - NetBox WSGI Service.\nSep 21 20:36:00 deb12 gunicorn[8240]: [2023-09-21 20:36:00 +0000] [8240] [INFO] Starting gunicorn 21.2.0\nSep 21 20:36:00 deb12 gunicorn[8240]: [2023-09-21 20:36:00 +0000] [8240] [INFO] Listening at: http:\/\/127.0.0.1:8001 (8240)\nSep 21 20:36:00 deb12 gunicorn[8240]: [2023-09-21 20:36:00 +0000] [8240] [INFO] Using worker: gthread\nSep 21 20:36:00 deb12 gunicorn[8245]: [2023-09-21 20:36:00 +0000] [8245] [INFO] Booting worker with pid: 8245\nSep 21 20:36:00 deb12 gunicorn[8246]: [2023-09-21 20:36:00 +0000] [8246] [INFO] Booting worker with pid: 8246\nSep 21 20:36:00 deb12 gunicorn[8247]: [2023-09-21 20:36:00 +0000] [8247] [INFO] Booting worker with pid: 8247\nSep 21 20:36:00 deb12 gunicorn[8249]: [2023-09-21 20:36:00 +0000] [8249] [INFO] Booting worker with pid: 8249\nSep 21 20:36:00 deb12 gunicorn[8263]: [2023-09-21 20:36:00 +0000] [8263] [INFO] Booting worker with pid: 8263<\/code><\/pre>\n\n\n\nNetbox service should be listening on port 8001.<\/p>\n\n\n\n
# ss -tunelp | grep 8001<\/mark>\ntcp LISTEN 0 2048 127.0.0.1:8001 0.0.0.0:* users:((\"gunicorn\",pid=8263,fd=5),(\"gunicorn\",pid=8249,fd=5),(\"gunicorn\",pid=8247,fd=5),(\"gunicorn\",pid=8246,fd=5),(\"gunicorn\",pid=8245,fd=5),(\"gunicorn\",pid=8240,fd=5)) uid:999 ino:33912 sk:2 cgroup:\/system.slice\/netbox.service <-><\/code><\/pre>\n\n\n\nStep 5: Configure Nginx Web Server<\/h2>\n\n\n\n
Let’s configure Nginx
<\/g>web server to help us access Netbox via Domain name rather than specifying an IP address and a port.<\/p>\n\n\n\n apt install nginx<\/code><\/pre>\n\n\n\nCreate new Nginx configuration file for Netbox.<\/p>\n\n\n\n
vim \/etc\/nginx\/conf.d\/netbox.conf<\/code><\/pre>\n\n\n\nWith below data.<\/p>\n\n\n\n
server {\n listen 80;\n server_name netbox.example.com<\/mark>;\n client_max_body_size 25m;\n\n location \/static\/ {\n alias \/opt\/netbox\/netbox\/static\/;\n }\n\n location \/ {\n proxy_pass http:\/\/127.0.0.1:8001;\n proxy_set_header X-Forwarded-Host $http_host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-Proto $scheme;\n }\n}<\/code><\/pre>\n\n\n\nCheck Nginx configuration syntax and restart its service<\/p>\n\n\n\n
$ sudo nginx -t<\/mark>\nnginx: the configuration file \/etc\/nginx\/nginx.conf syntax is ok\nnginx: configuration file \/etc\/nginx\/nginx.conf test is successful<\/code><\/pre>\n\n\n\nIf OK, restart Nginx service<\/p>\n\n\n\n
sudo systemctl restart nginx<\/code><\/pre>\n\n\n\nStep 6: Secure Netbox with Let’s Encrypt <\/h2>\n\n\n\n
To secure your Netbox installation with Let’s Encrypt SSL follow the guide below:<\/p>\n\n\n\n
- \n
- How To Secure Netbox IPAM Server with Let\u2019s Encrypt SSL<\/a><\/li>\n<\/ul>\n\n\n\n
Step 7: Access Netbox Web UI<\/h2>\n\n\n\n
Open your default web browser and open Netbox server hostname. To make changes, login with admin user created earlier.<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2019\/01\/install-netbox-ubuntu-18.04-login-1024x395.png\" "\\"\\"")
<\/figure>\n\n\n\nThere you go!.. You have NetBox dashboard.<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2020\/01\/install-netbox-debian-1024x409.png\" "\\"\\"")
<\/figure>\n\n\n\nEnjoy using Netbox to document your network infrastructure. Access NetBox documentation<\/a> to learn more about this awesome product.<\/p>\n\n\n\n
You can also check:<\/p>\n\n\n\n
- \n
- Install and Configure phpIPAM on Debian<\/a><\/li>\n\n\n\n
- How to install RackTables on Ubuntu<\/a><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"
NetBox is an open source IPAM \/ DCIM web application used for managing and documenting computer networks and managing IP addresses. It was Initially conceived by the network engineering team at DigitalOcean. The tool is written in Django Python framework and relies on PostgreSQL database for data store. NetBox building blocks: If you’re interested in … Read more<\/a><\/p>\n","protected":false},"author":3,"featured_media":44170,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[299,26,50],"tags":[635,465,38437],"class_list":["post-44142","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-how-to","category-debian","category-linux-tutorials","tag-ipam","tag-netbox","tag-netbox-ipam-on-debian"],"_links":{"self":[{"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/posts\/44142","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/comments?post=44142"}],"version-history":[{"count":0,"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/posts\/44142\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/media\/44170"}],"wp:attachment":[{"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/media?parent=44142"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/categories?post=44142"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/tags?post=44142"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
- How to install RackTables on Ubuntu<\/a><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"
- Install and Configure phpIPAM on Debian<\/a><\/li>\n\n\n\n
- How To Secure Netbox IPAM Server with Let\u2019s Encrypt SSL<\/a><\/li>\n<\/ul>\n\n\n\n