Install Pentaho BA Suite

After you have prepared your environment, use the Wizard to install the Pentaho BA Suite. You only need to perform two tasks.

If you need to uninstall the software, information on how to do that appears here.

Install Pentaho BA Suite with the Wizard

Use the wizard to install Pentaho BA Suite. The wizard installs BA components, DI components, Tomcat web application server, and PostgreSQL, which is the default database that houses the BA and DI Repositories. The BA and DI Repositories hold audit, scheduling, and solution content.

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

Before you start, choose whether you want to install using the default or custom methods.
Table 1. Wizard Installation Decision Table
Explore Considerations Choose the Best Option For You
Default Custom
Summary This option installs all components automatically. This option allows you to choose the components you want to install.
Installed Components Installs all components in the Pentaho BA Suite. These include:
  • Servers: BA Server and DI Server.
  • BA Design Tools and Plugins: Report Designer, Schema Workbench, Metadata Editor, Aggregation Designer, Dashboard, Spoon (with Instaview), Pan, Kitchen, and Carte.
  • Plugins: All BA Plugins such as Pentaho Mobile, Analyzer, Interactive Reporting and some DI Plugins such as Big Data and Marketplace.
You can choose to install some or all of the components in the Pentaho BA Suite. These include:
  • Servers: BA Server and DI Server.
  • BA Design Tools and Plugins: Report Designer, Schema Workbench, Metadata Editor, Aggregation Designer, Dashboard, Spoon (with Instaview), Pan, Kitchen, and Carte.
  • Plugins: All BA Plugins such as Pentaho Mobile, Analyzer, Interactive Reporting and some DI Plugins such as Big Data and Marketplace.
Expertise You need this knowledge to perform this type of installation.
  • Basic computer knowledge.
You need this knowledge to perform this type of installation.
  • Knowledge of your networking environment, including database port numbers if they differ from the default and IP addresses.
Time Approximately 30 minutes. Approximately 30 minutes or less.
Recommendation Select if you want to install all of the Pentaho software on your workstation or server and if you want to install sample content. We recommend that you choose this option if you want to evaluate Pentaho or to start using it quickly. Select if you want to choose which Pentaho programs to install on your workstation or server or if you want the option to not install sample content. We recommend that you choose this option if you want to set up a production system or if you want to install only some Pentaho products. For example, if you want to install the Pentaho BA and DI Servers on your server, and the Interactive Reporting and Analysis tools on a workstation, choose this option.
To install the software, complete these steps.
  1. Make sure that you are logged into the computer on which you want to install the software. You should be log 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 adminstrator 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-5.0.0-x64.exe
    • Linux: pentaho-business-analytics-5.0.0-x64.bin
    • Mac: pentaho-business-analytics-5.0.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-5.0.0-x64.bin
  4. Do one of these things to launch the installation wizard.
    Note: Launch the installer from a locally-mounted hard drive only. Network-mounted drives (such as NFS or Netbeui) are not supported for performance reasons.
    1. If you are using Windows: Open Windows Explorer and navigate to the installation file you just downloaded. Double-click the pentaho-business-analytics-5.0.0-x64.exe file to launch it.
    2. If you are using Mac: Double-click the pentaho-business-analytics-5.0.0-x64.app.tar.gz installation app.
    3. 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-5.0.0-x64.bin
    4. 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-5.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-5.0.0-x64.bin --mode xwindow
  5. The Pentaho Wizard Splash Screen appears, then the Welcome window. Click Next.
  6. Read the license agreement. Accept the license agreement, then click Next to continue.
  7. Select the type of installation you want the wizard to perform. If you choose the default installation, click the Default in the Setup Type window, then do these things. Otherwise, go to the next step.
    1. In the Installation Folder window, accept the default directory or choose a different directory by entering the path in the text box or by clicking Browse to find directory where you want to install the software. Click Next. Note: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.
    2. When prompted for the PostgreSQL password, enter the password you want to assign to the PostgreSQL database's admin user. Do not use these characters in the password because the Wizard cannot process them:
      '  "   &    <   >  \  
    3. Click Next to continue.The Ready to Install window appears. Click the Next button to install the software.
  8. If you choose the custom installation, click the Custom installation in the Setup Type window, then do these things. Otherwise, go to the next step.
    1. Select the Pentaho applications that you want to install from the Pentaho Applications window. Click Next.
    2. If you indicated that you wanted to install the BA Server, the Sample Content window appears. Indicate whether you want the wizard to install the sample content, then click Next. Note: We strongly recommend that you install the sample content. Tutorials and other documentation examples use sample data. Also, if you contact technical support or professional services, sample data is sometimes used to help troubleshoot issues. If you later decide that you do not want to use the sample data, you can remove it after you have installed the software.
    3. In the Installation Folder window, accept the default directory or choose a different directory by entering the path in the text box or by clicking Browse to find the directory where you want to install the the software. Click Next. Note: 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.
    4. If you indicated that you wanted to install the BA Server the PostgreSQL postgres user password window appears. Enter the password you want to assign to the PostgreSQL database's admin user. Do not use these characters in the password because the Wizard cannot process them:
      '  "   &    <   >  \  
    5. Click Next. The Ready to Install window appears. Click the Next button to install the software.
  9. The Installation in Progress window appears. The software takes about 30 minutes to install, but sometimes it takes a little longer. If that happens, wait for the installer to complete. Note: An error occurs if Pentaho BA and DI Server port numbers (8080, 9092, 9080, 8443, 9443, and 5432) are not available on your system and if the additional ports that the wizard has tried are not available. If the wizard cannot find an available port, you are prompted to enter port numbers you want to use.
  10. The Installation Complete window appears. Do these things.
    1. Make note of the Administrative and System User names and passwords. (The default password for both is password.)
    2. Click the Launch the Pentaho User Console now and Launch Pentaho Data Integration now to launch the Pentaho User Console and Spoon.
  11. Click Finish to end the process.
  12. If you have trouble with the installer, check the Troubleshooting documentation. Note: Once the installation wizard is complete, the BA Server and DI Server are running with the default parameters. Terminal windows might remain open after installation. If you close them, the BA and DI Servers stop. On Windows, the BA and DI Servers are installed as system services, meaning that they start when you start your computer, and they stop 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 docunentation that explains how to start and stop servers manually.

Verify Installation

To verify that the installation occured 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 entire suite, the structure should look like this.
    pentaho/
    pentaho/server/
    pentaho/server/biserver-ee/
    pentaho/server/biserver-ee/data/
    pentaho/server/biserver-ee/licenses/
    pentaho/server/biserver-ee/pentaho-solutions/
    pentaho/server/biserver-ee/tomcat/
    pentaho/server/data-integration-server/
    pentaho/server/data-integration-server/licenses/
    pentaho/server/data-integration-server/logs/
    pentaho/server/data-integration-server/pentaho-solutions/
    pentaho/server/data-integration-server/scripts/
    pentaho/server/data-integration-server/tomcat/
    pentaho/server/hsql-sample-database
    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/common/
    pentaho/documentation/
    pentaho/java/
    pentaho/licenses/
    pentaho/monetdb/
    pentaho/postgresql/
    pentaho/scripts/
    pentaho/third-party-tools/
    pentaho/wkhtmltoimage/
  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 files

    These files are found in the top-level Pentaho directory:

    • ctlscript.shStarts, 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

    • BA Server: pentaho/server/biserver-ee/
    • DI Server: pentaho/server/data-integration-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/biserver-ee/pentaho-solutions/system/dashboards/
    • Analyzer: pentaho/server/biserver-ee/pentaho-solutions/system/analyzer/
    • Interactive Reporting: pentaho/server/biserver-ee/pentaho-solutions/system/pentaho-interactive-reporting/
    • License Installer: pentaho/license/
    • Pentaho Mobile: pentaho/server/biserver-ee/pentaho-solutions/system/pentaho-mobile-plugin/

    Location of logs:

    • BA Server Logs: pentaho/server/biserver-ee/logs/
    • Tomcat Logs for BA Server: pentaho/server/biserver-ee/tomcat/logs/
    • DI Server Logs: pentaho/server/data-integration-server/logs/
    • Tomcat Logs for DI Server: pentaho/server/data-integration-server/tomcat/logs/

    Default Port Numbers (your port numbers might differ if these ports are already used for other programs):

    • 5432: PostgreSQL Server
    • 8080: BA Server Tomcat Web Server Startup Port
    • 8012: BA Server Shutdown Port
    • 9080: DI Server Port
    • 9001: HSQL Server Port
    • 9092: Embedded H2 Database
    • 50000 or 50006: Monet Database Port

    Note: The license installer can also be found in the report-designer, data-integration, and metadata-editor directories. All of these license installers perform the same functions, but are available in separate places to account for instances where only specific parts of Pentaho Business Analytics are installed to a particular machine. It does not matter which one you use. You can also install licenses through the Pentaho User Console. More information about license installation can be found in the next step.

Uninstall Pentaho

If you need to uninstall Pentaho, complete these steps.
  1. Navigate to the pentaho directory, and run the uninstall file.
  2. The Uninstall Wizard is launched.
  3. When prompted, indicate whether you want to delete the data files.
  4. When prompted at the end of the process, restart your computer.