This guide provides instructions for upgrading your on-premises VT Writer deployment to version 5.1.3 or above.

New Features in Version 5.1.3

VT Writer 5.1.3 introduces several important improvements:

1. Configuration Changes:

   • Configuration has been split into two separate files for better modularity

2. LLM and RAG Integration (optional):

   • New capabilities to integrate with Large Language Models (LLMs)
   • Support for Retrieval Augmented Generation (RAG) workflows, including:
     • local file upload
     • Sharepoint Online integration
   • For details on configuring and using these features, see:
     • Frequently Asked Questions: VT Writer, VTRAG, and LLM Integration
     • VT Writer LLM Configuration Guide
     • VTRAG Configuration Guide
     • VT Writer SharePoint Integration Guide

Note: If you choose to use the new LLM and VTRAG functionality, you will need to set them up after the upgrade. See the above documentation links for detail or reach out to support@visiblethread.com for assistance.

Upgrading for Different Deployment Types

RHEL/Amazon Linux Deployments

Before You Upgrade

System Backup:

We strongly recommend taking a full system backup before proceeding

For database backup, run:

/opt/visiblethread/VisibleThreadTools/vt-backup.sh

Verify Java Version: As of VT Writer 4+, the application requires Java OpenJDK 17. If not already installed:

# Verify Java version
java -version

# Install if Java17 isn't already
sudo dnf update
sudo yum install java-17-openjdk

# Verify Java version
java -version

# If needed, select Java 17 as default
sudo update-alternatives --config java

Download and Install New Packages:

sudo yum install --setopt=clean_requirements_on_remove=0 visiblethread-api-X.Y.Z.rpm
sudo yum install --setopt=clean_requirements_on_remove=0 visiblethread-readability-X.Y.Z.rpm

The upgrade process will:

• Detect your running previous installation
• Automatically migrate your configuration
• Restart the services if they were running

Note about Configuration Files:

• During the upgrade, your existing configuration in /etc/default/visiblethread.env will be automatically migrated
• API-specific variables will be moved to the new /etc/default/vtapi.env file
• No manual configuration changes are required for a standard installation

Ubuntu OVA Deployments

If you are currently using an Ubuntu OVA and wish to upgrade, please contact support@visiblethread.com for specialized assistance.

The upgrade process for Ubuntu OVA deployments requires specific steps tailored to your installation.

Windows Deployments

For upgrading VT Writer on Windows:

1. Download the executable installer file provided in your upgrade email
2. Run the installer and follow the on-screen instructions

Note: VTRAG is bundled in the Windows installer and is optional. If you choose to use VTRAG make sure to select that option when upgrading.

Verifying the Upgrade

1. Check Package Versions (RHEL/Amazon Linux):

   yum info visiblethread-api
   yum info visiblethread-readability
   

   Ensure versions match what was specified in your upgrade email.

2. Check Service Status (RHEL/Amazon Linux):

   sudo systemctl status visiblethread.service
   

3. Verify Web Interface:

   • Access VT Writer at https://your-server-ip/
   • Confirm the version number on the login screen matches the upgrade version
   • Sign in and upload a document to verify analysis works correctly
   • If applicable, test the email service by sending a document to your designated analysis email

Troubleshooting

If you encounter issues during the upgrade:

1. Check Installation Logs (RHEL/Amazon Linux):

   sudo journalctl -u visiblethread.service
   

2. Configuration Files (RHEL/Amazon Linux): If you need to check your configuration files after the upgrade:

   sudo cat /etc/default/visiblethread.env
   sudo cat /etc/default/vtapi.env
   

For further assistance, please contact VisibleThread Support at support@visiblethread.com.