Prepare your Windows environment for a manual installation

Legacy page. Content moved to the main topic.

This page is kept for existing links. Go to Manual installation process.

Prepare your Windows environment for a manual installation. Manual installation deploys Pentaho Server to your own web application server.

If you want Pentaho to provide the web application server, see Archive installation.

Process overview

Complete these tasks to prepare a Windows environment for a manual installation of Pentaho Server:

1. Create Windows directory structure.

2. Install Java.

3. Install your web application server.

4. Install the database that will host the Pentaho Repository.

5. Download and unpack the installation files.

6. Set environment variables.

7. Prepare your Pentaho Repository.

If you already installed a supported web application server, skip “Install your web application server.”

Create Windows directory structure

Choose an installation path for Pentaho on Windows. Pentaho recommends this directory path:

pentaho\\server\\pentaho-server

1. Sign in to the machine where you will run Pentaho Server.

2. Create the directory path: pentaho\server\pentaho-server.

3. Verify you have permission to read, write, and run commands in these directories.

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

Install Java

Pentaho requires a supported Java version.

1. Check Components Reference for supported Java versions.

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

3. Set JAVA_HOME to your Java install directory.

   Example:

   set JAVA_HOME="C:\Program Files\Java\jdk11.x.x.x"

Install your web application server

If you want to deploy Pentaho Server to your own Tomcat web application server, install Tomcat first.

1. Check Components Reference for supported Tomcat versions.

2. Install the web application server by following the vendor’s documentation.

   Pentaho recommends installing Tomcat in pentaho\server\pentaho-server.

3. Start the web application server and verify the default page loads.

4. Stop the web application server.

Install the Pentaho Repository host database

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

1. Choose and install a database to host the Pentaho Repository.

   Pentaho supports:

   • PostgreSQL

   • MySQL

   • MariaDB

   • Oracle

   • MS SQL Server

2. Check Components Reference for supported database versions.

3. Install the database.

4. Verify the database starts and you can connect to it.

Download and unpack installation files

Download the compressed installation files. Then unpack them into the correct directories.

Download files

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

2. In the Pentaho card, select Download.

3. On the 11.x page, 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\Manual Build (No Web Application Server).

6. Download pentaho-server-manual-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

1. Locate the two files you downloaded:

   1. pentaho-server-manual-ee-11.0.0.0-<build number>.zip

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

2. Unpack pentaho-server-manual-ee-11.0.0.0-<build number>.zip. Move the contents to \pentaho\server\pentaho-server.

3. Unpack pentaho-operations-mart-11.0.0.0-<build number>.zip. Move the contents to \pentaho\server\pentaho-server.

4. In \pentaho-server, open \pentaho-server-manual-ee.

5. Unpack these ZIP files and move the contents to the correct directories:

   File to unpack	Directory where you move the file contents
   license-installer.zip	pentaho\server
   jdbc-distribution-utility.zip	pentaho\server
   pentaho-data.zip	pentaho\server\pentaho-server
   pentaho-solutions.zip	pentaho\server\pentaho-server

6. Copy the .war and .html files to these directories:

   File	Directories that you copy the file into
   pentaho.war	pentaho\server\pentaho-server\<tomcat installation directory>\webapps
   pentaho-style.war	pentaho\server\pentaho-server\<tomcat installation directory>\webapps
   PentahoServer_OSS_Licenses.html	pentaho\server\pentaho-server

Verify directory structure

1. Verify the files are placed correctly. Your pentaho directory should include:

   • pentaho\server\pentaho-server\

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

2. If your web application server is installed outside pentaho\server\pentaho-server, verify:

   • pentaho.war is in your web application server’s webapps directory.

   • pentaho-style.war is in your web application server’s webapps directory.

Set environment variables

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

1. Set PENTAHO_JAVA_HOME to your Java installation directory:

   SET PENTAHO_JAVA_HOME=C:\Program Files\Java\jdk11.x.x.x

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

3. Sign out and sign in again. Then verify the variables are set:

   ECHO %PENTAHO_JAVA_HOME%

Prepare your Pentaho Repository

After you prepare your environment, initialize and configure your Pentaho Repository.

Select the database you are using:

• PostgreSQL

• MySQL or MariaDB

• Oracle

• MS SQL Server