Installing the WAR File Using js-install Scripts

Follow the steps in this procedure to install JasperReports Server using WAR file distribution. The js-install shell scripts, supported on Windows, Linux, and Mac, do most of the work for you.

Prerequisites for installing the WAR file:

1. Install the Oracle/Sun Java JDK 1.6 or 1.7. OpenJDK 1.6 has also been certified.
2. Create and set the JAVA_HOME system environment variable to point to the Java JDK location.
3. Locate or install one of the following application servers:
•      Apache Tomcat 5.5, 6, or 7
•      JBoss 5.1 or 7.1
•      Glassfish 2.1 or 3.0 using the default domain (domain1)

If you use GlassFish 3.1.0 or a custom domain, see GlassFish Modifications.

4. Locate or install the PostgreSQL or MySQL database.

The target database can be on a remote server. The application server should reside on the local machine.

If you would like to run a pre-install validation test, you can run js-install-ce.bat test or a similar command. For more information about how to perform a validation test in your environment, see js-install Script Test Mode.

To install the WAR file using js-install scripts:

The scripts are intended for the bash shell.

If installing to non-linux Unix platforms such as HP-UX, IBM AIX, FreeBSD, or Solaris the bash shell is required for using the js-install scripts.
1. Extract all files from jasperreports-server-cp-6.0-bin.zip. Choose a destination, such as C:\Jaspersoft on Windows, /home/<user> on Linux, or /Users/<user> on Mac.

The directory, jasperreports-server-cp-6.0-bin, appears in the file location you choose.

2. Copy the <database>_master.properties file for your database from sample_conf and paste it to buildomatic:
•      Copy from — <js-install>/buildomatic/sample_conf/
•      Paste to — <js-install>/buildomatic

For example, if your database is PostgreSQL, copy postgresql_master.properties to <js-install>/buildomatic.

3. Rename the file you copied to default_master.properties.
4. Edit the default_master.properties file to add the settings for your database and application server. “Sample Values for the default_master.properties File” lists sample property values for each supported database.

Sample Values for the default_master.properties File

Database

Sample Property Values

PostgreSQL

 
appServerType=tomcat6<span class="Italics"> </span>[tomcat7, tomcat5, jboss, jboss-eap-6, jboss-as-7, glassfish2, glassfish3, skipAppServerCheck]
appServerDir=c:\\Program Files\\Apache Software Foundation\\Tomcat 7
dbHost=localhost
dbUsername=postgres
dbPassword=postgres

MySQL

 
appServerType=tomcat6<span class="Italics"> </span>[tomcat7, tomcat5, jboss, jboss-eap-6, jboss-as-7, glassfish2, glassfish3, skipAppServerCheck]
appServerDir=c:\\Program Files\\Apache Software Foundation\\Tomcat 7
dbUsername=root
dbPassword=password
dbHost=localhost

Note the following:

When the property appServerType is set to skipAppServerCheck, buildomatic skips any application server validation.

Backslashes in paths must be doubled in properties files, for example appServerDir=C:\\Apache Software Foundation\\Tomcat 7.

If, under Linux, Tomcat is installed using apt-get, yum, or rpm, see Tomcat 6 Installed Using apt-get.

5. Password encryption

The default_master.properties file has a property setting to enable encryption of passwords that reside on the file system. This will apply to all files found under the buildomatic folder, as well as the connection pooling file used by Apache Tomcat (context.xml). Currently, password encryption support for connection pooling only supports the Tomcat application server.

To enable encryption on the file system, uncomment the encrypt property so that it looks like the following:

encrypt=true

For more information about the encryption functionality, refer to the JasperReports Server Administrator Guide.
6. Run the js-install scripts:
a. Start your database server.
b. Stop your application server.
c. Open Command Prompt as Administrator on Windows or open a terminal window on Linux and Mac OSX.
d. Run the js-install script:

Commands

Description

cd <js-install>/buildomatic

js-install-ce.bat (Windows)

./js-install-ce.sh (Linux and Mac OSX)

Installs JasperReports Server, sample data, and sample databases (foodmart and sugarcrm)

js-install-ce.bat minimal (Windows)

./js-install-ce.sh minimal (Linux and Mac OSX)

Installs JasperReports Server, but does not install sample data and sample databases

If you encounter errors during the js-install script execution, see Error Running js-install Scripts (js-install-ce.bat/sh).

7. Set Java JVM Options, as described in Setting JVM Options for Application Servers. This step is required.

To view the output log, look in: <js-install>/buildomatic/logs/js-install-ce-<date>.log
Version: 
v6.0.0
v6.0.1
Feedback