Upgrading
Windows
Upgrading Cascade Server
Select one of the methods below to upgrade Cascade Server:
Method 1: Windows (.EXE) or Windows (.JAR)
Copy any custom plug-ins (Publish Triggers, Custom Authentication Modules, Asset Factory Plugins, Workflow Triggers) from the \tomcat\webapps\ROOT\WEB-INF\lib directory into a temporary location.
Double-click the cascade-{version}-win.exe or cascade-{version}-win.jar file to begin the installation.
Alternatively, the JAR package can be run by executing the following (from a command line):
java -jar cascade-{VERSION}-win.jar
Step 1: Cascade Server Readme
- Read the statement
- Check the box labeled I have read and understand the preceding statement
- Click Next
Step 2: Select Installation Type
- Select Upgrade from Cascade 5.5 or later. Choosing this option will instruct the installer to perform an upgrade of an existing Cascade Server installation.
- Click Next.
Step 3: Cascade Configuration
- Fill in (or browse to) the Cascade installation directory. If the current installation directory is selected, the installer will upgrade the instance at that location. Otherwise, the application will be installed to the new location specified in this field. If upgrading to a new location, click the Browse button next to the Migrate settings from a previous Cascade installation directory field and provide the location of the old installation (ex. C:\Program Files\Cascade Server). This will ensure that all of the necessary configuration files are copied from the old instance to the new location.
- In the Run Cascade Server on port field, enter the port on which Cascade Server will be accessed. The default port is 8080.
- Fill in the Maximum amount of memory Cascade can use (in MB) field. The default setting is 512.
- Choose whether or not to Start Cascade Server Automatically on boot. Selecting this option will install Cascade Server as a Windows Service.
- Click Next.
Step 4: Cascade Database Configuration
(skipped during the Upgrade process)
Step 5: Cascade Server License Agreement
- Read the License Agreement.
- Select I accept the terms of this license agreement (selecting I do not accept the terms of this license agreement will halt the installation).
- Click Next.
Step 6: Installation
- Wait for Pack installation progress bar to display [Finished] and Overall installation progress to display 1/1.
- Click Quit.
Start the Cascade Server process and wait until the login screen can be reached via a browser. Stop Cascade Server once again, then copy all custom plug-ins (Publish Triggers, Custom Authentication Modules, Asset Factory Plugins, Workflow Triggers) from the temporary storage location back into \tomcat\webapps\ROOT\WEB-INF\lib. Start Cascade Server, then log in to verify that it has been upgraded by visiting Help->About.
Method 2: ROOT.war
- Stop Cascade Server.
- Copy any custom plug-ins (Publish Triggers, Custom Authentication Modules, Asset Factory Plugins, Workflow Triggers) from the \tomcat\webapps\ROOT\WEB-INF\lib directory into a temporary location.
- Delete the following files/folders:
- \tomcat\webapps\ROOT
- \tomcat\webapps\ROOT.war
- \tomcat\work
- Delete all files within the \tomcat\temp directory
- Place the new ROOT.war file into the \tomcat\webapps directory
- Verify that the -XX:MaxPermSize variable is set to 192M as mentioned here.
- Start the Cascade Server process and wait until the login screen can be reached via a browser.
- Stop Cascade Server once again, then copy all custom plug-ins (Publish Triggers, Custom Authentication Modules, Asset Factory Plugins, Workflow Triggers) from the temporary storage location back into \tomcat\webapps\ROOT\WEB-INF\lib.
- Start Cascade Server.
- Log in to verify that the software has been upgraded by visiting Help->About.
Linux/Unix
Upgrading Cascade Server
Select one of the methods below to upgrade Cascade Server:
Method 1: Linux (.JAR)
Copy any custom plug-ins (Publish Triggers, Custom Authentication Modules, Asset Factory Plugins, Workflow Triggers) from the \tomcat\webapps\ROOT\WEB-INF\lib directory into a temporary location.
Execute the following (from the Terminal):
java -jar cascade-{VERSION}-linux.jar
Step 1: Cascade Server Readme
- Read the statement
- Check the box labeled I have read and understand the preceding statement
- Click Next
Step 2: Select Installation Type
- Select Upgrade from Cascade 5.5 or later. Choosing this option will instruct the installer to perform an upgrade of an existing Cascade Server installation.
- Click Next.
Step 3: Cascade Configuration
- Fill in (or browse to) the Cascade installation directory. If the current installation directory is selected, the installer will upgrade the instance at that location. Otherwise, the application will be installed to the new location specified in this field. If upgrading to a new location, click the Browse button next to the Migrate settings from a previous Cascade installation directory field and provide the location of the old installation (ex. /home/user/Cascade Server). This will ensure that all of the necessary configuration files are copied from the old instance to the new location.
- In the Run Cascade Server on port field, enter the port on which Cascade Server will be accessed. The default port is 8080.
- Fill in the Maximum amount of memory Cascade can use (in MB) field. The default setting is 512.
- Click Next.
Step 4: Cascade Database Configuration
(skipped during the Upgrade process)
Step 5: Cascade Server License Agreement
- Read the License Agreement.
- Select I accept the terms of this license agreement (selecting I do not accept the terms of this license agreement will halt the installation).
- Click Next.
Step 6: Installation
- Wait for Pack installation progress bar to display [Finished] and Overall installation progress to display 1/1.
- Click Quit.
Start the Cascade Server process and wait until the login screen can be reached via a browser. Stop Cascade Server once again, then copy all custom plug-ins (Publish Triggers, Custom Authentication Modules, Asset Factory Plugins, Workflow Triggers) from the temporary storage location back into \tomcat\webapps\ROOT\WEB-INF\lib. Start Cascade Server, then log in to verify that it has been upgraded by visiting Help->About.
Method 2: ROOT.war
- Stop Cascade Server.
- Copy any custom plug-ins (Publish Triggers, Custom Authentication Modules, Asset Factory Plugins, Workflow Triggers) from the \tomcat\webapps\ROOT\WEB-INF\lib directory into a temporary location.
- Delete the following files/folders:
- \tomcat\webapps\ROOT
- \tomcat\webapps\ROOT.war
- \tomcat\work
- Delete all files within the \tomcat\temp directory
- Place the new ROOT.war file into the \tomcat\webapps directory
- Verify that the -XX:MaxPermSize variable is set to 192M as mentioned here.
- Start the Cascade Server process and wait until the login screen can be reached via a browser.
- Stop Cascade Server once again, then copy all custom plug-ins (Publish Triggers, Custom Authentication Modules, Asset Factory Plugins, Workflow Triggers) from the temporary storage location back into \tomcat\webapps\ROOT\WEB-INF\lib.
- Start Cascade Server.
- Log in to verify that the software has been upgraded by visiting Help->About.
Mac OSX
Upgrading Cascade Server
Select one of the methods below to upgrade Cascade Server:
Method 1: Mac OS X (.JAR)
Copy any custom plug-ins (Publish Triggers, Custom Authentication Modules, Asset Factory Plugins, Workflow Triggers) from the \tomcat\webapps\ROOT\WEB-INF\lib directory into a temporary location.
Double-click the cascade-{version}-osx.jar file to begin the installation.
Alternatively, the JAR package can be run by executing the following (from a command line):
java -jar cascade-{VERSION}-win.jar
Step 1: Cascade Server Readme
- Read the statement
- Click Next
Step 2: Select Installation Type
- Select Upgrade from Cascade 5.5 or later. Choosing this option will instruct the installer to perform an upgrade of an existing Cascade Server installation.
- Click Next.
Step 3: Cascade Configuration
- Fill in (or browse to) the Cascade installation directory. If the current installation directory is selected, the installer will upgrade the instance at that location. Otherwise, the application will be installed to the new location specified in this field. If upgrading to a new location, click the Browse button next to the Migrate settings from a previous Cascade installation directory field and provide the location of the old installation (ex. /Applications/Cascade Server). This will ensure that all of the necessary configuration files are copied from the old instance to the new location.
- In the Run Cascade Server on port field, enter the port on which Cascade Server will be accessed. The default port is 8080.
- Fill in the Maximum amount of memory Cascade can use (in MB) field. The default setting is 512.
- Click Next.
Step 4: Cascade Database Configuration
(skipped during the Upgrade process)
Step 5: Cascade Server License Agreement
- Read the License Agreement.
- Select I accept the terms of this license agreement (selecting I do not accept the terms of this license agreement will halt the installation).
- Click Next.
Step 6: Installation
- Wait for Pack installation progress bar to display [Finished] and Overall installation progress to display 1/1.
- Click Quit.
Start the Cascade Server process and wait until the login screen can be reached via a browser. Stop Cascade Server once again, then copy all custom plug-ins (Publish Triggers, Custom Authentication Modules, Asset Factory Plugins, Workflow Triggers) from the temporary storage location back into \tomcat\webapps\ROOT\WEB-INF\lib. Start Cascade Server, then log in to verify that it has been upgraded by visiting Help->About.
Method 2: ROOT.war
- Stop Cascade Server.
- Copy any custom plug-ins (Publish Triggers, Custom Authentication Modules, Asset Factory Plugins, Workflow Triggers) from the \tomcat\webapps\ROOT\WEB-INF\lib directory into a temporary location.
- Delete the following files/folders:
- \tomcat\webapps\ROOT
- \tomcat\webapps\ROOT.war
- \tomcat\work
- Delete all files within the \tomcat\temp directory
- Place the new ROOT.war file into the \tomcat\webapps directory
- Verify that the -XX:MaxPermSize variable is set to 192M as mentioned here.
- Start the Cascade Server process and wait until the login screen can be reached via a browser.
- Stop Cascade Server once again, then copy all custom plug-ins (Publish Triggers, Custom Authentication Modules, Asset Factory Plugins, Workflow Triggers) from the temporary storage location back into \tomcat\webapps\ROOT\WEB-INF\lib.
- Start Cascade Server.
- Log in to verify that the software has been upgraded by visiting Help->About.