Create the Pentaho User

Create a pentaho user account that has administrative privileges. You will use this account to complete the rest of the installation instructions.

Create an administrative user on computer that will host the DI Server and name it pentaho.

Verify that you have the appropriate permissions to read, write, and execute commands in the pentaho user's home directory.

Create Linux Directory Structure

Log into the machine on which you will run the BA Server. Make sure that you are logged in as the pentaho user.

Create this directory path from home directory (pentaho).

<your home directory>/pentaho/server/data-integration-server
<your home directory>/.pentaho

Verify that you have the appropriate permissions to read, write, and execute commands in the directories you created.

Install the Web Application Server

The DI Server can be deployed on either the Tomcat or JBoss web application server. By default, DI Server software is configured for Tomcat. This means that if you choose to use Tomcat, you will need to make fewer configuration changes than you would if you choose to use JBoss.

You must install the web application server yourself. If you already have a Tomcat or JBoss web application server installed and you want to deploy the DI Server on it, please skip this step.

To download and install the web application software, use the instructions in the documentation for the web application server of your choice. We recommend that you install the web application server in the pentaho/server/data-integration-server directory.

Verify the web application server is installed correctly by starting it and viewing the default page. If the web application server does not start, troubleshoot it using the web application server's documentation before you continue with the DI Server installation process.

Stop the web application server.

Install the DI Repository Host Database

The DI Repository houses data needed for Pentaho tools to provide scheduling and security functions. It also stores transformations and jobs. You can host the DI Repository on these databases.

Verify Directory Structure

Verify that the files have been placed in the following places by comparing the following directory structure with yours.

If your web application server is not in the pentaho/server/data-integration-server directory, the pentaho-di.war and pentaho-style.war files should appear where you've chosen to install your web application server.

Log out and in again, then verify the variables have been properly set.

Advanced Linux and Mac Topics

Complete the instructions in this section only if you have a headless node or it if you plan to install on a Mac OS.

Prepare a Headless Linux or Solaris Server

There are two headless server scenarios that require special procedures on Linux and Solaris systems. One is for a system that has no video card; the other is for a system that has a video card, but does not have an X server installed. In some situations -- particularly if your server doesn't have a video card -- you will have to perform both procedures to properly generate reports with the DI Server.

Systems without video cards

The java.awt.headless option enables systems without video output and/or human input hardware to execute operations that require them. To set this application server option when the DI Server starts, you will need to modify the startup scripts for either the DI Server, or your Java application server. You do not need to do this now, but you will near the end of these instruction when you perform the Start DI Server step. For now, add the following item to the list of CATALINA_OPTS parameters: -Djava.awt.headless=true.

If you intend to create a DI Server service control script, you must add this parameter to that script's CATALINA_OPTS line.

Note: If you do not have an X server installed, you must also follow the below instructions.

Systems without X11

To generate charts, the Pentaho Reporting engine requires functionality found in X11. If you are unwilling or unable to install an X server, you can install the xvfb package instead. xvfb provides X11 framebuffer emulation, which performs all graphical operations in memory instead of sending them to the screen.

Use your operating system's package manager to properly install xvfb.

Adjust Amount of Memory Mac OS Allocates for PostgreSQL

If you plan to install the software on a Mac OS, and you choose to use PostgreSQL, you need to increase the amount of memory that the Mac OS allocates for PostgreSQL. You can skip these instructions if you plan to install the software on Windows or Linux.

PostgreSQL is the name of the default database that contains audit, schedule and other data that you create. PostgreSQL starts successfully only if your computer has allocated enough memory. Go to http://www.postgresql.org/docs/devel/static/kernel-resources.html and follow the instructions there on how to adjust the memory settings on your computer.