When you run the installation executable, you are prompted to specify information about the third party applications that JasperReports Server relies on. These third party applications are Apache Tomcat and the PostgreSQL database.
Note: when you run the installer against an existing database instance, the database must be running at install time.
To begin, run the installer on the application server host.
In Windows, the installer is an executable file that you can double-click to run. For example, double-click the following:
In Linux, the installer is a .bin file; you can run it from the command line or from a graphical environment. To start the installer from the command line, login with an account that has administrative privileges and open a bash shell. At the command line, enter the name of the installer file. For example:
Whether you run the installer from the command line or in a graphical environment, you are prompted for the same information. The following sections describe these prompts, and assume you are in a graphical environment. If you are installing from the command line, use your keyboard to specify the same details. For example, with the license text, instead of clicking I accept the agreement, you press Y and press Enter.
The first step introduces the installer and allows you to continue or exit. Click Next.
Accept License Agreement
You are prompted to read and accept the license agreement. Read the agreement, agree to the terms by clicking I accept the agreement, and click Next. On the command line, you must page through several screens of text to read the full agreement.
If you do not accept the agreement, you must exit the installer.
Installation Directory Location
You are prompted for the directory where JasperReports Server is installed referred to as the js-install directory. Accept the default or click Browse and select a different location, and click Next. On the command line, press Enter to accept the default. To choose a different directory location, enter that location at the prompt.
The default js-install directory depends on your operating system:
- Windows: C:\Program Files\JasperReports Server-pro-ver
- Linux: user_home/JasperReports Server-pro-ver
Select Tomcat Configuration
JasperReports Server requires a web application server in order to run. The JasperReports Server installer is pre-configured to run with the Apache Tomcat server. There are two options available for your Tomcat configuration.
The first option is to choose a bundled Tomcat. If you choose this option, the installer puts an instance of Tomcat 5 onto your system. Click Next. You are prompted for the server port and shutdown port that Tomcat will use. Most users accept the default values that are displayed. Accept the default values or enter alternate values and then click Next.
The second option is to choose an existing Tomcat. If you already have an instance of Tomcat on your system, then you can choose this option. Choose the existing Tomcat option and click Next. You are prompted for its location. Enter the correct location for Tomcat or click Browse to locate and select another location. Click Next. You are prompted for Tomcat's server port and shutdown port. Accept the default values or enter alternate values and then click Next.
Select PostgreSQL Configuration
JasperReports Server requires a database in order to run. The JasperReports Server installer is pre-configured to run with the PostgreSQL database. There are two options available for you PostgreSQL configuration.
The first option is to choose a bundled PostgreSQL. If you choose this option, the installer puts PostgreSQL 9 onto your system. The default PostgreSQL port 5432 will be used. If the installer finds that port 5432 is already in use, you are prompted to pick an alternate port. In this case, choose an alternative port value. The installer sets the PostgreSQL administrator password to postgres and also creates a PostgreSQL database user with administrator privileges and credentials of jasperdb/password.
The following table summarizes the parameters set during installation of the bundled PostgreSQL:
|Parameter||Default Value and Description|
|Binary Directory||The directory where the postgres and pgAdmin3 binaries are located.|
|Port||The port number that PostgreSQL uses (default is 5432). User must choose an alternate port if 5432 is in use.|
|IP or Host Name||The IP address or name of the machine where PostgreSQL is installed. The default value is 127.0.0.1.|
|PostgreSQL Administrative Password||Password of the database administrative user: postgres. The installer cannot handle special characters at the end of a password string. Incompatible characters include: & ; $|
|Database User Name||Hard coded default: jasperdb - The installer creates this user which is used to connect to the JasperReports Server database|
|Database User Password||Hard coded default: password - The installer uses this password for the jasperdb user.|
|Additional notes for Linux||If your Linux installation does not have a locale setting that supports UTF-8 encoding, your Bundled PostgreSQL instance will be initialized using a temporary locale (--locale=C). This will allow the PostgreSQL initdb to succeed with the desired UTF-8 database encoding.|
Security note: Jaspersoft recommends that you change your database user password from the default value to a new, secure value.
The second option is to choose an existing PostgreSQL. If you already have an instance of PostgreSQL running on your system, then you can choose this option. You are eventually prompted for the location of PostgreSQL and the port to use. If you have an instance of PostgreSQL installed locally, accept the default, which is 127.0.0.1, the localhost. Accept the default location for the PostgreSQL \bin directory, or click Browse to locate and select another location. You are also prompted for the default administrative account password of the PostgreSQL administrative user. The database administrative user account name postgres is used by default. Enter the database administrative user password and click Enter.
The following table summarizes the parameters set during the installation of an existing PostgreSQL:
|Defaults Used||Hardcoded Default Values Used or Created|
|PostgreSQL Administrative User Name||postgres - The default administrative database user.|
|jasperserver Database User Name||jasperdb - The installer creates this database user which is used to connect to jasperserver database.|
|jasperserver Database User Password||password - The installer creates this password for the jasperdb database user.|
Security Note: Jaspersoft recommends that you change your database user password from the default value to a new, secure value.
Install Sample Data
JasperReports Server can be installed with sample data that can help you evaluate its features. Sample data and resources included are the following:
- Sugar CRM data that simulates three years of operations for a fictitious company that relies on the SugarCRM open source application.
- Foodmart data that simulates three years of operations for a fictitious company.
- JasperReports Server repository resources such as Reports, Analysis Views, Ad Hoc Topics, Domains, Data Sources, and Input Controls.
- Jaspersoft strongly recommends that you install this data, unless you are not interested in testing or evaluating with the default sample data. Click Yes to install the sample data and click Next.
Install iReport Designer
iReport Designer is the leading GUI-based JasperReports creation tool. It has the capability of communicating directly with a JasperReports Server instance and can thus retrieve existing JasperReports from a JasperReports Server instance for editing, uploading or execution.
In the installer, iReport comes pre-configured with a plugin that allows it to communicate with JasperReports Server via the web services interface.
If you would like to install iReport click Yes.
Ready to Install
The components are now ready for installation. Click Install or Next to continue. Installation can take a number of minutes.
Installation Complete Screen
After the JasperReports Server files have been installed, you will see the final installation screen. There are several Post-Installation options that you can choose from, each with its own checkbox. Simply click to make your choices and then click Finish.
- View Release Notes - If you choose to view the Release Notes, they are displayed in an new window. If you are running from the command line, you can page through the Release Notes by pressing the Enter key.
- Launch JasperReports Server Now - If you choose to launch JasperReports Server from the installer, the installer exits and the application server starts. It takes a few moments for the server to start up. When this is complete, the JasperReports Server login page appears in your system default Browser.
Note: Starting JasperReports Server from the installer is dependent on your Tomcat and PostgreSQL configuration choices. The JasperReports Server start/stop scripts only control the bundled applications that you chose to be installed. Also, if you chose to view the Release Notes, JasperReports Server will not startup until you close the Release Notes.
- Opt-in for JasperReports Server Heartbeat.