Manhal.Mohamed: /* 6. Configure Nginx Web Server */

2024-08-16T09:19:56Z

‎6. Configure Nginx Web Server

Manhal.Mohamed at 09:18, 16 August 2024

2024-08-16T09:18:56Z

Manhal.Mohamed: /* Prerequisites */

2024-08-16T09:17:50Z

‎Prerequisites

Manhal.Mohamed: /* 3. Install and configure NetBox */

2024-08-16T09:16:46Z

‎3. Install and configure NetBox

Manhal.Mohamed at 08:04, 15 August 2024

2024-08-15T08:04:11Z

Show changes

Manhal.Mohamed: Created page with "Certainly, I can help you convert this content into wiki page syntax. Here's the content formatted for a wiki page: = Prerequisites = * Deploy a fully updated Ubuntu 20.04 LT..."

2024-08-15T07:59:14Z

Created page with "Certainly, I can help you convert this content into wiki page syntax. Here's the content formatted for a wiki page: = Prerequisites = * Deploy a fully updated Ubuntu 20.04 LT..."

New page

Certainly, I can help you convert this content into wiki page syntax. Here's the content formatted for a wiki page:

= Prerequisites =
* Deploy a fully updated Ubuntu 20.04 LTS at Vultr with at least 2GB of RAM and 1 vCPU cores.
* Create a non-root user with sudo access.

== 1. Install and configure PostgreSQL ==

Install PostgreSQL:
<code>
sudo apt install postgresql libpq-dev -y
</code>

Start the database server:
<code>
sudo systemctl start postgresql
</code>

Enable the database server to start automatically on reboot:
<code>
sudo systemctl enable postgresql
</code>

Change the default PostgreSQL password:
<code>
sudo passwd postgres
</code>

Switch to the postgres user:
<code>
su - postgres
</code>

Log in to PostgreSQL:
<code>
psql
</code>

Create database netbox:
<code>
CREATE DATABASE netbox;
</code>

Create user netbox with password my_strong_password. Use a strong password in place of my_strong_password:
<code>
CREATE USER netbox WITH ENCRYPTED password 'my_strong_password';
</code>

Grant all the privileges on the netbox database to the netbox user:
<code>
GRANT ALL PRIVILEGES ON DATABASE netbox to netbox;
</code>

Exit PostgreSQL:
<code>
\q
</code>

Return to your non-root sudo user account:
<code>
exit
</code>

== 2. Install Redis® ==
Redis® is an in-memory key-value store. NetBox uses it for caching and queuing.

Install Redis®:
<code>
sudo apt install -y redis-server
</code>

== 3. Install and configure NetBox ==
It's recommended to install NetBox from the official git repository to allows for seamless upgrades by re-pulling the master branch.

Install all the required packages:
<code>
sudo apt install python3 python3-pip python3-venv python3-dev build-essential libxml2-dev libxslt1-dev libffi-dev libpq-dev libssl-dev zlib1g-dev git -y
</code>

Update pip to the latest version:
<code>
sudo pip3 install --upgrade pip
</code>

We'll use /opt/netbox/ as the installation directory. Create directory /opt/netbox/ and change to /opt/netbox/ directory:
<code>
sudo mkdir -p /opt/netbox/ && cd /opt/netbox/
</code>

Clone NetBox from official git repository to the current directory:
<code>
sudo git clone -b master https://github.com/netbox-community/netbox.git .
</code>

Create a system user named netbox:
<code>
sudo adduser --system --group netbox
</code>

Grant user netbox ownership of /opt/netbox/netbox/media/:
<code>
sudo chown --recursive netbox /opt/netbox/netbox/media/
</code>

Browse to the /opt/netbox/netbox/netbox/ directory:
<code>
cd /opt/netbox/netbox/netbox/
</code>

Copy example configuration file configuration.example.py to a configuration file configuration.py that we will use to configure the project:
<code>
sudo cp configuration.example.py configuration.py
</code>

Create a symbolic link of Python binary:
<code>
sudo ln -s /usr/bin/python3 /usr/bin/python
</code>

Generate a random SECRET_KEY of at least 50 alphanumeric characters:
<code>
sudo /opt/netbox/netbox/generate_secret_key.py
</code>

You will get a random secret similar to the below example. Copy it and save it somewhere. You will need it in the configuration file:
<code>
-^%YEl*Q2etCR6$kNG70H=&sM(45XvJaBWdf3O)inZ@L9j8_w1
</code>

Open and edit the configuration file configuration.py:
<code>
sudo nano /opt/netbox/netbox/netbox/configuration.py
</code>

The final file should have the following configurations:
<pre>
ALLOWED_HOSTS = ['*']

DATABASE = {
'NAME': 'netbox', # Database name you created
'USER': 'netbox', # PostgreSQL username you created
'PASSWORD': 'my_strong_password', # PostgreSQL password you set
'HOST': 'localhost', # Database server
'PORT': '', # Database port (leave blank for default)
}

SECRET_KEY = '-^%YEl*Q2etCR6$kNG70H=&sM(45XvJaBWdf3O)inZ@L9j8_w1'
</pre>

Run the upgrade script:
<code>
sudo /opt/netbox/upgrade.sh
</code>

Enter the Python virtual environment:
<code>
source /opt/netbox/venv/bin/activate
</code>

Go to /opt/netbox/netbox directory:
<code>
cd /opt/netbox/netbox
</code>

Create a superuser account:
<code>
python3 manage.py createsuperuser
</code>

Reboot the system to apply the changes:
<code>
sudo reboot
</code>

== 4. Configure Gunicorn ==
Copy /opt/netbox/contrib/gunicorn.py to /opt/netbox/gunicorn.py:
<code>
sudo cp /opt/netbox/contrib/gunicorn.py /opt/netbox/gunicorn.py
</code>

== 5. Configure Systemd ==
Copy contrib/netbox.service and contrib/netbox-rq.service to the /etc/systemd/system/ directory:
<code>
sudo cp /opt/netbox/contrib/*.service /etc/systemd/system/
</code>

Reload daemon to enable the Systemd changes:
<code>
sudo systemctl daemon-reload
</code>

Start the netbox and netbox-rq services:
<code>
sudo systemctl start netbox netbox-rq
</code>

Enable the services to initiate at boot time:
<code>
sudo systemctl enable netbox netbox-rq
</code>

== 6. Configure Nginx Web Server ==
Install Nginx web server:
<code>
sudo apt install -y nginx
</code>

Copy NetBox Nginx configuration file nginx.conf to /etc/nginx/sites-available/netbox:
<code>
sudo cp /opt/netbox/contrib/nginx.conf /etc/nginx/sites-available/netbox
</code>

Edit file netbox:
<code>
sudo nano /etc/nginx/sites-available/netbox
</code>

Replace all the files content with the below code. Modify the server_name value with your server IP address:
<pre>
server {
listen 80;

# CHANGE THIS TO YOUR SERVER'S NAME
server_name 192.0.2.10;

client_max_body_size 25m;

location /static/ {
alias /opt/netbox/netbox/static/;
}

location / {
proxy_pass http://127.0.0.1:8001;
proxy_set_header X-Forwarded-Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
}
}
</pre>

Delete /etc/nginx/sites-enabled/default:
<code>
sudo rm /etc/nginx/sites-enabled/default
</code>

Create a symlink in the sites-enabled directory to the netbox configuration file:
<code>
sudo ln -s /etc/nginx/sites-available/netbox /etc/nginx/sites-enabled/netbox
</code>

Restart nginx service to enable the new configurations:
<code>
sudo systemctl restart nginx
</code>

Would you like me to explain or break down any part of this wiki syntax?

@@ Line 240: / Line 240: @@
 sudo cp /opt/netbox/contrib/nginx.conf /etc/nginx/sites-available/netbox
 </code>
 Edit the configuration file:
@@ Line 245: / Line 246: @@
 sudo nano /etc/nginx/sites-available/netbox
 </code>
 Replace the server name with your server's IP address:
@@ Line 266: / Line 268: @@
+}
 </pre>
 Delete the default Nginx configuration:
@@ Line 271: / Line 274: @@
 sudo rm /etc/nginx/sites-enabled/default
 </code>
 Create a symbolic link for the NetBox configuration:
@@ Line 282: / Line 286: @@
 sudo systemctl restart nginx
 </code>
 == Author ==
 * '''Author''': [[User:Manhal.Mohamed|Manhal Mohamed]]'' , SdNOG Team

← Older revision		Revision as of 09:18, 16 August 2024
Line 282:		Line 282:
	sudo systemctl restart nginx		sudo systemctl restart nginx
	</code>		</code>
		+
		+	== Author ==
		+	* '''Author''': [[User:Manhal.Mohamed\|Manhal Mohamed]]'' , SdNOG Team

@@ Line 130: / Line 130: @@
 sudo cp configuration_example.py configuration.py
 </code>
 Create a symbolic link for the Python binary:
@@ Line 190: / Line 191: @@
 sudo reboot
 </code>
 == 4. Configure Gunicorn ==