Installation
Setting up the Database
Cascade Server currently supports MySQL 4.1/5.0, Microsoft SQL Server 2005, and Oracle10g.
For instructions on setting up the default database for one of these vendors, click here.
Installing Cascade Server
Contact your account manager for access to the Cascade Server download site. The installer is available in a variety of formats for Microsoft Windows, Mac OS X, and Linux.
Windows Installation
Download the file cascade-{VERSION}-win.exe and double-click it to begin the installation process.
The installer is also available via a JAR package which can either be run by double-clicking the JAR file or, via the command-line with:
Mac OS X Installation
Download the the file cascade-{VERSION}-osx.jar. To start the installation double-click this file or run the command, via the Terminal:
Linux Installation
Download the file cascade-{VERSION}-linux.bin and execute the following commands:
The installer is also available via a JAR package which can be started by running:
Another option for Linux is the bash console-mode installer which can be used on installations that do not include X-Windows.
Other Operating Systems
For other operating systems, please use the manual installer which is called cascade-{VERSION}.zip. Unzip the file, skip the instructions below and follow those located in ManualConfiguration.txt.
Step 1: Cascade Server Readme
Upon opening the installer, the Readme will appear. Be sure to read this document thoroughly. Check the box that says "I have read and understand the preceding statement," and click Submit.
Step 2: Choosing an Installation Type
When installing Cascade Server, users have three choices:
- Full Cascade 5 installation - when performing a new installation and Cascade Server has not previously been installed
- Cascade 4 upgrade - when upgrading from a version of Cascade Server 4x
- Cascade 5 upgrade - when upgrading from a previous version of Cascade Server 5x (if Cascade 5x has never been installed, use the Cascade 4 upgrade option listed above)
Select the appropriate installation type and click Next to continue.
IMPORTANT NOTES:
- WHEN UPGRADING TO CASCADE 5.x FROM 4.x - After installation is complete and the server has been shut down and re-started, plug-in .jar files must be moved from the old Cascade 'Install' directory (cascade/server/default/lib) to the Tomcat deployment directory (<Tomcat_Installation_Location>/webapps/ROOT/WEB-INF/lib).
- WHEN UPGRADING TO 5.X FROM AN EARLIER VERSION OF 5.X - Plug-in .jar files must be moved from <Tomcat_Installation_Location>/webapps/ROOT/WEB-INF/lib into a temporary location because the ROOT directory will be deleted upon installation. After installation is complete and the server has been shut down and re-started, plug-in .jar files should be moved back into <Tomcat_Installation_Location>/webapps/ROOT/WEB-INF/lib.
Step 3: Cascade Configuration
During a new installation or an upgrade from Cascade Server 4, the Cascade Configuration dialog will appear.
- The Cascade installation directory is the directory into which Cascade Server 5 will be installed. In general, this should be different from the directory in which Cascade Server 4 is installed.
- When migrating settings from a previous Cascade 4 installation, choose the path to the installation directory of Cascade Server 4. Filling this option allows the installer to automatically migrate licenses and configuration files into your new installation.
- Choose the port on which to access Cascade Server 5. This is generally 8080.
- Finally, the maximum amount of memory to allocate to Cascade Server 5 must be chosen. It is highly recommended that this value be at least 512 MB.
- When installing in a Microsoft Windows environment, an option will be available to install Cascade Server 5 as a service. This will cause Cascade Server 5 to start automatically when Windows starts.
After completing the selection of Cascade options, click the Next button. Make sure there are no old versions of Cascade Server already running before continuing.
Step 4: Cascade Database Configuration
If this is a full installation or an upgrade from Cascade Server 4, the installer will move to the configuration of the Cascade Server 5 database connection.
- The database type should be set to MySQL, Microsoft SQL Server, or Oracle depending on your environment. Manual configuration is also available, but not recommended.
- The database hostname and port should be set to the hostname (followed by a colon), followed by the port number of the database server that Cascade Server 5 will use. Databases running on the same computer have a hostname of localhost and the default port number of each database vendor is automatically selected when you change the database type.
- Enter the database name and schema name (Oracle only) for the Cascade Server 5 installation. These values were determined in the section Setting up the Database.
- Select the username and password for accessing the Cascade Server 5 database.
Once the appropriate values are filled in for the Cascade Server 5 database configuration, Click Test Connection to test the configuration connectivity. If the connection is unsuccessful, ensure that the values have been entered correctly before clicking Next to continue.
Completing the Installation
After accepting the terms of the license agreement, the installation will begin. When the progress bar indicates that the installation is [Finished], click Quit.
Cascade Server 5 should now be installed.
Installing the License Key
1. Click Tools -> System -> Configuration -> Product License as seen below:
2. Enter the license key code into the Configuration Content field, then click Submit.
Changing Ports
By default, Cascade Server will attempt to listen on port 8080. If another application is already listening on this port, administrators may wish to change it so that there are no port conflicts on the system. To change ports, follow the steps below:
- Shut down Cascade Server
- Navigate to \tomcat\conf
- Edit the file server.xml (line 80):
- Change the port attribute (default is 8080) and save the file
- Restart Cascade Server
Allocating Memory for Cascade Server
Linux/*nix
- Stop Cascade Server
- Edit the file cascade.sh (found in the Cascade root directory)
- Add/Modify the -Xmx and -Xms parameters on line 2:
The line above sets the maximum java heap size to 768M. An -Xms value can also be added to specify an initial heap size.
- Restart Cascade Server
Windows (command line)
- Stop Cascade Server
- Edit the file cascade.bat (found in the Cascade root directory)
- Add/Modify the -Xmx and -Xms parameters on line 3:
The line above sets the maximum java heap size to 768M. An -Xms value can also be added to specify an initial heap size.
- Restart Cascade Server
Windows (service)
- Navigate to the \tomcat\bin directory and find the file named tomcat5w.exe
- Make a copy of this file and rename it cascadew.exe
- In the configuration UI click on the Java tab.
- Enter a value for the Initial memory pool field
- Enter a value for the Maximum memory pool field
- Click Apply
- Restart the Cascade service
Enabling SSL
- Shut down Cascade Server
- Create a keystore (from http://tomcat.apache.org/tomcat-5.5-doc/ssl-howto.html):
- Execute the following command:
Windows: %JAVA_HOME%\bin\keytool -genkey -alias tomcat -keyalg RSA
Unix: $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA
- For the password, enter “changeit”
(Windows: the .keystore file can typically be found in the Documents and Settings folder under the user's sub folder; eg, C:\Documents and Settings\Administrator)
(Linux: the .keystore file can typically be found in the home directory of the user who created it; eg, /home/user) -
Edit the file server.xml (found in \tomcat\conf)
- Uncomment the area for SSL/TLS Connector configuration
<!-- Define a SSL HTTP/1.1 Connector on port 8443 -->
<Connector port="8443" maxHttpHeaderSize="8192"
maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
enableLookups="false" disableUploadTimeout="true"
acceptCount="100" scheme="https" secure="true"
clientAuth="false" sslProtocol="TLS" /> - Start Cascade Server – it should now be accessible through https://{host}:8443
NOTE: If both the HTTP/1.1 Connector and the SSL/TLS Connector sections are left uncommented, users will still be able to access the site through port 8080. This can be changed by:
Commenting out the HTTP/1.1 Connector section in 'server.xml'
OR
Forcing Tomcat over SSL. To do this, enter the following code into 'web.xml', just before the closing </web-app> element (web.xml is located in \tomcat\conf):

