How to Install Paperless-Ngx in Nat Vps

Natvps.id – Paperless-ngx is a document management application for storing, reading, and grouping documents digitally. Paperless-NGX can be used to facilitate the storage of document files from the results Scan or digital documents.

This article discusses the steps to install paperless-NGX in NAT VPS using a docker, along with the Nginx configuration for Reverse-Proxy. This article uses Ubuntu 22.04 as a reference, but you can use other distributions such as Debian and Centos. Make sure the OS used supports the docker.

Port forwarding configuration

Considering we use grout, we need to add 2 Port Forwarding Configuration on the virtualizor panel (or other VPS panels according to the provider), namely Port Forwarding HTTP and HTTPS For domains without paper-ngx.

For example, in this article will use a domain document.tutorial.mdinata.my.id to access the paperless-ngx. You are free to change the domain according to your choice. Record this port and domain, because we will use it again in the deploy process.

Don’t forget to add DNS Records to go to your NAT VPS public IP, like this:

Install Docker

We will use a docker and compile a docker for spread Paperless-ngx.

First, install curly Using Orders:

apt update && apt install curl -y

Then, run manuscript Automatic installation from the docker by entering:

curl -fsSL get.docker.com | sh

Wait until the installation process is complete.

Install the paperless-ngx

Paperless-NGX provides a compose docker configuration that is ready to be used in its repositories, so we don’t need to create configuration files docker-compose.yml from the beginning.

First, install GIT and clone Paperless-NGX repository.

mkdir paperless-ngx
cd paperless-ngx/

Download the required configuration files, namely:

1. Docker Compose:

   curl -Lo docker-compose.yml 

2. Environment for Docker Compose:

   curl -LO 

3. Environmental Variables:

   curl -LO 

Then, open the file docker-compose.env:

nano docker-compose.env

Change the contents of PAPERLESS_URL With your paperless-ngx domain, for example: https://document.tutorial.mdinata.my.id.

Save the file.

Other configurations do not need to be changed, but you are free to change it if necessary.

Run paperless-ngx:

docker compose up -d

Wait until the process spread finished. Deploy can first take a few minutes because it has to download all picture Paperless-Ngx from the start.

Nginx Configuration (Reverse Proxy)

So that we can access the URL through a domain like document.tutorial.mdinata.my.idwe can use Reverse Proxy Like Nginx.

First, install Nginx through the command:

# Hapus Apache2 dan pendukungnya (biasanya terpasang secara bawaan di VPS OpenVZ)
apt purge apache2* -y

# Install NGINX
apt install nginx -y

Create a new host configuration specifically for paperless-ngx:

nano /etc/nginx/sites-available/paperless-ngx

Then stick the following configuration:

# 
# Reference: 

server {
        listen 80;
        listen [::]:80;
        server_name document.tutorial.mdinata.my.id;

        location / {
            proxy_pass 

            # These configuration options are required for WebSockets to work.
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";

            proxy_redirect off;
            proxy_set_header Host $host:$server_port;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Host $server_name;
            proxy_set_header X-Forwarded-Proto $scheme;
            add_header Referrer-Policy "strict-origin-when-cross-origin";
        }
}

Adjust document.tutorial.mdinata.my.id with your domain.

Activate the configuration with:

ln -sf /etc/nginx/sites-available/paperless-ngx /etc/nginx/sites-enabled/paperless-ngx

# Restart NGINX
systemctl restart nginx

Produce SSL certificate (let’s encryption)

So that our domain can be accessed through HTTPS, we need to make a SSL certificate. We can use a free SSL certificate from Let’s Encrypt through Certbot.

Install Certbot and Nginx plugin use the command:

apt install python3-certbot python3-certbot-nginx

So, produce Certificate through Certbot with the command

certbot --nginx -d document.tutorial.mdinata.my.id

Change document.tutorial.mdinata.my.id with your domain.

Happy! Your current domain can be accessed via a safe connection https.

Access the paperless-ngx dashboard

Paperless-NGX can be accessed through your previous domain. Example: https://document.tutorial.mdinata.my.id.

Cover

Thus this article is about the steps to install paperless-NGX on NAT VPS. If you are confused or doubtful, don’t hesitate to ask questions in the telegram group @ipv6indonesia. Thank You!