Update Guide¶

Note: If you are upgrading from a version prior to v5.20 and use Nginx as a reverse proxy, the frontend path has changed. Make sure you have access to your Nginx configuration before proceeding — you may need to update it after the upgrade. See Updating Nginx Configuration for details.

Requirements¶

• Previous Faraday server on-prem version installed.
• Redis
• PostgreSQL

Step 1 - Download the Faraday Installer¶

Download the installer for your OS and license from the Faraday Portal.

DEB packages (Ubuntu / Kali)¶

RPM packages (Rocky Linux / Oracle Linux)¶

Step 2 - Upgrade the Package¶

Navigate to the directory where you downloaded the installer and run the appropriate command for your OS.

Ubuntu / Kali (DEB)¶

sudo apt-get install ./faraday-server-<edition>_<os>_amd64.deb

Example for Corp on Ubuntu 24:

sudo apt-get install ./faraday-server-corp_ubuntu24_amd64.deb

Rocky Linux / Oracle Linux (RPM)¶

sudo dnf install ./faraday-server-<edition>_<os>_amd64.rpm

Example for Corp on Rocky Linux 8:

sudo dnf install ./faraday-server-corp_rockylinux8_amd64.rpm

This process will handle installing and migrating all data to the new version of Faraday.

Importing the License¶

Method 1 — Using faraday-manage¶

Step 1 — Delete the old license files:

rm /home/faraday/.faraday/doc/*

Step 2 — Import the license using your portal credentials:

faraday-manage import-license

Method 2 — Manual import¶

Use this method on servers without internet access.

Step 1 — Delete the old license files:

rm /home/faraday/.faraday/doc/*

Step 2 — Copy the license file (licence.tar.gz) downloaded from the Faraday Portal to /home/faraday/.faraday/doc/ and extract it:

tar xvf licence.tar.gz

Post-Upgrade — Check Services¶

Ubuntu / Kali (systemd)¶

sudo systemctl status faraday-server
sudo systemctl enable faraday-server
sudo systemctl restart faraday-server

sudo systemctl status faraday-worker
sudo systemctl enable faraday-worker
sudo systemctl restart faraday-worker

sudo systemctl status faraday-worker-reports
sudo systemctl enable faraday-worker-reports
sudo systemctl restart faraday-worker-reports

Rocky Linux / Oracle Linux (systemd)¶

sudo systemctl status faraday-server
sudo systemctl enable faraday-server
sudo systemctl restart faraday-server

sudo systemctl status faraday-worker
sudo systemctl enable faraday-worker
sudo systemctl restart faraday-worker

sudo systemctl status faraday-worker-reports
sudo systemctl enable faraday-worker-reports
sudo systemctl restart faraday-worker-reports

Updating Nginx Configuration (v5.20+)¶

Starting with version 5.20, the Faraday frontend is installed at a new path:

/opt/faraday/venv/lib/python3.11/site-packages/faraday/server/www/

If after upgrading you get a 403 Forbidden response when accessing the Faraday web UI, this is likely the cause.

Update your Nginx configuration to replace the old alias directive:

Before:

location / {
    alias /opt/faraday/venv/lib/python3.11/site-packages/faraday/server/www/;
    try_files $uri $uri/ /index.html;
}

After:

location / {
    alias /opt/faraday/share/www/;
    try_files $uri $uri/ /index.html;
}

After updating the config, reload Nginx:

sudo systemctl reload nginx