Skip to main content
Pentaho Documentation

Start and Stop the Pentaho Server for Configuration

Whether you are working with the Pentaho User Console or Pentaho Data Integration, you must have the Pentaho Server running. There may be times when you need to manage these components individually, stopping the Pentaho Server to perform system maintenance and restarting it after you are done. As part of installing Pentaho, we provide different ways to help you start and stop the components depending on the operating system your particular installation method. 

If you installed Pentaho software using your own web application server, such as JBoss, use the information in this section as a guide to create a custom way to start and stop these components.

Audience: IT administrators who know where data is stored, how to connect to it, details about the computing environment, and how to use the command line to issue commands for Microsoft Windows, Linux, or Microsoft OS.

Below are instructions for starting and stopping the Pentaho Server depending on your operating system and installation method. 

Starting and Stopping the Pentaho Server on Windows

Below are instructions and recommendations for managing the Pentaho Server on Windows, depending on your installation method.

Pentaho Installation Wizard

If you ran the Pentaho Installation Wizard on Windows, then the Pentaho Server is deployed in an Apache Tomcat application server. You can manage both the Pentaho and Tomcat servers by clicking Start > All Programs > Pentaho Enterprise Edition > Server Management and selecting one of these menu items:

  • Start Pentaho Server
  • Stop Pentaho Server

The installation wizard also registered the Pentaho Server, as well as the Pentaho Repository, as services. These services are set to run automatically, enabling them to start and stop when the computer running them boots up or shuts down. You can use the Windows Services applet found in the Control Panel to start and stop the Pentaho Server and the Pentaho Repository.

  1. Click Start > Control Panel > Administrative Tools > Services.
  2. In the Services window, right-click on one of these services in the list and take the appropriate action:
    • Pentaho Server
    • Data Integration
    • Pentaho Repository

Manual Installation Using Your Own Respository

If you installed Pentaho using your own repository, we provide individual control scripts to start and stop the Pentaho Server and Pentaho Repository. Here is where you can find the individual control scripts.

Pentaho Server

  • /pentaho/server/pentaho-server/start-pentaho.bat and stop-pentaho.bat

Pentaho Repository

  • Installing Pentaho using your own repository enables you to install PostgreSQL, MySQL, MS SQL Server, or Oracle as the repository. Consult the documentation for the relational data base management system (RDBMS) you selected for information about starting and stopping the repository.
  • The Pentaho Repository must be started before the Pentaho Server. 

Starting and Stopping the Pentaho Server on Linux

Below are instructions and recommendations for managing the Pentaho Server on Linux, depending on your installation method. Additionally, we provide an example of how you can create a script to start the server and repository when booting up and stop them when shutting down.

Pentaho Installation Wizard

When you ran the installation wizard on Linux, the Pentaho Server is deployed in an included Apache Tomcat application server. You can control the Tomcat server using the start and stop scripts that come with the Pentaho installation. This script is also used as an easy way to start and stop the Pentaho Server and the PostgreSQL repository. You can find this script at /pentaho/ctlscript.sh.

Here is a list of the script arguments and services you can use.

Arguments

  • start
  • stop
  • restart
  • status
  • help

Services

  • pentahoserver
  • postgressql
./ctlscript.sh start pentahoserver
./ctlscript.sh status pentahoserver
./ctlscript.sh status postgressql
./ctlscript.sh help

Manual Installation Using Your Own Repository

If you installed Pentaho using your own repository, Pentaho provides individual control scripts to start and stop the Tomcat application server, Pentaho Server, and Pentaho Repository. Here is where you can find the individual control scripts.

Pentaho Server

  • pentaho/server/pentaho-server/start-pentaho.sh and stop-pentaho.sh

Pentaho Repository

  • Installing with your own repository enables you to install PostgreSQL, MySQL, MS SQL Server, or Oracle as the Pentaho repository. Consult the documentation for the relational data base management system (RDBMS) you selected for information about starting and stopping the repository.
  • The Pentaho Repository must be started before the Pentaho Server.

Pentaho Installation Wizard or Manual Installation: Starting on Boot

The installation wizard and manual installation do not provide a way to start the Pentaho Repository and Pentaho Server automatically on boot. They also do not stop automatically at shutdown. Here are examples of how you might approach creating a script to start at boot and stop at shutdown.

  • This procedure assumes that you are running the Pentaho Server under the pentaho local user account. If you are using a different account to start these services, substitute it in the script in step 2.
  • This script also assumes you are using the PostgreSQL repository. Where postgresql appears in this script, change it to reflect the RDBMS you are using as a repository, either MySQL or Oracle.
  • This script was tested on Red Hat Enterprise Linux. You may have to modify the details of the script if you use a different distribution of Linux or other Unix-like operating system, different shells, or different init systems.
  1. With root permissions, create a file in /etc/init.d/ named pentaho or named pdi, depending on your needs.

  2. Using a text editor, copy the following content into the new pentaho script. If running the solution repository on the same machine as the server, change postgresql to the name of the init script for your database. If running the solution repository on the a remote computer, remove postgresql entirely. You may also have to adjust the paths to the Pentaho Server scripts to match your situation.
    #!/bin/sh
    ### BEGIN INIT INFO
    # Provides: start-pentaho stop-pentaho
    # Required-Start: networking postgresql
    # Required-Stop: postgresql
    # Default-Start: 2 3 4 5
    # Default-Stop: 0 1 6
    # Description: Pentaho Server
    ### END INIT INFO
    
    case "$1" in
    "start")
    su - pentaho -c "/home/pentaho/pentaho/server/pentaho-server/start-pentaho.sh"
    ;;
    "stop")
    su - pentaho -c "/home/pentaho/pentaho/server/pentaho-server/stop-pentaho.sh"
    ;;
    *)
    echo "Usage: $0 { start | stop }"
    ;;
    esac
    exit 0
  3. Save the file and close the text editor
  4. Open /home/pentaho/pentaho/server/pentaho-server/start-pentaho.sh.
  5. Change the last if statement to match the this example:
    if [ "$?" = 0 ]; then
      cd "$DIR/tomcat/bin"
      export CATALINA_OPTS="-Xms4096m -Xmx6144m -XX:MaxPermSize=256m -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000"
      env JAVA_HOME=$_PENTAHO_JAVA_HOME sh ./startup.sh
    fi
  6. Save the file and close the text editor.
  7. Make the init script executable.
    chmod +x /etc/init.d/pentaho
  8. Add the Pentaho init script to the standard run levels by using the update-rc.d command, so that it runs when the system starts, and stops when the system is shut down or rebooted. This command may not exist on your computer if it is not Debian-based. If that is the case, consult your distribution documentation or contact your distribution's support department to determine how to add init scripts to the default run levels.
    update-rc.d pentaho defaults