Upgrading to Tcat Server 6 R4

Tcat Server reached its End of Life in 2017. Contact your Customer Success Manager to determine options for managing, monitoring, or deploying your application.

If you have an older version of Tcat Server installed, the new installer retains all paired servers, new web applications, user roles, server profiles, and environment variables you have saved.

If you are using a version of Tcat Server 6 earlier than R3, you need to follow the upgrade path to R3 first.


The Tcat Server 6.4.5 console is not backward-compatible with agents from older releases of Tcat. This means you must upgrade each agent webapp to the 6.4.5 release or newer before starting up the new Tcat Server console. Doing this does not require any interruption of regular web service from your Tcat or Tomcat server instances.

Follow these steps:

  1. Copy any webapps/agent/WEB-INF/truststore.jks file to a backup location.

  2. Delete the webapps/agent.war file.

  3. Wait about ten seconds and the agent automatically undeploys.

  4. Copy the new agent.war into your webapps/ directory to deploy the new copy.

  5. Move your backed-up truststore.jks back into the webapps/agent/WEB-INF directory.

Download the Tcat Server installer for Windows (.exe), Linux and Solaris (.sh), or Mac OS (.dmg) from https://www.mulesoft.com/tcat/download.

Run the Installer

  1. Run the Installer

  2. Point to the existing application install directory

  3. The installer retains all your existing settings.


After upgrading Tcat Server, and before logging into the Tcat Server console in your web browser again, make sure that you clear your browser’s file cache. Without doing clearing your browser cache, the console web application runs without incident, but the older version of Tcat’s console code that is still resident in your web browser does not match the new server side of the console, and this causes errors in the Tcat console logs, and erratic behavior in the web browser.

What the Installer Does

The Tcat Server 6 R4 installer performs the following tasks:

  1. Backs up the agent web application (copies webapp/agent to tcat-backup/agent) and unpacks the new one

  2. Backs up the console web application (copies webapp/console to tcat-backup/console) and unpacks the new one

  3. Backs up any user-modified Tomcat configuration files in the conf directory tree (copies conf to tcat-backup/conf)

  4. Preserves the old agent.properties that defines which port the agent listens on

  5. Preserves the agent truststore.jks that provides security settings associated with the agent

After the installer completes the upgrade, compare the new Tcat Server configuration files in the conf directory with the older configuration files in tcat-backup/conf to determine which of your changes you want to carry forward into the new Tcat Server configuration.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub