Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Warning |
---|
The instructions below are for upgrading to version 2.8.5.1, not 2.8.5. If you downloaded the 2.8.5 artifact prior to January 7, 2022 (the existing ThreadFix-2.8.5.zip file now contains the 2.8.5.1 artifact), please re-download it and proceed with the instructions below. Contact support@threadfix.it if you need the download link or have questions. |
📙 You will learn
How to upgrade from 2.8.3 to 2.8.5.1
Prerequisites
Audience: IT Professional and/or End User
Difficulty: Advanced
Time needed: Approximately 60 minutes
Tools required: Tomcat, MySQL or MS SQL Server
Note |
---|
ALWAYS PERFORM A FULL BACKUP OF YOUR DATABASE BEFORE ATTEMPTING ANY UPGRADE! MySQL Server: You can run the MS SQL Server: Using SSMS, right-click on the database, select Tasks → Back Up…, then choose the location & name of the backup file and click OK. |
If you have any questions or concerns or if you wish to upgrade from an older version of ThreadFix, please reach out to our support team here: support@threadfix.it
ThreadFix Deployment Update
Follow these steps to deploy the updated version of ThreadFix:
Stop the Tomcat instance on which ThreadFix is running.
Move your current ThreadFix deployment directory from your Tomcat webapps folder into a backup directory.
webapps directory location: //TOMCAT_HOME/webapps
Copy the updated ThreadFix folder from your new artifact into your webapps directory.
webapps directory location: //TOMCAT_HOME/webapps
Copy the following files from your backed up ThreadFix directory to the newly updated ThreadFix directory:
(FROM: <previous-threadfix-deploy>/WEB-INF/classes/, TO: <new-threadfix-deploy>/WEB-INF/classes/, except as noted below)custom.properties
ESAPI.properties (See REQUIRED update below)
Be sure that
Log4jfactory
is no longer referenced as theESAPI.Logger
in yourESAPI.properties
.Replace with
ESAPI.Logger=com.denimgroup.threadfix.logging.esapi.slf4j.CustomESAPISlf4jLogFactory
in your upgraded ThreadFix 2.8.5.1 instance.
jdbc.properties
jms.properties
threadfix.license
If you've updated any of these in your previous deployment, copy them as well:
<threadfix-deploy>/WEB-INF/security.xml (See REQUIRED update below)
Replace bean definition in
security.xml
file:<bean id="velocityEngine" class="org.springframework.security.saml.util.VelocityFactory" factory-method="getEngine"/>
With:
<bean id="velocityEngine" class="com.denimgroup.threadfix.service.saml.CustomSamlVelocityFactory" factory-method="getEngine"/>
<threadfix-deploy>/WEB-INF/classes/security/samlKeystore.jks (and/or any other Java keystore that you've saved in this directory)
Note: Do not copy log4j.xml. As of version 2.8.5.1, log4j.xml was replaced with logback.xml, so there’s no need to copy log4j.xml from your previous artifact.
Any changes that you had made in log4j.xml will need to be made in logback.xml if you want them to persist.
Copy the velocityTemplates directory from your backed up ThreadFix directory to the newly-updated ThreadFix directory.
(FROM: <previous-threadfix-deploy> TO:<new-threadfix-deploy>)In Linux environments, you may need to grant your tomcat user/group ownership and permissions to the newly-deployed artifact.
Examples:Code Block sudo chown -R tomcat:tomcat /opt/tomcat sudo chmod -R 775 /opt/tomcat
Cleanup - Delete the following:
The contents of the <tomcat-deploy>/work directory
Your web browser's cache/history
Before-Restart Database Updates
Database Updates
Note |
---|
Do Not Restart Tomcat If Scripts Do Not Complete If you receive an error when running before-restart database update scripts, please report the issue to Denim Group (create a ticket in Service Desk), including a screenshot of the script & error message. You should NOT proceed to start Tomcat until the issue is resolved. If you do, Hibernate may make unrecoverable changes that will require you to restore your database from backup. Caution/warning messages are OK; just not errors. |
Expand the MySQL or MS SQL Server code block to reveal the scripts:
Expand | |||||
---|---|---|---|---|---|
| |||||
| |||||
Expand | |||||
| |||||
|
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Tip |
---|
Tip
|
Start Tomcat/ThreadFix
Restart Tomcat/ThreadFix.
Navigate to the login page to ensure that it loads as expected, no need to log in at this time; wait until after completing the next section.
Note |
---|
When launching the new deployment for the first time after deploying the update, ThreadFix may take a few minutes to make necessary schema updates, so there may be a delay in accessing the login page. Monitor the <tomcat-deploy>/logs/threadfix.log file to determine when it has finished...look for the second instance of the following event: Please do not interrupt this process by stopping Tomcat. |
After-Restart Database Updates
Note |
---|
REQUIRED - Database User Account Permissions Ensure that the database user account configured in your jdbc.properties for ThreadFix has appropriate permissions to:
Between versions, ThreadFix may need updates to your schema, and most of those will be handled seamlessly by Hibernate when you first startup the new version. For the remainder, explicit update scripts are detailed below. |
Info |
---|
Restart Tomcat Before Running Database Update Scripts Only run the following scripts after you have successfully loaded the ThreadFix login page. If it fails to load, check the catalina and threadfix log files. For troubleshooting assistance, email support@threadfix.it and provide these log files. |
Database Updates
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | |||||
---|---|---|---|---|---|
| |||||
|
You may now log in to ThreadFix and verify that the new version is installed; the version is included in the page footer after logging in.
Table of Contents
Table of Contents | ||
---|---|---|
|