Skip to main content
Pentaho Documentation

Starting DI Server on Linux

Overview

Explains how to start the DI Server.

Install License Keys Using the Command Line Interface

  1. Download the .lic file you want to install.
  2. Copy your .lic files to the DI Server.
  3. Navigate to the license-installer directory:  pentaho/license-installer
  4.  Run install_license.sh with the install switch and the location and name of your .lic file as a parameter. You can specify multiple .lic files separated by spaces. Be sure to use backslashes to escape any spaces in the path or file name, like this:
install_license.sh install /home/<user name>/downloads/Pentaho\ DI\ Enterprise\ Edition.lic

Modify Tomcat Linux 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. 

  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 bin subdirectory of the Tomcat home directory.
  3. Add this line directly before the exec "$PRGDIR"/"$EXECUTABLE" start "$@" line near the end of the file.
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"
  1. Save and close the file.

Modify JBoss Linux 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.

  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 or more, 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
  1. Specify options to pass to the Java VM.
    if [ "x$JAVA_OPTS" = "x" ]; then
        JAVA_OPTS="-Xms4096m \
        -Xmx6144m \
        -XX:MaxPermSize=256m \
        -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.

Start DI Server

  1. Run the startup script for your web application server by launching one these files.
    • Linux Tomcat: Launch the startup.sh file. The startup.sh file is in the Tomcat bin directory.
    • Linux JBoss: Launch the standalone.sh file. The standalone.sh file is in the JBoss bin directory.
  2. The server starts. There is no GUI for the server, but when you install then start the client tool, which is called Spoon, you can interact with the DI Server from there. When you start Spoon, you will also be prompted to enter your license information. See Install DI Tools to learn how to install Spoon and other plugins.

Problems Starting the DI Server?

Check out our Troubleshooting Guide for help.