Skip to main content
Pentaho Documentation

Configure and Start the Pentaho Server after Manual Installation

How you configure and start the Pentaho Server after a manual installation depends on whether your operating system is Windows or Linux.

Configure the Pentaho Server for Windows

Complete these steps to configure and start the Pentaho Server on a Windows machine, according to your application server type:

  • If you are using JBoss, go to Step 3.
  • If you are using Tomcat, skip Step 3.

Step 1: Modify the Tomcat Startup Script

The Tomcat startup script must be modified to include the CATALINA_OPTS variable. CATALINA_OPTS indicates the amount of memory to allocate. It also indicates where Pentaho licenses are installed. 

Perform the following steps to include the CATALINA_OPTS variable:

  1. Make sure the Tomcat web application server is not running by starting the Windows Task Manager and looking for Tomcat in the Applications tab. If the server is running, stop it.

  2. Use a text editor to open the startup.bat file, which is in the pentaho\server\pentaho-server\tomcat\bin directory. 
  3. Add this line before the CATALINA_HOME section. 
    SET DI_HOME=%~dp0..\..\pentaho-solutions\system\kettle
  4. Add the java option pentaho.installed.licenses.file to CATALINA_OPTS. You need to modify setting of CATALINA_OPTS variable by adding the java option. See the following example. 
    SET CATALINA_OPTS=-Xms4096m -Xmx6144m -XX:MaxPermSize=256m -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Dpentaho.installed.licenses.file=%PENTAHO_INSTALLED_LICENSE_PATH% -DDI_HOME=%DI_HOME%
  5. Save and close the file.

Step 2: (Optional) Run the Pentaho Server as a Windows Service

Optionally, you can create a Tomcat task to run the Pentaho Server as a Windows service. See Tomcat Windows service how-to documentation.

You will need to use the following settings in the GUI application that appears when you run tomcat8w.exe to configure the service:

Tab Field Recommended Value
Startup Working Path Add bin
Java Initial Memory Pool 2048
Java Maximum Memory Pool 6144
Java Java Option

Add the following items:

  • -DDI_HOME
  • Dpentaho.installed.license.file
  • Dfile.encoding

Step 3: Modify the JBoss Startup Script

If you installed your own JBoss web application server, the JBoss startup script must be modified to include the JAVA_OPTS variable. JAVA_OPTS indicates the amount of memory to allocate. It also indicates where Pentaho licenses are installed. Specific instructions on how to modify the startup script depend on your operating system.

Perform the following steps to modify the JBoss startup script:

  1. Make sure the JBoss web application server is not running by starting the Windows Task Manager and looking for JBoss in the Applications tab. If the server is running, stop it.

  2. Use a text editor to open the standalone.conf.bat file, which is located in the JBoss bin directory.
  3. Use a text editor to open the standalone.bat file. 
  4. Locate "x%JBOSS_HOME%" == "x"  ( and copy this text above it:
pushd "%DIRNAME%..\.."
set "INSTALL_HOME=%CD%"
popd
SET DI_HOME=%INSTALL_HOME%\pentaho-solutions\system\kettle
  1. Save and close the file.

Step 4: Start the Pentaho Server

  1. If you installed your own web application server, run the startup script for this server by launching one of the following files:
  • Tomcat: Launch the startup.bat file, located in the Tomcat bin directory.

  • JBoss: Launch the standalone.bat file, located in the JBoss bin directory.
  1. From a workstation, open a web browser and enter this URL: http://localhost:8080/pentaho to access the Pentaho User Console (PUC).

If your server has a different hostname or port, replace localhost and 8080 with your specific values.   

Step 5: Install Licenses

Perform the following steps to install the Pentaho licenses:

  1. Log on to PUC. The first time you log on, the License page will appear. You must enter licenses. 

  2. Click the Add button (+) and then browse to the license files that you want to install. Typically, the license files are unpacked in the \pentaho\server directory. Double-click the license to install it. 
  3. Repeat the previous step until all needed licenses are installed.

Additional license installation instructions are located in Manage Pentaho Licenses.

Configure the Pentaho Server for Linux

Complete these steps to configure and start the Pentaho Server on a Linux machine, according to your application server type:

  • If you are using JBoss, go to Step 2.
  • If you are using Tomcat, skip Step 2.

Step 1: Modify the Tomcat Startup Script

The Tomcat startup script must be modified to include the CATALINA_OPTS variable. CATALINA_OPTS indicates the amount of memory to allocate. It also indicates where Pentaho licenses are installed. 

Perform the following steps to include the CATALINA_OPTS variable:

  1. Make sure the Tomcat web application server is not running by opening a Terminal window and typing ps -A at the prompt. If the server is running, stop it.

  2. Use a text editor to open the startup.sh file, which is in the pentaho/server/pentaho-server/tomcat/bin directory.
  3. Locate the #Check that target executable exists line and add this code above it. 
    DI_HOME=<your pentaho directory>/pentaho-solutions/system/kettle
  4. Add the Java option pentaho.installed.licenses.file to CATALINA_OPTS. You need to modify the setting of the CATALINA_OPTS variable at the end of the file by adding the Java option.  See the following example. 
    EXPORT CATALINA_OPTS="-Xms4096m -Xmx6144m -XX:MaxPermSize=256m -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000 -Dpentaho.installed.licenses.file=$PENTAHO_INSTALLED_LICENSE_PATH -DDI_HOME=$DI_HOME"
  5. Save and close the file.

Step 2: Modify the JBoss Startup Script

The JBoss startup script must be modified to include the JAVA_OPTS variable. JAVA_OPTS indicates the amount of memory to allocate. It also indicates where Pentaho licenses are installed. Specific instructions on how to modify the startup script depend on your operating system.

Perform the following steps to modify the JBoss startup script:​​​​​​

  1. Make sure the JBoss web application server is not running by opening a Terminal window and typing ps -A at the prompt. If the server is running, stop it.

  2. Use a text editor to open the standalone.conf file. The file is located in the bin subdirectory of your JBoss home directory.
  3. Modify the Xms memory settings in the JAVA_OPTS line to be at least 4096 MB. If you have the resources and are concerned with performance, change the Xmx value to at least 6144 MB.
  4. Add the following options to the JAVA_OPTS line: 
    -Djava.awt.headless=true -Djava.io.tmpdir=/tmp/ -Dpentaho.installed.licenses.file=$PENTAHO_INSTALLED_LICENSE_PATH
  5. Specify the option to pass to the Java VM, as shown below. 
    # Specify options to pass to the Java VM.
        if [ "x$JAVA_OPTS" = "x" ]; then
            JAVA_OPTS="-Xms4096m \
            -Xmx6144m \
            -XX:MaxPermSize=256m \
            -DDI_HOME=$DI_HOME
            -Dsun.rmi.dgc.client.gcInterval=3600000 \
            -Dsun.rmi.dgc.server.gcInterval=3600000 \
            <b>-Djava.awt.headless=true \
            -Djava.io.tmpdir=/tmp/ \
            -Dpentaho.installed.licenses.file=$PENTAHO_INSTALLED_LICENSE_PATH

You may need to adjust these settings for your environment. For instance, if you do not have a /tmp/ directory, you may want to change that setting to /var/tmp/ or some other location.

  1. Save and close the file.
  2. Locate the bin subdirectory in the JBoss home directory and open the standalone.sh file with a text editor. 
  3. Find the section for # Setup JBOSS_HOME and add this after it.
INSTALL_HOME==`cd "$DIRNAME/../.."; pwd`
DI_HOME=$INSTALL_HOME/pentaho-solutions/system/kettle
  1. Save and close the file.

Step 3: Start the Pentaho Server

Perform the following steps to start the Pentaho Server:

  1. Run the startup script for your web application server by launching one these files.

    • Tomcat: Launch the startup.sh file, located in the Tomcat bin directory.

    • JBoss: Launch the standalone.sh file, located in the JBoss bin directory.
  2. From a workstation, open a web browser and enter this URL: http://localhost:8080/pentaho to access the Pentaho User Console (PUC).

If your server has a different hostname or port, replace localhost and 8080 with your specific values.   

Step 4: Install Licenses

Perform the following steps to install the Pentaho licenses:

  1. Log on to PUC. The first time you log on, the License page will appear. You must enter licenses. 

  2. Click the Add button (+) and then browse to the license files that you want to install. Typically, the license files are unpacked in the /pentaho/server directory. Double-click the license to install it. 
  3. Repeat the previous step until all needed licenses are installed.

Additional license installation instructions are located in Manage Pentaho Licenses.

Problems Starting the Pentaho Server

Visit our Troubleshooting Guide for help.