Ctrlk
Try Pentaho! - Start your 30 day evaluation today
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Step 1: Prepare your environment

Prepare your Windows or Linux environment for an archive installation of Pentaho by completing the tasks for that environment:

Preparing a Windows environment for archive installation

Prepare a Windows environment for an archive installation by completing the following tasks, in order:

1

Create the Windows folder structure

  1. Sign in to Windows.

  2. Create the pentaho\\server folder (for example, C:\\pentaho\\server).

  3. Verify that you have read, write, and execute permissions for the folder.

  4. Verify that users can write to the folder where you are installing Pentaho.

2

Install Java on Windows

Pentaho requires a supported Java version.

  1. Check the Components Reference for supported Java versions.

  2. Download and install the supported JRE or JDK from the Oracle website.

  3. Set the JAVA_HOME environmental variable to point to your Java installation folder by running the following command:

    set JAVA_HOME="C:\\Program Files\\Java\\<JDK_FOLDER>"
3

Install the Pentaho Repository host database on Windows

The Pentaho Repository stores data used for scheduling and security. It also stores metadata and models for reports.

  1. Choose a database to host the Pentaho Repository. Pentaho supports the following databases:

    • PostgreSQL

    • MySQL

    • MariaDB

    • Oracle

    • MS SQL Server

  2. Check the Components Reference for the supported version of your selected database.

  3. Install the selected database.

  4. Verify the database is installed correctly.

4

Download and unpack installation files in Windows

Pentaho Server and Operations Mart are delivered as compressed files. Installing them requires downloading the files, unpacking them, and placing their contents in the appropriate directories.

Download files in Windows

  1. Sign in to the Support Portal using the credentials from your Pentaho Welcome Packet.

  2. In the Pentaho card, select Download.

  3. In the 11.x list, select Pentaho 11.0 GA Release.

    You might need to select See all <number> articles to see the full list of 11.x downloads.

  4. Scroll to the bottom of the Pentaho 11.0 GA Release page.

  5. In the file component section, go to Pentaho Server\\Archive Build (Suggested Installation Method).

  6. Download pentaho-server-ee-11.0.0.0-<build number>.zip.

  7. In the file component section, go back to 11.0.0.0-GA.

  8. Open the Operations Mart folder.

  9. Download pentaho-operations-mart-11.0.0.0-<build number>.zip.

Unpack installation files in Windows

  1. Locate the two files you downloaded:

    • pentaho-server-ee-11.0.0.0-<build number>.zip

    • pentaho-operations-mart-11.0.0.0-<build number>.zip

  2. Unpack pentaho-server-ee-11.0.0.0-<build number>.zip into the \\pentaho\\server folder.

  3. Unpack pentaho-operations-mart-11.0.0.0-<build number>.zip into the \\pentaho\\server folder.

  4. Move the folder for your database into the pentaho\\server\\pentaho-server\\data\\<database name> folder. Use one of the following folder names for your database:

    • PostgreSQL → postgresql

    • MySQL or MariaDB → mysql5

    • Oracle → oracle10g

    • MS SQL Server → sqlserver

  5. Delete the other database folders.

  6. Complete the steps for installing Data Integration Operations Mart in the Administer Pentaho Data Integration and Analytics document before installing your database.

Verify folder structure in Windows

Verify that the files are placed in the correct folders.

Your pentaho folder should include the following paths:

  • pentaho\\server\\pentaho-server\\

  • pentaho\\server\\pentaho-server\\data\\<database name>

5

Set environment variables in Windows

If you do not set the required *_HOME environment variables, Pentaho might not start correctly.

  1. Set PENTAHO_JAVA_HOME to your Java installation directory by running the following command:

    set PENTAHO_JAVA_HOME="C:\\Program Files\\Java\\<JDK_FOLDER>"

  2. (Optional) If you are using a JRE, also set JRE_HOME.

  3. Sign out, sign back in, and then verify the variables are set by running the following command:

    echo %PENTAHO_JAVA_HOME%

After you finish preparing your environment, go to Step 2: Set up the Pentaho Repository.

Preparing a Linux environment for archive installation

Prepare a Linux environment for an archive installation by completing the following tasks, in order:

1

Create the Pentaho user in Linux

Create a user account with administrative privileges to use for preparing your Linux environment.

  1. Create an administrative user on the server and name it pentaho.

  2. Verify the pentaho user can read, write, and run commands in its home directory.

  3. Verify users can write to the directory where you install Pentaho.

2

Create the Linux directory structure

  1. Sign in to Linux as the pentaho user.

  2. Create the following directories:

    • <your home directory>/pentaho/server
    • <your home directory>/.pentaho

  3. Verify that you have read, write, and execute permissions for both directories.

3

Install Java on Linux

Pentaho requires a supported Java version.

  1. Check Components Reference for supported Java versions.

  2. Download and install the supported JRE or JDK from the Oracle website.

  3. Set the JAVA_HOME environmental variable to point to your Java installation folder by running the following command:

    export JAVA_HOME=/usr/lib/jvm/jdk11.x.x.x
4

Install the Pentaho Repository host database on Linux

The Pentaho Repository stores data used for scheduling and security. It also stores metadata and models for reports.

  1. Choose a database to host the Pentaho Repository. Pentaho supports the following databases:

    • PostgreSQL

    • MySQL

    • MariaDB

    • Oracle

    • MS SQL Server

  2. Check the Components Reference for the supported version of your selected database.

  3. Install the selected database.

  4. Verify the database is installed correctly.

5

Download and unpack installation files in Linux

Pentaho Server and Operations Mart are delivered as compressed files. Installing them requires downloading the files, unpacking them, and placing their contents in the appropriate directories.

Download files in Linux

  1. Sign in to the Support Portal using the credentials from your Pentaho Welcome Packet.

  2. In the Pentaho card, select Download.

  3. In the 11.x list, select Pentaho 11.0 GA Release.

    You might need to select See all <number> articles to see the full list of 11.x downloads.

  4. Scroll to the bottom of the Pentaho 11.0 GA Release page.

  5. In the file component section, go to Pentaho Server/Archive Build (Suggested Installation Method).

  6. Download pentaho-server-ee-11.0.0.0-<build number>.zip.

  7. In the file component section, go back to 11.0.0.0-GA.

  8. Open the Operations Mart folder.

  9. Download pentaho-operations-mart-11.0.0.0-<build number>.zip.

Unpack installation files in Linux

  1. Locate the two files you downloaded:

    • pentaho-server-ee-11.0.0.0-<build number>.zip

    • pentaho-operations-mart-11.0.0.0-<build number>.zip

  2. Unpack pentaho-server-ee-11.0.0.0-<build number>.zip into the /pentaho/server directory.

  3. Unpack pentaho-operations-mart-11.0.0.0-<build number>.zip into the /pentaho/server directory.

  4. Move the directory for your database into pentaho/server/pentaho-server/data/<database name>. Use one of the following folder names for your database:

    • PostgreSQL → postgresql

    • MySQL or MariaDB → mysql5

    • Oracle → oracle10g

    • MS SQL Server → sqlserver

  5. Delete the other database folders.

  6. Complete the steps for installing Data Integration Operations Mart in the Administer Pentaho Data Integration and Analytics document before installing your database.

Verify directory structure in Linux

Verify that the files are placed in the correct directories.

Your pentaho directory should include the following paths:

  • pentaho/server/pentaho-server/

  • pentaho/server/pentaho-server/data/<database name>

6

Set environment variables in Linux

If you do not set the required *_HOME environment variables, Pentaho might not start correctly.

  1. Set PENTAHO_JAVA_HOME to your Java installation directory:

export PENTAHO_JAVA_HOME=/usr/lib/jvm/java-11-oracle

  1. (Optional) If you are using a JRE, also set JRE_HOME.

  2. Sign out, sign back in, and then verify the variables are set.

7

Review advanced Linux considerations

Some headless server configurations require additional setup, including:

  • Linux systems without a video card

  • Linux systems with a video card but no X server installed

In some environments, especially systems without a video card, you might need to complete both procedures to generate reports.

Linux systems without video cards

Important: Startup can fail if any environment variable value is invalid. Double-check settings after edits.

Before you start Pentaho Server for the first time, add the following parameter to CATALINA_OPTS in your application server startup scripts: -Djava.awt.headless=true

-Djava.awt.headless=true

Example:

export CATALINA_OPTS="-Djava.awt.headless=true -Xms4096m -Xmx6144m -XX:MaxPermSize=256m -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000"

If you create a service control script, add the same parameter to its CATALINA_OPTS.dits.

Linux systems without X11

Chart generation requires X11 functions.

If you cannot install an X server, install Xvfb instead. Xvfb emulates X11 in memory.

Install Xvfb using your operating system’s package manager.

After you finish preparing your environment, go to Step 2: Set up the Pentaho Repository.

PreviousArchive installation of PentahoNextStep 2: Set up the Pentaho Repository

Last updated

Was this helpful?