Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 2 Next »

On this page:

The following are the specs where the eLearning analytical stack has been installed and tested. Please try to recreate the following environment as close as possible to ensure the correct functionality of all components.

Hardware Specs

These specs belong to a t3.large EC2 machine.

Item

Value

Notes

vCPUs

2

RAM

8 GiB

SSD Storage

30 GiB

If on AWS: gp3 volume

Software Specs

Item

Value

Notes

Operating System

ubuntu-noble-24.04-amd64-server-20240801

Web Server

nginx/1.24.0 (Ubuntu)

Virtualization Software

Docker/27.2.1 (build 9e34c9b)

SSL Certificate

Certbot/2.11.0

Generates and automatically renews SSL certificates.

Open ports

Item

Notes

80

Certbot needs this port open for generating and the renewal of SSL certificates.

443

HTTPS port

22

SSH access

Make sure to install nginx before generating an SSL certificate using Certbot, as Certbot can automatically install the certificate and make all the required configurations on nginx. This guide makes use of that functionality.

Certbot - SSL Certificate

Having an SSL certificate ensures a secured connection between users and the server, and that no data is compromised while it is traveling over the internet. This allows users to connect using HTTPS protocol over the port 443.

This guide assumes the server already has a domain and the necessary DNS record/s have been created.

  1. Open ports 80 and 443, belonging to HTTP and HTTPS respectively. Port 22 is also required.

  2. Connect via SSH to the server with a user with sudo privileges.

  3. Install Certbot

    sudo snap install --classic certbot
  4. Prepare the Certbot command

    sudo ln -s /snap/bin/certbot /usr/bin/certbot
  5. Generate the certificate, this will also automatically edit the nginx configuration to serve it.

    sudo certbot --nginx
    1. Certbot will ask some questions, like an email to send notifications about certificate renewals.

    2. After the initial questions, Certbot will ask for the domain names to issue the certificate. It will try to access the server over port 80 using the domain name, so it’s imperative the DNS records are already configured.

  6. Test that Certbot is capable of renewing the certificate, otherwise after a couple of months it will expire and users will lose access to the services.

    sudo certbot renew --dry-run
    image-20241001-222438.png

Official installation guide: https://certbot.eff.org/instructions?ws=nginx&os=snap

Official documentation: https://eff-certbot.readthedocs.io/en/stable/

Nginx Configuration

NiFi by default runs on port 8443, similarly, Superset runs on port 8088. However, to have a secured connection users should only be able to connect through port 443, where the SSL certificate is served.

Nginx will act as a reverse-proxy and redirect users requests that come through port 443 to the correct destinations.

  1. Nginx configuration file can be edited using the following command:

    nano /etc/nginx/sites-enabled/default
  2. Search for the server bracket that is listening to port 443. Certbot configuration can be found here.

  3. Edit and add the locations to redirect traffic. For superset:

            location / {
                    proxy_pass http://localhost:8088;
                    proxy_set_header Host $host;
                    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
                    proxy_set_header X-Forwarded-Proto $scheme;
                    proxy_redirect off;
            }
  4. For NiFi:

            location /nifi {
                    proxy_pass https://localhost:8443/nifi;
                    proxy_set_header Host $host;
                    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
                    proxy_set_header X-Forwarded-Proto $scheme;
                    proxy_redirect off;
            }

The above configuration will make Superset accessible by using the base domain (https://exampledomain.com) and NiFi accesible by adding /nifi as a path (https://exampledomain.com/nifi)

Docker Configuration

WIP

  • No labels