Application Server Installation & Setup

From ADempiere
Revision as of 05:46, 24 December 2010 by MJMcKay (Talk) (Added field descriptions.)

Jump to: navigation, search
This Wiki is read-only for reference purposes to avoid broken links.

Table of Contents#System Administrator's Guide{{#if: Installation Details| | Installation Details }}{{#if: Installation Steps| | Installation Steps }}{{#if: | | [[{{{4}}}]] }}{{#if: | | [[{{{5}}}]] }} | Application Server Installation & Setup{{#if: | | [[{{{next}}}]] }} ⇒

This page is directed at System Administrators who need to install the ADempiere Application Server in a network environment where the database server could be running on a separate network server and the clients run on remote computers. For simple installations where application server, database server and client are all on the same machine, see Getting Started.

Pre-requisite Utilities

Before continuing, ensure you have installed a suitable database (i.e. Oracle 10g, Oracle 10gXE, PostgreSQL, MySQL) and that the database server is running. See Database Server Installation & Setup.

Start

The ADempiere software contains all the components necessary to create a stand alone application server. For a fresh install, follow the instructions for your operating system in Installing ADempiere Manually but ignore the installation of the database, which you have already done, and return here when you are first requested to RUN_Setup.bat/sh.

Setting Up The ADempiere Server

The Application Server is configured by a utility RUN_Setup.(sh/bat) found in the ADEMPIERE_HOME directory. This utility launches a tool where the configuration settings can be set and tested. Once everything passes the tests, the configuration is saved and the software repackages itself with the new settings. You can then launch the Application Server.

You can rerun this utility as many times as you like until everything is correct.

Note.gif Note:

In case you are changing settings on an existing Application Server, make sure that the Application Server is shut down before you start. Otherwise you will get port errors during the testing. You can shut down the Application server by running the script RUN_Server2Stop.(sh/bat) from ADEMPIERE_HOME/utils or by stopping the "service".

In a command shell with administrative privileges, run the script RUN_Setup, located in the ADEMPIERE_HOME directory. The ADempiere Server Setup window should appear as shown below:

 

IS ServerSetup.PNG

 

The Setup window opens and loads its values from the file AdempiereEnv.properties. It looks for this file in the ADEMPIERE_HOME directory. If the environment variable ADEMPIERE_HOME is not set or is null, it will look in the directory defined in the system property "user.dir".

Fill in the setup window fields as follows:

  • Java
    • Java Home: select the SDK Java Home location (e.g. C:\jdk1.5.0_05). This should be the same as the JAVA_HOME environment variable.
    • Java VM: the Java Virtual Engine Vendor (Default= Sun).
  • Adempiere
    • ADempiere Home: is the base directory where the distribution files are located (e.g. C:\Adempiere). This should be the same a the ADEMPIERE_HOME environment variable.
    • KeyStore Password: ADempiere requires a SSL certificate. It automatically creates a certificate in the key store $ADEMPIERE_HOME/keystore/myKeystore with the keystore password entered. The self certified certificate created has the alias adempiere and uses the same password as the keystore. You can replace the certificate used with the Java "keytool" (see Java tool documentation).
  • Application Server
    • Application Server: is the name, URL or IP of your server PC (Don't use localhost). The Application Server defaults to the server currently running the program. Avoid using IP addresses - use the DNS name of the server.
    • Web Port: The web port that the Application Server will listen on. Access to the application server will be through a URL similar to http://myApplicationServer:webport (http://appserver:8088). Please keep in mind that, under Linux/Unix, ports under 1000 need root privileges. The default ports are:
  • 80 for http connections and
  • 443 for SSL connections.
If you use Apache as a front end, you could use port 8080. Your options are to use another Web port, e.g. 8888. If you are using Oracle and depending of your setup, port 8080 might be used.
    • SSL: The secure socket layer port. Defaults are 443. If that is not available try another value such as 8443.
    • JNP Port: The Java Name Provider and Remote Method Invocation(RMI) port. The Default ports are 1099 (1098).
  • Database Server
    • Database Server: The Database Server defaults to the server currently running the program. Avoid using IP addresses - use the DNS name of the server. Localhost can be used only if the database server is running on the same machine as the Application Server and client software.
For Oracle, the Service names are discovered. You can overwrite the entries if they are not correct.
    • Database Name:
  • PosgreSQL: PostgreSQL database name
  • Oracle: SID/Service name. Oracle 10g/11g default: orcl, OracleXE default: xe
    • Database Type: select the database you have installed (i.e. Oracle 10g, Oracle 10gXE, PostgreSQL).
    • Database Port: select the port for connect to database.(i.e. Oracle use 1521 as standard port, PostgreSQL 5432, etc.)
    • System Password:
  • Oracle: Password for the system user.
  • PostgreSQL: Password for the postgres user.
    • Database User: The application database user name, default is adempiere.
    • Database Password: The application database password, default is adempiere.
  • Mail Server
The EMail connection here is used as the default. You maintain the EMail connection in the Application on a Client basis.
It is not required that at this point, the program can read your emails. But, you need an IMAP server for Request processing.
If you don't want to enter or don't have an SMTP server, just enter a valid server. If the server exists, but does not provide POP3, SMTP or IMAP, the setup finishes successfully. :If the server is invalid, then fails.


Some Common Issues & Remedies

  • Application Server * Database Server is the name, URL or IP of your server PC.
  • JNP Port = 1099 error means that a previous service is running. Kill it. Also, since this is the first port that is tested, it could also mean that you have a mismatch between your host name (in the hosts file) and your actual IP address. Fix it in "/etc/hosts" (linux)
  • Database Port = 1521 error can be solved by restarting DB machine.
  • System & Database Passwords are those defined when you setup your Database.
  • Mail Server is optional. RUN_Setup can still finish without it.

After you fill it, press the Test button in order to verify them. Please note until the parameters are verified, you will not be able to save them. If an entry cannot be verified, a pop-up window stating the error will be displayed. Fix it and test again. By example, the Application Server name is wrong, then you will see a message such as:

IS ServerSetupError.PNG

When you can see the test was ok (you can see the boxes checked: √ ) ,

IS ServerSetupOK.PNG
  • then press the Save button.
  • After you accept the license, you will see the dialog:
IS EnvironmentSaved.PNG
  • Press the OK button to continue and take a look into the log. Make sure that you see the BUILD SUCCESSFUL and Done, such as:
     [echo] AppsDeployment= C:\Adempiere\jboss\server\adempiere\deploy
     [copy] Copying 1 file to C:\Adempiere\jboss\server\adempiere\deploy
     [copy] Copying 1 file to C:\Adempiere\jboss\server\adempiere\deploy
     [copy] Copying 1 file to C:\Adempiere\jboss\server\adempiere\deploy
     [copy] Copying 1 file to C:\Adempiere\jboss\server\adempiere\deploy

 setupTomcat:

 setupDeploy:
     [echo] AppsDeployment= C:\Adempiere\jboss\server\adempiere\deploy

 setup:
 
BUILD SUCCESSFUL
Total time: 2 minutes 22 seconds

*** 2006-12-28 14:15:35.53 Adempiere Log (CLogConsole) ***
ErrorLevel = 0
===================================
Setup Client Environment
===================================
SET ADEMPIERE_HOME=C:\Adempiere
SET JAVA_HOME=c:\Archivos de programa\Java\jdk1.5.0_05
Path is OK = c:\Archivos de programa\Java\jdk1.5.0_05\bin;C:\Archivos de programa\Java\jdk1.5.0_05\
bin;C:\oraclexe\app\oracle\product\10.2.0\server\bin;%SystemRoot%\system32;%SystemRoot%;
%SystemRoot%\System32\Wbem
Created Shortcut Adempiere.lnk
Created Shortcut Adempiere Web Site.url
Done
.
For problems, check log file in base directory

If something is wrong, you can repeat this step anytime until everything is correct. It has no impact on a running or live ADempiere system.

Other Common Issues

Java Home Error

If you receive the following message:

IS JAVA HOME ERROR.PNG

You should check your java environment variables. Maybe you must set the JAVA_HOME system environment variable.

Web Port 80 Error

If you receive the following message from the installer:

Adempiereerror1.png

Maybe you have some other web server running (or if your are using Linux you need privileges). The default ports are: 80 for http connections and 443 for SSL connections. The message that you got, means that user is not allowed to use those ports (maybe those are used), so they need to be changed. WebPort 8088 and SSL 4443 are recommended. If you are using Linux, remember that ports under 1000 need root privileges. If you are using Oracle database, port 8080 might be used.

JNP Port 1099 Error

Another possible error is Server Setup Error Error JNP Port (Not correct: JNP Port = 1099) OK

If you recieve an JNP Port = 1099 error it might be caused by another process already attached to that TCP port. Take a look what process is using this port and so you can take steps to stop it.

It can also be caused by a mismatch between your IP address and the entry in your hosts file. See /etc/hosts(linux) or %SystemRoot%/system32/drivers/etc/hosts(windows). (/sbin/ifconfig = retrieve IP address on linux, IPCONFIG = WINDOWS)

JNP Name Not Found Exception

This error is usually related to a dns problem, it is possible to complete the setup using ip adresses when installing with postgresql. Make sure you have a working dns environment. If you should not have a dns server, you can always add an entry in /etc/hosts(linux) or %SystemRoot%/system32/drivers/etc/hosts(windows).

Links