Skip to main content
Pentaho Documentation

Start DI Server

Overview

Provides the steps to start the DI Server.

Image of the DI Server installation steps.

After you've complete the tasks in the Prepare Environment, Initialize Repository, Specify Connections, and Prepare Web Server steps, the DI Server's pentaho-di.war file is ready to be deployed. The way that tasks for deployment are performed vary slightly depending on whether you deploy the pentaho-di.war file on the Tomcat or JBoss web application servers.

Once the pentaho-di.war file has been deployed, manually start the BA Server application.

Modify 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. Specific instructions on how to modify the startup script depend on your operating system.

Modify the Tomcat Windows Startup Script

  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 bin subdirectory of the Tomcat home directory.
  3. Add this line directly before the call "%EXECUTABLE%" start %CMD_LINE_ARGS% line, which is located near the end of the file. 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%
  4. Save and close the file.

Modifying the Tomcat Linux Startup Script

  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"
  4. Save and close the file.

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

Modify the JBoss Windows 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.bat file, which is located in the JBoss bin directory.
  3. Add this line below the JAVA_OPTS IF statement. It should be outside of the brackets and not part of the IF statement. set JAVA_OPTS=%JAVA_OPTS% -Xms4096m -Xmx6144m -XX:MaxPermSize=256m -Dpentaho.installed.licenses.file=%PENTAHO_INSTALLED_LICENSE_PATH%
  4. Save and close the file.

Modifying the JBoss Linux 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 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
    # 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.
  5. Save and close the file.

Start DI Server

  1. Run the startup script for your web application server by launching one these files.
    • Windows Tomcat: Launch the startup.bat file. The startup.bat file is in the Tomcat bin directory.
    • Linux Tomcat: Launch the startup.bat file. The startup.sh file is in the Tomcat bin directory.
    • Windows JBoss: Launch the standalone.bat file. The startup.bat file is in the JBoss bin directory.
    • Linux JBoss: Launch the standalone.sh file. The startup.bat 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.