Installing Cascade Server
Starting the Installer
**Please note: A video is also available on the subject of 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
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:
java -jar cascade-{VERSION}-win.jar
Mac OS X
Download the file cascade-{VERSION}-osx.jar. To start the installation double-click this file or run the command:
java -jar cascade-{VERSION}-osx.jar
Linux
Download the file cascade-{VERSION}-linux.bin and execute the following commands:
$ chmod u+x cascade-{VERSION}-linux.bin$ ./cascade-{VERSION}-linux.bin
The installer is also available via a JAR package which can be started by running:
java -jar cascade-{VERSION}-linux.jar
Another option for Linux is the bash console-mode installer which can be used on installations that do not include X-Windows.
$ chmod u+x cascade-{VERSION}-linux.sh$ ./cascade-{VERSION}-linux.sh
Other
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.
Cascade Server Readme
Upon opening the installer, the Readme will appear. Be sure to read this document thoroughly.
CHOOSING INSTALLATION TYPE
There are three installation paths when installing Cascade Server.
- Full Cascade Installation - use this method when you are performing a new installation and have not installed Cascade Server before.
- Cascade 4 Upgrade - use this method if you are upgrading from a version of Cascade 4.
- Cascade 5 Upgrade - use this method when you are upgrading from a previous version of Cascade 5. If you have never used Cascade 5, please use the Cascade 4 Upgrade option listed above.
Select the appropriate installation type and click "Next" to continue.
***WARNING ABOUT PLUG-INS
- 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.
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, select the "Next" button. Be sure that an old version of Cascade Server is not already running before continuing.
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 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 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.
Cascade Server 5 should now be installed. Continue to Running Cascade Server.