Skip to main content
Pentaho Documentation

Install Pentaho Products Using the Installation Wizard

Perform the following instructions to use the Pentaho Business Analytics Installation Wizard to install Pentaho products, which include the BA components, DI components, the Tomcat web application server, and PostgreSQL, which is the default database that houses the Pentaho Repositories. The Pentaho Repositories contain auditing, scheduling, and solutions content.

After you download the software and start the Pentaho Business Analytics Installation Wizard, you can choose one of two ways to install Pentaho components:

  • Default: Select the Keep it simple. Give me everything. option in the installation wizard.
  • Custom: Select the Let me decide for myself. option in the installation wizard.

To learn more about these two options, see the Pentaho Installation Wizard Overview.

Process Overview

Installation instructions are the same for the Windows, Linux, and Mac platforms.

  1. Download the software.
  2. Start the installation wizard.
  3. Choose the default installation or custom installation method.
  4. Verify your installation.

Both installation methods will take approximately 30 minutes to complete.

Download the Software

To download the software, complete these steps.

  1. Make sure that you are logged on to the computer on which you want to install the software. You should be logged on with an account that allows you to install software. On Windows, this is typically an account that has administrator privileges. On Linux, this is also an account that has administrator privileges, such as the pentaho account that you created during the previous step.
  2. Download the correct installation wizard's file for your operating system.
    • Windows: pentaho-business-analytics-7.0-x64.exe
    • Linux: pentaho-business-analytics-7.0-x64.bin
    • Mac: pentaho-business-analytics-7.0-x64.app.tar.gz
  3. If you are using Linux, make sure that you have the appropriate permission to execute the file. Open a Terminal window, navigate to the directory where you just downloaded the file, then enter the following at the prompt.
    chmod a+x ./pentaho-business-analytics-7.0.0-x64.bin

Start the Pentaho Business Analytics Installation Wizard

To start the installation wizard, complete the following steps.

Launch the installation wizard from a locally mounted hard drive only. Network-mounted drives (e.g. NFS or Netbeui) are not supported for performance reasons.

Do one of the following.

  • If you are using Windows: Open Windows Explorer and navigate to the installation file you just downloaded. Double-click the pentaho-business-analytics-7.0-x64.exefile to launch it.
  • If you are using Mac: Unpack the pentaho-business-analytics-7.0-x64.app.tar.gz archive, then double-click the pentaho-business-analytics-7.0-x64.app installation app.
  • If you are using Linux and your computer can display graphics: Open a Terminal window and navigate to the installation file you just downloaded. Enter this command at the prompt, then press Enter.
    ./pentaho-business-analytics-7.0.0-x64.bin
  • If you are using Linux and your computer cannot display graphics: open a Terminal window and navigate to the installation file you just downloaded. At the prompt enter one of these commands, then press Enter. Enter this command if you have GTK libraries on your system and want to use the GTK Toolkit:
    ./pentaho-business-analytics-7.0.0-x64.bin --mode text
    Enter this command if you do not have GTK libraries on your system or if you want to use OpenMotif instead:
    ./pentaho-business-analytics-7.0.0-x64.bin --mode xwindow

Default Installation

If you choose the Keep it simple. Give me everything. installation method, complete the following steps.  If you want to install using a custom method, read the Custom Installation instructions.

You cannot install into a directory that already exists. If you try, you will get an error message. If you are using Linux, we do not recommend that you install the software in the /opt/ directory. The complicated permissions requirements and general isolation from the rest of the system can cause unintended issues to arise if the software is installed there.

  1. After you start the installation wizard, the Pentaho Business Analytics Installation Wizard splash screen appears, then the Pentaho Business Analytics installation is ready! window. Click Next.
  2. Read the license agreement. Click Accept, then click Next to continue.
  3. Select the Keep it simple. Give me everything. option in the Setup Type window, and then click Next.
  4. In the Installation folder window, accept the default directory or choose a different directory by entering the path in the Location text box where you want to install the software. Click Next.
  5. If you selected to install the Pentaho Server, you will be prompted to add a Postgres SQL password. Enter and confirm the password you want to assign to the 'postgres' user who is assigned admin privileges for the PostgreSQL database. 

Do not use these characters in the Password field because the installation wizard cannot process them:  

' " & < > \
  1. Click Next to continue. In the Sample Database window that appears, enter a port number in the Port field to use for the database which will house sample content. 
  2. Click Next to continue. The Ready to Install window appears.
  3. Click the Next button to install the software. The Installation in Progress window appears. The software takes approximately 30 minutes to install.

An error occurs if Pentaho Server port numbers (8080, 9092, 8443, 9443, and 5432) are not available on your system and if the additional ports that the installer has tried are not available. If the installer cannot find an available port, you are prompted to enter port numbers you want to use.

  1. When installation is complete, the final window appears.  Select the Pentaho User Console and Pentaho Data Integration check boxes to launch the Pentaho User Console and Pentaho Data Integration (PDI).
  2. Click Finish to end the process.

If you have trouble with the installation wizard, check the Troubleshooting documentation. Once the installation is complete, the Pentaho Server will run with the default parameters. Terminal windows might remain open after installation. If you close them, the Pentaho Server stops. On Windows, the Pentaho Server is installed as a system service, meaning that it starts when you start your computer and stops when you shut down your computer. The User Console, Spoon, and other tools must be manually run. In the next step of these instructions there are links to documentation which explains how to start and stop servers manually.

Custom Installation

If you choose the Let me decide for myself. installation method, complete the following steps.  If you want to install using the default method, read the Default Installation instructions.

You cannot install into a directory that already exists. If you try, you will get an error message. If you are using Linux, we do not recommend that you install the software in the /opt/ directory. The complicated permissions requirements and general isolation from the rest of the system can cause unintended issues to arise if the software is installed there.

  1. After you start the installation wizard, the Pentaho Business Analytics Installation Wizard splash screen appears, then the Pentaho Business Analytics installation is ready! window. Click Next.
  2. Read the license agreement. Click Accept, then click Next to continue.
  3. Select the Let me decide for myself option in the Setup Type window, and then click Next.
  4. In the Pentaho Applications window, select the Pentaho components that you want to install in the Install Set panel. When finished, click Next.
  5. If you selected to install the Pentaho Server, then the Sample Content window appears. Sample content includes users, reports, dashboards, and analysis views which can be useful when evaluating the product. Select the Sure, give me sample content option to include this sample content with your installation, or select the No thanks, I'll create my own option to exclude this sample content. When finished, click Next.
  6. In the Installation folder window, accept the default directory or choose a different directory by entering the path in the Location text box where you want to install the software. Click Next.
  7. If you selected to install the Pentaho Server, you will be prompted to add a Postgres SQL password. Enter and confirm the password you want to assign to the 'postgres' user who is assigned admin privileges for the PostgreSQL database. 

Do not use these characters in the Password field because the installation wizard cannot process them: 

' " & < > \
  1. Click Next to continue. In the Sample Database window that appears, enter a port number in the Port field to use for the database which will house sample content. 
  2. Click Next to continue. The Ready to Install window appears.
  3. Click the Next button to install the software. The Installation in Progress window appears. The software takes approximately 30 minutes to install.

An error occurs if Pentaho Server port numbers (8080, 90928443, 9443, and 5432) are not available on your system and if the additional ports that the installer has tried are not available. If the installer cannot find an available port, you are prompted to enter port numbers you want to use.

  1. When installation is complete, the final window appears.  Select the Pentaho User Console and Pentaho Data Integration check boxes to launch the Pentaho User Console and Pentaho Data Integration (PDI).
  2. Click Finish to end the process.

If you have trouble with the installer, check the Troubleshooting documentation. Once the installation is complete, the Pentaho Server will run with the default parameters. Terminal windows might remain open after installation. If you close them, the Pentaho Server stops. On Windows, the Pentaho Server is installed as a system service, meaning that it starts when you start your computer and stops when you shut down your computer. The User Console, Spoon, and other tools must be manually run. In the next step of these instructions there are links to documentation that explains how to start and stop servers manually.

Verify Installation

To verify that the Pentaho products installed properly, review the software directory structure and the installation summary file.

  1. Open a file explorer window such as Windows Explorer or a command line tool such as the Command Prompt or Terminal windows.
  2. Navigate to the directory where you installed the software, then compare this directory structure with yours. If you installed the all components, the structure should look like this.
    pentaho/
    pentaho/design-tools/
    pentaho/design-tools/aggregation-designer/
    pentaho/design-tools/data-integration/
    pentaho/design-tools/metadata-editor/
    pentaho/design-tools/report-designer/
    pentaho/design-tools/schema-workbench/
    pentaho/documentation/
    pentaho/java/
    pentaho/jdbc-distribution/
    pentaho/license-installer/
    pentaho/licenses/
    pentaho/monetdb/
    pentaho/postgresql/
    pentaho/scripts/
    pentaho/server/
    pentaho/server/pentaho-server/
    pentaho/server/pentaho-server/licenses/
    pentaho/server/pentaho-server/logs/
    pentaho/server/pentaho-server/pentaho-solutions/
    pentaho/server/pentaho-server/third-party-tools/
    pentaho/server/pentaho-server/tomcat/
    pentaho/server/pentaho-server/wkhtmltoimage/
    pentaho/server/hsql-sample-database
  3. Open the installation-summary.txt file. Make sure that the design tools and plugins that you installed are listed.
  4. Review the following locations of files and directories before going to the next step.

Top-level directories and files

File Description

ctlscript.sh

Starts, stops, restarts, and shows the status of Pentaho services. Available on Linux and Mac only.
installation-summary.txt Contains the information from the summary screen at the end of the installation process.
uninstall A script that removes Pentaho Business Analytics.

Locations of specific programs

Tool/Plugin Location
Pentaho Server

pentaho/server/pentaho-server/

Report Designer pentaho/design-tools/report-designer/
Schema Workbench pentaho/design-tools/schema-workbench/
Data Integration (Spoon) pentaho/design-tools/data-integration/
Metadata Editor pentaho/design-tools/metadata-editor/
Aggregation Designer pentaho/design-tools/aggregation-designer/
Dashboard Designer pentaho/server/pentaho-server/pentaho-solutions/system/dashboards/
Analyzer pentaho/server/pentaho-server/pentaho-solutions/system/analyzer/
Interactive Reporting pentaho/server/pentaho-server/pentaho-solutions/system/pentaho-interactive-reporting/
License Installer pentaho/license-installer/
Pentaho Mobile pentaho/server/pentaho-server/pentaho-solutions/system/pentaho-mobile-plugin/

Location of logs

Log Location
Pentaho Server Logs for BA configuration pentaho/server/pentaho-server/logs/
Tomcat Logs for Pentaho Server for BA configuration pentaho/server/pentaho-server/tomcat/logs/

Location of JDBC drivers

For Mac OSX, you will have to copy the JDBC .jar into the location listed for Report Designer.

JDBC Driver Location
Pentaho Server for BA configuration pentaho/server/pentaho-server/tomcat/lib/
Report Designer pentaho/design-tools/report-designer/lib/jdbc/
Schema Workbench pentaho/design-tools/schema-workbench/drivers/
Aggregation Designer pentaho/design-tools/aggregation-designer/drivers/
Metadata Editor pentaho/design-tools/metadata-editor/libext/JDBC/
Spoon pentaho/design-tools/data-integration/lib/

Default Port Numbers

Your port numbers might differ if these ports are already used for other programs.

Port Number Description
5432 PostgreSQL Server
8080 Pentaho Server Tomcat Web Server Startup Port
8012 Pentaho Server Shutdown Port
9001 HSQL Server Port
9092 Embedded H2 Database
50000 or 50006 Monet Database Port

Next Steps

After you have installed the Pentaho products, you are ready to perform Configuration tasks, such as starting and stopping the server and design tools, setting up licenses, and managing security.

If you have installed the Pentaho Server and you want to migrate content from the previous version of the servers to this one, make sure that your licenses have been installed, then review the Upgrade Pentaho Servers and Design Tools instructions.