/
Linux installation & update of XTRF 10

Linux installation & update of XTRF 10

This document is intended for Server Administrators with sufficient technical skills. 

This article explains the procedure for installing and updating XTRF 10 on Debian/Ubuntu. Ensure that your server meets the requirements listed in the following article: Server requirements.

The instructions differ slightly depending on your current operating system.

Installation

Preparatory steps

Debian - preparatory steps

Make sure you have the contrib and non-free suites enabled (for details, see https://wiki.debian.org/SourcesList).

For Debian 13 Trixie, Java 17 must be installed from an external repo (for details, see the Java 17 section below).

Java 17

Java 17 can be installed from a repo (e.g., Temurin) using the following commands:

wget -O /usr/share/keyrings/adoptium-net-keyring.gpg https://packages.adoptium.net/artifactory/api/gpg/key/public echo "deb [signed-by=/usr/share/keyrings/adoptium-net-keyring.gpg] https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | tee /etc/apt/sources.list.d/adoptium.list apt update apt install temurin-17-jdk

Ubuntu Server - preparatory steps

Some additional packages must be installed, as they might be missing from the default installation. It can be done using the following command:

sudo apt install apt-transport-https

PostgreSQL 15

If version 15 or higher is not available in your Ubuntu, it could be achieved by the following commands:

wget -qO - https://www.postgresql.org/media/keys/ACCC4CF8.asc | gpg --dearmor | sudo tee /usr/share/keyrings/postgresql-archive-keyring.gpg > /dev/null echo "deb [signed-by=/usr/share/keyrings/postgresql-archive-keyring.gpg] http://apt.postgresql.org/pub/repos/apt jammy-pgdg main" | sudo tee /etc/apt/sources.list.d/pgdg.list sudo apt update sudo apt install postgresql-15

Common installation steps 

  1. Fetch your unique repository address from https://ssm.xtrf.eu/.  

  2. Add the XTRF package repository:

    wget -qO - https://repo.xtrf.eu/debian/key.pub | gpg --dearmor | sudo tee /usr/share/keyrings/xtrf-archive-keyring.gpg > /dev/null deb ... (address retrieved from SSM) sudo apt update

  3. And finally, install the XTRF package itself:

    sudo apt install xtrf10-full

  • The package installs an additional service jboss-xtrf-tomcat.service running on the same Java version as the core application. This service is decoupled from the main application for performance reasons. It can be used to host additional customizations. If there are none, this service is automatically disabled.

  • The package installs an additional service jboss-xtrf-file-stats.service running on the same Java version as the core application. This service is decoupled from the main application for performance reasons.

In case of installing XTRF separately from the database, run this command instead:

sudo apt install xtrf10-full --no-install-recommends

 

Finally, check whether XTRF is accessible at a temporary address at https://server-ip-address:8443/.

Please remember about the SSL reverse proxy, XTRF must not be accessed via IP address.
For details, see SSL Certificate installation (OnPremises only)

Update

  1. If you use virtualization, perform a VM snapshot in case an urgent rollback is required.

  2. Ensure that your server meets the requirements listed in the following article: Server requirements.

  3. Update the XTRF repository address in your apt configuration. You should get it from our XTRF Self-Service Manager.
    If the server was migrated from Debian 12 Bookworm to Debian 13 Trixie, please remove the existing deb repo address and perform the instructions below:

    wget -qO - https://repo.xtrf.eu/debian/key.pub | gpg --dearmor | sudo tee /usr/share/keyrings/xtrf-archive-keyring.gpg > /dev/null deb ... (address retrieved from SSM) sudo apt update

  4. Perform XTRF 10 update by:

    sudo apt install xtrf10-full

  5. The script will download the latest XTRF 10.x. Perform a database backup (only with the default, unmodified configuration), upgrade the necessary files, and restart your new applications.

  • The package installs an additional service jboss-xtrf-tomcat.service running on the same Java version as the core application. This service is decoupled from the main application for performance reasons. It can be used to host additional customizations. If there are none, this service is automatically disabled.

  • The package installs an additional service jboss-xtrf-file-stats.service running on the same Java version as the core application. This service is decoupled from the main application for performance reasons.

Finally, check whether XTRF is accessible via browser on the same URL as before, i.e., https://xtrf.domain.com.

Maintenance procedures

You can restart XTRF manually by issuing the following command:

 sudo systemctl restart jboss-xtrf.service

XTRF is managed as a systemd service, so all the usual administrative commands from systemd apply.