Configure and start the Pentaho Server after manual installation

Legacy page. Content moved to the main topic.

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

How you configure and start the Pentaho Server after a manual installation depends on your OS.

Configure the Pentaho Server

Windows

Complete these steps to configure the Pentaho Server on Windows.

The server will not start if any environment variable value is invalid.

1

Modify the Tomcat startup script

The Tomcat startup script must include:

• CATALINA_OPTS (Java options, including memory)

• DI_HOME (required for PDI components)

• The license file location

1. Copy all .jar files from:

   <pentaho_install_dir>\pentaho-server\pentaho-solutions\native-lib\win64

   To:

   <tomcat_webapps_dir>\pentaho\WEB-INF\lib

2. Add the LIBPATH variable to the Tomcat startup.bat file:

   set LIBPATH=<pentaho_install_dir>\pentaho-server\pentaho-solutions\native-lib\win64

3. Make sure Tomcat is not running.

   1. Open Task Manager.

   2. Look for Tomcat.

   3. If Tomcat is running, stop it.

4. Open the startup script in a text editor:

   <pentaho_install_dir>\pentaho-server\tomcat\bin\startup.bat

5. Find the CATALINA_HOME section.

   Add this line before it:

   SET DI_HOME=%~dp0..\..\pentaho-solutions\system\kettle

6. Add the license option to CATALINA_OPTS.

   Update the existing CATALINA_OPTS line by adding:

   -Dpentaho.license.information.file=%PENTAHO_LICENSE_INFORMATION_PATH%

   Example:

   SET CATALINA_OPTS=-Xms4096m -Xmx6144m -Djava.library.path=%LIBPATH% -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Dpentaho.license.information.file=%PENTAHO_LICENSE_INFORMATION_PATH% -DDI_HOME=%DI_HOME%

7. Save and close the file.

2

Run the Pentaho Server as a Windows service (optional)

You can create a Tomcat task to run the Pentaho Server as a Windows service.

For details, see Tomcat Windows service how-to documentation.

When you run tomcat8w.exe, use these settings:

• Startup tab

  • Working Path: Add bin to the end of the path. Example: C:\pentaho\server\pentaho-server\tomcat\bin

• Java tab

  • Initial Memory Pool: 2048

  • Maximum Memory Pool: 6144

  • Java Options: add the following items:

    • -DDI_HOME

    • -Dfile.encoding

    • -Djava.library.path

    • -Dpentaho.license.information.file

Example values:

• -DDI_HOME=C:\pentaho\server\pentaho-server\pentaho-solutions\system\kettle

• -Dfile.encoding=utf8

• -Djava.library.path=<pentaho_install_dir>\pentaho-server\pentaho-solutions\native-lib\win64

• -Dpentaho.license.information.file=%PENTAHO_LICENSE_INFORMATION_PATH%

You must set PENTAHO_LICENSE_INFORMATION_PATH to point to the .elmLicInfo.plt file:

PENTAHO_LICENSE_INFORMATION_PATH=<complete_path>\.elmLicInfo.plt

3

Install licenses

Install your enterprise licenses before you start the server.

See Acquire and install enterprise licenses.

License activation overview (optional)

1. Contact Sales and acquire the necessary licenses. You will receive an activation ID or cloud license server information.

2. Deploy a local license server or a cloud license server to manage license activation.

   • Local license server: see Activate a license using a local license server in Administer Pentaho Data Integration and Analytics. Use offline activation if your license server cannot reach the back office URL.

   • Cloud license server: see Activate a license using a cloud license server in Administer Pentaho Data Integration and Analytics.

4

Start the Pentaho Server

Go to Start the Pentaho Server.

Linux

Complete these steps to configure the Pentaho Server on Linux.

The server will not start if any environment variable value is invalid.

1

Modify the Tomcat startup script

The Tomcat startup script must include:

• CATALINA_OPTS (Java options, including memory)

• DI_HOME (required for PDI components)

• The license file location

1. Copy all .jar files from:

   <pentaho_install_dir>/pentaho-server/pentaho-solutions/native-lib/linux/x86_64

   To:

   <tomcat_webapps_dir>/pentaho/WEB-INF/lib

2. Add the LIBPATH variable to the Tomcat startup.sh file:

   export LIBPATH=<pentaho_install_dir>/pentaho-server/pentaho-solutions/native-lib/linux/x86_64

3. Make sure Tomcat is not running.

   1. Open a terminal.

   2. Run ps -A.

   3. If Tomcat is running, stop it.

4. Open the startup script in a text editor:

   <pentaho_install_dir>/pentaho-server/tomcat/bin/startup.sh

5. Find the #Check that target executable exists line.

   Add this line above it:

   DI_HOME=<pentaho_install_dir>/pentaho-server/pentaho-solutions/system/kettle

6. Add the license option to CATALINA_OPTS.

   Update the existing CATALINA_OPTS line near the end of the file.

   Example:

   export CATALINA_OPTS="$CATALINA_OPTS -Xms4096m -Xmx6144m \
     -Djava.library.path=$LIBPATH \
     -Dsun.rmi.dgc.client.gcInterval=3600000 \
     -Dsun.rmi.dgc.server.gcInterval=3600000 \
     -Dpentaho.installed.licenses.file=$PENTAHO_INSTALLED_LICENSE_PATH \
     -DDI_HOME=$DI_HOME"

7. Save and close the file.

2

Install licenses

Install your enterprise licenses before you start the server.

See Acquire and install enterprise licenses.

3

Start the Pentaho Server

Go to Start the Pentaho Server.

Start the Pentaho Server

After you configure the Pentaho Server for your platform:

1. Define the DI_HOME environment variable.

   The default path for Windows and Linux:

   • Windows: PENTAHO_INSTALLATION_FOLDER\pentaho-server\pentaho-solutions\system\kettle

   • Linux: PENTAHO_INSTALLATION_FOLDER/pentaho-server/pentaho-solutions/system/kettle

2. Run the startup script for your web application server.

   • Windows: startup.bat in the Tomcat bin folder

   • Linux: startup.sh in the Tomcat bin directory

3. Open http://localhost:8080/pentaho to access the Pentaho User Console (PUC).

   If your server uses a different hostname or port, update the URL.

Troubleshoot startup issues

Troubleshooting is centralized in Troubleshooting possible installation and upgrade issues.