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.
Your application server determines the sequence of steps to complete this task:
- If you are using JBoss, go to Step 3.
- If you are using Tomcat, omit Step 3.
Step 1: Modify the Tomcat startup script
The Tomcat startup script must be modified to include the CATALINA_OPTS variable.
Perform the following steps to include the CATALINA_OPTS variable:
Procedure
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.Use a text editor to open the startup.bat file, which is in the pentaho\server\pentaho-server\tomcat\bin directory.
Add this line before the CATALINA_HOME section:
SET DI_HOME=%~dp0..\..\pentaho-solutions\system\kettle
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%
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.
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 to the end of the path. For example: (C:\Pentaho\server\pentaho-server\tomcat\bin |
Java | Initial Memory Pool | 2048 |
Java | Maximum Memory Pool | 6144 |
Java | Java Option |
Add the following items:
|
The following examples are possible values for the Java options:
-DDI_HOME=C:\Pentaho\server\pentaho-server\pentaho-solutions\system\kettle
-Dpentaho.installed.licenses.file=C:\Pentaho\.installedLicenses.xml
-Dfile.encoding=utf8
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:
Procedure
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.
Use a text editor to open the standalone.bat file, which is in the bin subdirectory of your JBoss home directory.
Locate "x%JBOSS_HOME%" == "x" ( and copy the following text above it:
pushd "%DIRNAME%..\.." set "INSTALL_HOME=%CD%" popd SET DI_HOME=%INSTALL_HOME%\pentaho-solutions\system\kettle
Save and close the file.
Use a text editor to open the standalone.conf.bat file, which is in the bin subdirectory of your JBoss home directory.
Locate
JAVA_OPTS=-Xms1G -Xmx1G -XX:MetaspaceSize=96M:MaxMetaspaceSize=256m
and replace it with the following text:JAVA_OPTS=-Xms4096m \ -Xmx6144m \ -XX:MetaspaceSize=96M \ -XX:MaxMetaspaceSize=256m \ -DDI_HOME=%DI_HOME% \ -Dsun.rmi.dgc.client.gcInterval=3600000 \ -Dsun.rmi.dgc.server.gcInterval=3600000 \ -Dpentaho.installed.licenses.file=%PENTAHO_INSTALLED_LICENSE_PATH%
Save and close the file.
Step 4: Install licenses
Perform the following steps to install the Pentaho licenses on your Windows environment.
Procedure
Download the .lic files you want to install.
Navigate to the
/license-installer/
sub-folder where the Pentaho PDI tool is installed.Copy your
.lic
files to the/license-installer/
folder.Run the
install_license.bat
script with the install switch and the location and name of your.lic
file as a parameter. Be sure to use quotation marks ("
) to escape any spaces in the path or file name.install_license.bat install "C:\Users\username\Downloads\Pentaho BI Platform Enterprise Edition.lic"
Repeat the previous step for all required licenses.
Step 5: Start the Pentaho Server
Perform the following steps to start the Pentaho Server.
If you installed your own web application server, run the startup script for the server by launching the applicable batch file for your server type.
- Tomcat: Launch the startup.bat file, located in the Tomcat bin directory.
- JBoss: Launch the standalone.bat file, located in the JBoss bin directory.
From a workstation, open a web browser and enter this URL: http://localhost:8080/pentaho to access the Pentaho User Console (PUC).
NoteIf your server has a different hostname or port, replace localhost and 8080 with your specific values.
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:
Your application server determines the sequence of steps to complete this task:
- If you are using JBoss, go to Step 2.
- If you are using Tomcat, omit 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:
Procedure
Make sure the Tomcat web application server is not running. Open a Terminal window and type ps -A at the prompt.
-
If the server is running, stop it.
Use a text editor to open the startup .sh file, which is in the pentaho/server/pentaho-server/tomcat/bin directory.
Locate the #Check that target executable exists line and add this code above it.
DI_HOME=<your pentaho directory>/pentaho-solutions/system/kettle
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"
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:
Procedure
Make sure the JBoss web application server is not running. Open a Terminal window and type ps -A at the prompt.
If the server is running, stop it.
Use a text editor to open the standalone.conf file, which is in the bin subdirectory of your JBoss home directory.
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.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 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 \ -Djava.awt.headless=true \ -Djava.io.tmpdir=/tmp/ \ -Dpentaho.installed.licenses.file=$PENTAHO_INSTALLED_LICENSE_PATH
NoteYou 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.Save and close the file.
Locate the bin subdirectory in the JBoss home directory and open the standalone.sh file with a text editor.
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
Save and close the file.
Step 3: Install licenses
Perform the following steps to install the Pentaho licenses on your Linux environment.
Procedure
Download the .lic files you want to install.
Navigate to the
/license-installer/
directory where the Pentaho PDI tool is installed.Copy your
.lic
files to the/license-installer/
directory.Run the
install_license.sh
script 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../install_license.sh install Pentaho\ BI\ Platform\ Enterprise\ Edition.lic
Repeat the previous step for all required licenses.
Step 4: Start the Pentaho Server
Perform the following steps to start the Pentaho Server.
Run the startup script for your web application server by launching one of 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.
-
From a workstation, open a web browser and enter this URL: http://localhost:8080/pentaho to access the Pentaho User Console (PUC).
NoteIf your server has a different hostname or port, replacelocalhost
and8080
with your specific values.