Simple guide to install and configure NGINX on Ubuntu

In this post we are going to install and configure nginx on an Ubuntu or any Debian server. We are also going to use certbot to set the HTTPs certificate (Let’s encrypt) to host our webpage only using https.

NGINX

Installation:

We can use apt to install the web server.

NOTE: make sure you don’t have anything running on the port 80, to avoid restarting the server after the installation.

sudo apt update
sudo apt install nginx

Shell

If you have a firewall, you should set your rules after this step.

Check the server status:

To check the status we can just run:

systemctl status nginx

Shell

It should return something like this:

$ systemctl status nginx
● nginx.service - A high performance web server and a reverse proxy server
   Loaded: loaded (/lib/systemd/system/nginx.service; enabled; vendor preset: enabled)
   Active: active (running) since Mon 2021-04-26 22:14:56 UTC; 1min 18s ago
     Docs: man:nginx(8)
  Process: 28780 ExecStartPre=/usr/sbin/nginx -t -q -g daemon on; master_process on; (code=exited, status=0/SUCCESS
  Process: 28781 ExecStart=/usr/sbin/nginx -g daemon on; master_process on; (code=exited, status=0/SUCCESS)
 Main PID: 28782 (nginx)
    Tasks: 3 (limit: 4665)
   Memory: 3.6M
   CGroup: /system.slice/nginx.service
           ├─28782 nginx: master process /usr/sbin/nginx -g daemon on; master_process on;
           ├─28783 nginx: worker process
           └─28784 nginx: worker process

Apr 26 22:14:56 burninstone-new systemd[1]: Starting A high performance web server and a reverse proxy server...
Apr 26 22:14:56 burninstone-new systemd[1]: Started A high performance web server and a reverse proxy server.

Shell

If the server is active (running), everything is correct. You can check it in any browser using the url http://your-ip

Useful commands:

Stop the web server

sudo systemctl stop nginx

Shell

Start the web server:

sudo systemctl start nginx

Shell

Restart the web server:

sudo systemctl restart nginx

Shell

Check if your configuration file syntax is valid:

sudo nginx -t

Shell

Reload the web server (after making changes on your config file:

sudo systemctl reload nginx

Shell

Create an index.html

Create the folder:

sudo mkdir -p /var/www/your_domain/html

Shell

Set the owner:

sudo chown -R $USER:$USER /var/www/your_domain/html

Shell

Set the permissions:

sudo chmod -R 755 /var/www/your_domain

Shell

Create the index file:

sudo vim /var/www/your_domain/html/index.html

Plain Text

NOTES:

I’m using VIM to edit my files, but you can use any other editor, for example, NANO.

To install vim on Ubuntu: sudo apt install vim.

To exit vim, save and quit pressing: esc + :wq + enter.

Code the index.html:

NOTE: to paste on vim press insert.

<html>
    <head>
        <title>Hanchon test</title>
    </head>
    <body>
        <h1>Testing NGINX on Ubuntu</h1>
    </body>
</html>

HTML

.../html/index.html

Configure your domain

NOTE: In every step change the your_domain value.

Let’s start creating a new file with the configuration for our domain.

sudo vim /etc/nginx/sites-available/your_domain

Shell

After creating the domain, let’s serve a webpage with this configuration:

server {
        listen 80;
        listen [::]:80;

        root /var/www/your_domain/html;
        index index.html;

        server_name your_domain www.your_domain;

        location / {
                try_files $uri $uri/ =404;
        }
}

Plain Text

/etc/nginx/sites-available/your_domain

Create a symbolic link to the sites-enabled folder, so NGINX knows that we want to use this configuration.

sudo ln -s /etc/nginx/sites-available/your_domain /etc/nginx/sites-enabled/

Shell

Check the configuration syntax and if everything is ok, restart NGINX:

sudo nginx -t
sudo systemctl restart nginx

Shell

NOTE: if you are using Angular builds, add this line to avoid having errors when refreshing the page.

location / {
    root   /var/www/ethics_demo/html;
    try_files $uri $uri/ /index.html;
    index  index.html;
}

Plain Text

/etc/nginx/sites-available/your_domain

Use NGINX as a proxy

We can configure our webserver to redirect the request to another endpoint, for example an application running locally in our server:

server {
    listen 80;
    listen [::]:80;
    server_name your_domain www.your_domain;
    location /api/ {
        proxy_pass http://127.0.0.1:7000/;
        include proxy_params;
    }
}

Plain Text

NOTE: If you are using FastAPI as your API, like it was explained in the FastAPI guides, you may must to add your root_path to the FastAPI constructor: app = FastAPI(root_path='/api').

Certificates

We are going to use certbot to create, install and renew free certificates (Let’s Encrypt).

Install Certbot:

We are going to install certbot using snap:

Let’s install snap if needed:

sudo apt install snapd;

Shell

Let’s install core:

sudo snap install core;

Shell

Note: if you are having problems, you should close the terminal and reopen it, so the snap paths are added to your terminal.

Install certbot:

sudo snap install --classic certbot;

Shell

Make a link to /usr/bin to use it:

sudo ln -s /snap/bin/certbot /usr/bin/certbot

Shell

Certbot usage:

Create and install the certificate:

sudo certbot --nginx -d your_domain

Shell

NOTE: if you want to create certificates for all your domains, you can ignore the -d param.

Auto-update certificates:

Certbot already updates your certificates before they expire.

You can test the renew process using this command

sudo certbot renew --dry-run

Shell

Test your webpage:

The last step is to test if everything is working as intended:

Enter to https://your_domain and it should work.

Enter to http://your_domain and you should be redirected to https://your_domain.

Proxy pass with .sock file:

To use a Uvicorn API with a .sock file, we need to add this to the domain:

# At the begging of the file add this function
map $http_upgrade $connection_upgrade {
    default upgrade;
    '' close;
}
upstream uvicorn {
    server unix:/tmp/socket.sock;
}

# Inside the server configuration
location /api/ {
    proxy_set_header Host $http_host;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Connection $connection_upgrade;
    proxy_pass http://uvicorn/;
}

Plain Text

Some changes needs to be made in your app to make it work with sockets:

import os
ENV = os.getenv('ENV', 'DEV')
if __name__ == '__main__':
    if ENV == 'DEV':
        uvicorn.run(app, port=7000)
    else:
        uvicorn.run(app, root_path="/api", uds='/tmp/socket.sock')

Python

Support websockets:

Add these changes to the location /api/ configuration:

    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "Upgrade";
    proxy_set_header Host $host;

HTML