Installation
Windows
Installing Cascade Server
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 Full Cascade Installation (If upgrading, please see the Upgrade section). A Full Cascade Installation will instruct the installer to install a fresh instance of Cascade Server on the machine.
- Click Next.
Step 3: Cascade Configuration
- Fill in (or browse to) the Cascade installation directory. Cascade Server will install to C:\Program Files\Cascade Server by default.
- 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
- Select the Database type which will be used (MySQL, Microsoft SQL Server, or Oracle). Selecting Manual Configuration allows for configuring the database connection after the Cascade Server installation.
- Fill in the Database hostname:port field with the hostname and port of the database server that Cascade will use.
- Enter the Database name to which Cascade Server will connect. For Oracle, also fill out the Schema name and Oracle SID fields. In most cases, the Database name and Schema name should be the same.
- Fill in the Username and Password fields for accessing the Cascade Server database. For Oracle, the Username must match the Schema name in versions 6.4 and later.
- *Optional: Click the Test Connection button to test the connection to the database using the specified credentials.
- Click Next.
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 2/2.
- Click Quit.
Uninstalling Cascade Server
Double-click the uninstaller.jar file located in C:\Program Files\Cascade Server\Uninstaller to begin uninstalling Cascade Server.
Alternatively, the JAR package can be run by executing the following (from a command line):
java -jar uninstaller.jar
- Check the box labeled Force the deletion of C:\Program Files\Cascade Server.
- Click Uninstall.
- When the progress bar displays [Finished], click Quit.
Installing/Removing the Cascade Server Windows Service (32-bit)
While the installers provide a way to automatically install Cascade Server as a Windows Service, it is also possible to do so via the command line.
Installing the Service:
- Open a command prompt
- Navigate to \tomcat\bin within the Cascade Server installation directory
- Type service install cascade
Example:
C:\Program Files\Cascade Server\tomcat\bin>service install cascade
A successful Service installation will output a message similar to the following:
Installing the service 'cascade' ...
Using CATALINA_HOME: C:\Program Files\Cascade Server\tomcat
Using CATALINA_BASE: C:\Program Files\Cascade Server\tomcat
Using JAVA_HOME: C:\Program Files\Cascade Server\jre
Using JVM: C:\Program Files\Cascade Server\jre\bin\client\jvm.dll
The service 'cascade' has been installed.
Removing the Service:
- Open a command prompt
- Navigate to \tomcat\bin within the Cascade Server installation directory
- Type service remove cascade
Example:
C:\Program Files\Cascade Server\tomcat\bin>service remove cascade
A successful Service removal will output a message similar to the following:
[SC] DeleteService SUCCESS
The service 'cascade' has been removed
Installing/Removing Cascade Server 6.10 and Higher as a Windows Service (64-bit)
Pre-requisites:
- The application server must be running on a 64-bit version of Windows.
- Cascade Server must be version 6.10+.
Step 1: Install a 64-bit JVM
- Download the Windows x64 JRE (Java 5 or Java 6) from the Oracle web site
- Install the Windows x64 JRE
Step 2: Install Cascade Server
- Perform a Full Installation of Cascade Server
- Be sure to check the option to Start Cascade Server Automatically on boot (step 3)
Step 3: Download 64-bit Tomcat
- Download the 64-bit Windows zip file for Tomcat
- Unzip the file into a temporary location
Step 4: Copy service files
- Copy the following files from the extracted Tomcat archive:
- bin\tcnative-1.dll
- bin\tomcat6.exe
- bin\tomcat6w.exe
- Paste all 3 files from above into your Cascade Server installation directory under tomcat\bin (be sure to overwrite the existing files!)
Step 5: Configure the service
- Navigate to the \tomcat\bin directory inside the Cascade Server installation folder and find the file named tomcat6w.exe
- Make a copy of this file and rename it cascadew.exe
- Double-click the file cascadew.exe
- In the configuration UI click on the Java tab
- In the Java Virtual Machine field, select jvm.dll from the 64-bit JRE that was installed in Step 1 (located in bin/server in the Java installation directory)
- In the Java Options field, add the following value on a new line: -XX:MaxPermSize=192m
- Enter a value for the Initial memory pool field
- Enter a value for the Maximum memory pool field
- Click Apply, then click OK
Removing the Service:
- Open a command prompt
- Navigate to \tomcat\bin within the Cascade Server installation directory
- Type service remove cascade
Example:
C:\Program Files\Cascade Server\tomcat\bin>service remove cascade
A successful Service removal will output a message similar to the following:
[SC] DeleteService SUCCESS
The service 'cascade' has been removed
Running Cascade Server
Cascade Server can be started as a Windows Service or via the command line.
Windows Service:
- Click the Windows Start menu
- Click Run (or place cursor in the Run textbox)
- Type services.msc
- Click on the Cascade Server service
- Click the Start Service button (as an alternative, right-click the Cascade Server service then click Start)
Command Line:
- Navigate to the Cascade Server installation directory
- Enter cascade.bat start
Example:
C:\Program Files\Cascade Server>cascade.bat start
Linux
Installing Cascade Server (Automatic)
The JAR package can be run by executing the following (from the Terminal):
java -jar cascade-{VERSION}-linux.jar
The Binary package can be run by executing the following (from the Terminal):
./cascade-{VERSION}-linux.bin
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 Full Cascade Installation (If upgrading, please see the Upgrade section). A Full Cascade Installation will instruct the installer to install a fresh instance of Cascade Server on the machine.
- Click Next.
Step 3: Cascade Configuration
- Fill in (or browse to) the Cascade installation directory. Cascade Server will install to /home/user/Cascade Server by default.
- 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
- Select the Database type which will be used (MySQL, Microsoft SQL Server, or Oracle). Selecting Manual Configuration allows for configuring the database connection after the Cascade Server installation.
- Fill in the Database hostname:port field with the hostname and port of the database server that Cascade will use.
- Enter the Database name to which Cascade Server will connect. For Oracle, also fill out the Schema name and Oracle SID fields. In most cases, the Database name and Schema name should be the same.
- Fill in the Username and Password fields for accessing the Cascade Server database. For Oracle, the Username must match the Schema name in versions 6.4 and later.
- *Optional: Click the Test Connection button to test the connection to the database using the specified credentials.
- Click Next.
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 2/2.
- Click Quit.
Installing Cascade Server (Manual)
The .ZIP package can be installed and configured by following the steps below:
Step 1: Unzip the File
Unzip the file with a command similar to the following (from the Terminal):
unzip cascade-{VERSION}.zip
Step 2: Edit cascade.sh File
- Edit the cascade.sh file and replace @{cascadeJRE} with the absolute path to the Java runtime folder which contains the bin sub-folder. Example:
/usr/local/jdk1.5
- Specify the maximum amount of memory available to Cascade Server by replacing the string @{cascadeMemory} with a string of the form -Xmx512M (where 512 is the size of the memory in megabytes).
Step 3: Edit the context.xml File
- Edit tomcat/conf/context.xml and remove the first line containing @{dbConf}.
- Uncomment the appropriate configuration for your database vendor.
- Replace the following strings as specified:
- @{dbusername} - the username for accessing your database. For Oracle, the username needs to be the same as the schema for versions of Cascade 6.4 and later.
- @{dbpassword} - the password for accessing your database
- @{dbhostport} - the hostname and port separated by a colon (e.g. localhost:3306)
- @{dbname} - the name of the database to use
- @{dbsid} - the SID of the Oracle database server (Oracle only)
Step 4: Edit the server.xml File
Replace the following strings as specified:
- @{dbschema} - the schema name of the database. Oracle only; leave empty - value="" - if using MySQL or SQL Server.
- @{cascadePort} - the HTTP port on which Cascade Server will run (e.g. 8080)
Uninstalling Cascade Server
Executing the following (from the Terminal):
java -jar uninstaller.jar
- Check the box labeled Force the deletion of /home/user/Cascade Server
- Click Uninstall.
- When the progress bar displays [Finished], click Quit.
Running Cascade Server
Via the Terminal:
- Navigate to the Cascade Server installation directory (e.g. /home/user/Cascade Server)
- Enter ./cascade.sh start
Mac OS X
Installing Cascade Server
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}-osx.jar
Step 1: Cascade Server Readme
- Read the statement.
- Click Next.
Step 2: Select Installation Type
- Select Full Cascade Installation (If upgrading, please see the Upgrade section). A Full Cascade Installation will instruct the installer to install a fresh instance of Cascade Server on the machine.
- Click Next.
Step 3: Cascade Configuration
- Fill in (or browse to) the Cascade installation directory. Cascade Server will install to /Applications/Cascade Server by default.
- 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
- Select the Database type which will be used (MySQL, Microsoft SQL Server, or Oracle). Selecting Manual Configuration allows for configuring the database connection after the Cascade Server installation.
- Fill in the Database hostname:port field with the hostname and port of the database server that Cascade will use.
- Enter the Database name to which Cascade Server will connect. For Oracle, also fill out the Schema name and Oracle SID fields. In most cases, the Database name and Schema name should be the same.
- Fill in the Username and Password fields for accessing the Cascade Server database. For Oracle, the Username must match the Schema name in versions 6.4 and later.
- *Optional: Click the Test Connection button to test the connection to the database using the specified credentials.
- Click Next.
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 2/2.
- Click Quit.
NOTE: After the installation, the following commands must be executed via the Terminal to fix an incompatibility with Apple's JVM and Xalan extensions:
sudo mv /System/Library/Frameworks/JavaVM.framework/Versions/1.5.0/Classes/.compatibility/14compatibility.jar /System/Library/Frameworks/JavaVM.framework/14compatibility.jar150
sudo mv /System/Library/Frameworks/JavaVM.framework/Versions/A/Resources/.compatibility/14compatibility.jar /System/Library/Frameworks/JavaVM.framework/14compatibility.jarA
Uninstalling Cascade Server
Double-click the uninstaller.jar file located in /Applications/Cascade Server/Uninstaller to begin uninstalling Cascade Server.
Alternatively, the JAR package can be run by executing the following (from a command line):
java -jar uninstaller.jar
- Check the box labeled Force the deletion of /Applications/Cascade Server.
- Click Uninstall.
- When the progress bar displays [Finished], click Quit.
Running Cascade Server
Via the Terminal:
- Navigate to the Cascade Server installation directory
- Enter ./cascade.sh start
Example:
/Applications/Cascade Server user$ ./cascade.sh start