VisibleThread -
Help Center Find helpful articles on different VisibleThread Products


VisibleThread 2.13 on-premise upgrade instructions

IMPORTANT - before you upgrade:

VisibleThread for Docs 2.13 uses a new internal storage architecture for storing documents and analysis. Upgrading your VisibleThread Docs environment to version 2.13 will migrate all your data. VisibleThread recommend you keep regular back ups of your environment. As a precaution the upgrade procedure will back up your current VisibleThread data, however you should also backup your VM using either snapshots or some other Virtual Machine backup tools (e.g. Veeam) before performing this upgrade.


Upgrade pre-requisites:

In order to upgrade your environment to VisibleThread 2.13 your current deployment must meet the following criteria, the upgrade process will check for each of these before upgrading the server:

  • You must be currently on VisibleThread Docs 2.12
  • Your VisibleThread server must be running Ubuntu 12.04, to verify this you can type 'lsb_release -a' at the server command line.
  • Your VisibleThread server must have enough free disk space to complete the data migration process. The amount of disk space required depends on the number and size of documents you have on your VisibleThread Server. The upgrade process will run check to ensure you have enough free space to continue.


How to upgrade your server to VisibleThread 2.13

The VisibleThread 2.13 upgrade is shipped as a compressed tar file. Download details for the upgrade are emailed to all VisibleThread customers as soon as the upgrade becomes available. If you are missing details of where to retrieve an upgrade please contact our support team.

When you have downloaded your upgrade file, it needs to be added to the '/home/visiblethread/VisibleThreadTools/upgrade' folder on the VisibleThread Virtual Appliance.

Uploading the upgrade file to the Virtual Appliance

You can upload the upgrade file to the Virtual Appliance via SSH (Secure SHell) using port 22. The easiest way to do this is to use one of a number of freely available tools such as the FileZilla client ( or WinSCP ( The next section outlines the detailed steps to complete this:

  • Connect to your Virtual Appliance using the following details:
    • IP address: The IP Address of your Virtual Apppliance/VisibleThread Server.
    • username: visiblethread
    • Password: password (unless changed when completing deploying the VisibleThread server)
    • Port: 22
  • Once connected navigate to the /home/visiblethread/VisibleThreadTools/upgrade folder.
  • Upload the upgrade file to this folder.


Applying the upgrade to the Virtual Appliance

Note: Applying the upgrade will bring down the VisibleThread application for several minutes, and the VM will restart automatically once the upgrade has completed.

The VisibleThread Virtual Appliance contains an upgrade script that will perform an upgrade of the Virtual Appliance. To run this script log on to the VisibleThread Virtual Appliance console and execute the following commands. 

Note: You must be logged in as the visiblethread user when running the upgrade

$ cd /home/visiblethread/VisibleThreadTools
$ screen 
$ ./ upgrade/<upgradefilename.tar.gz>

Note: You will be prompted a number of times during the upgrade process for the "visiblethread" user password when running this command so its best not to leave the upgrade run unattended.

Running the above command will unpackage the archive, deploy the release files and migrate your existing application data to the new format. If the upgrade has been successful it will reboot the server.

If the server has not been rebooted you should type 'exit' to exit the upgrade session. 


After the upgrade has completed

Once the upgrade has completed, your VisibleThread Server should reboot automatically, after which your system should be ready for use. If does not happen please contact us at


Testing the upgrade

To verify the upgrade was performed successfully, you can check the specific version number of the release.

Point your browser at https:// <VisibleThreadServerAddress>/getVersion.jsp and verify the output contains the text:

version: "2.13"


Upgrade Troubleshooting

If the upgrade is not successful, or you run into issues applying the upgrade, please contact us at and we can arrange to have one of our technical staff run through the process with you.

If you system does not meet the minimum requirements (see pre-requisites above) you will see a message similar to the screenshot below, once again contact us at



Was this article helpful?
0 out of 0 found this helpful

Get Additional Help

Visit our Helpdesk for additional help and support.