Installing ADempiere Manually

From ADempiere ERP Wiki

Jump to: navigation, search

Table of Contents | Getting Started | Installing ADempiere Manually | Launching the ADempiere Application

Contents

General Installation Instructions

The installation process is similar across operating systems with a few minor exceptions.

This installation instruction is intended for initial installations where the database, application server and client all run on the same machine and a desktop or GUI interface is being used.

  • For more complex installations or command-line installations, see Installation Steps.
  • If you already have an ADempiere installation running and you want to update to a newer version, see Upgrading and Migration.

An installation can take as little as 15 or 20 minutes.

Downloads

Before you begin, download each of the following packages:

Install the Pre-Requisites

JAVA

Install the JAVA JDK with the default installation settings. Say OK to install the follow-on JRE as well. Carefully note the full path for the JDK directory (e.g: C:\Program Files\java\jdk1.5.0_19) and the JRE directory that you have just installed.

Image:Note.gif Note:

There may well be a number of JDK and JRE directories, so choose the right one! The JDK should include the JRE.

The ADempiere scripts rely on the existence of a system environment variable JAVA_HOME. When the scripts call java, they use the full path as $JAVA_HOME/bin/java so it is important that this variable exist.

Following the instructions for your system, add a new System Variable JAVA_HOME for your new JDK directory:

JAVA_HOME use C:\Program Files\Java\jdk1.7.0_25 (or whatever your JDK directory is called)
Append the following JDK path to the system path: %JAVA_HOME%\bin or $JAVA_HOME/bin

Database

Image:Note.gif Note:

You can use an existing Oracle or PostgreSQL database if you already have one installed. If so, gather the passwords for the postgres or system user, check the environment variable and path, verify that the service is running and move on to the next step.

Install database software according to the installation instructions for your system using the defaults to keep things simple. Keep track of passwords and ports since you will need this information in the ADempiere setup.

The ADempiere scripts will need to find the database command line utilities, so set your path to point to the "bin" directory of the database install. You can do this in the same way JAVA_HOME was used above. Create an environment variable such as DATABASE_HOME set to the database install directory, and add DATABASE_HOME/bin to your path according to the methods for your system.


Image:Caution.gif Caution!

If for some twisted reason you also have Oracle running on the same machine as PostgreSQL, be aware that the two databases include some executables with the same name. If you have both POSTGRES_HOME and the equivalent ORACLE_HOME on the path, you might have errors when running some of the ADempiere scripts. Try to keep the path pointing to one or the other database at a time and switch between the two as required.

Install the ADempiere Software

There is no install script. Just extract the ADempiere archive to a suitable location: (e.g. c:\ or /u01/). For reference, call this directory $ADEMPIERE_ROOT. You should end up with the files in a folder like $ADEMPIERE_ROOT\Adempiere. For reference, call this folder $ADEMPIERE_HOME.

Image:Note.gif Note:

Avoid spaces in the directory path. The batch scripts do not like directory names with spaces. If using a $ADEMPIERE_ROOT with multiple directories, avoid directory names with spaces.

Apply the Patches

Patches are a combination of *.jar files, which replace *.jar files in the $ADEMPIERE_HOME\lib directory, and migration scripts which update the database. In the Patches directory on Source Forge, there may be more than one type of *.jar that needs patching. If you downloaded one or more patch files, replace the existing file with the downloaded one, changing its name to match. For example, copy the *_patches_*.jar file to $ADEMPIERE_HOME\lib\patches.jar, overwriting the existing file. See the detailed instructions in Patches Installation.

Image:Note.gif Note:

It is a good idea to rename the existing *.jar file to something like patches.jar.old before you replace it with the the new file

Apply Customizations, Packages and other Files

If you have a customization.jar with customized code or a packages.jar file with supporting *.jar files, add them to the $ADEMPIERE_HOME\lib directory, overwriting the existing files.

Initial ADempiere Setup

A setup utility in ADempiere will prepare the software for use and create environment variables needed in the following steps.

Image:Note.gif Note:

The setup utility will need to make changes to environment variables. Execute the utility with sufficient permissions to do so.

Navigate to $ADEMPIERE_HOME and execute RUN_setup.[sh|bat].

Image:Note.gif Note:

In linux systems you may need to change the executable rights of the *.sh files in the $ADEMPIERE_HOME directory.

If this is the first time you are installing ADempiere, a licence and security keys dialogs will appear. Accept the defaults.

The setup dialog will appear.

You will need to change:

  • Database Server from <your-computer-name> to localhost
  • Database Type according to your installed database: oracle, oracleXE or postgresql
  • Database Name from xe to adempiere (You can use another name here if you like)
  • DB Admin Password to postgres (or whatever you entered above for the database administrator)
  • Database Password to adempiere
  • Don't change anything in the Mail Server settings. These can be set up later.

You may also need to change the following:

  • Adempiere Home to $ADEMPIERE_HOME (e.g. C:\Adempiere) if somehow it has been set to the wrong location
  • Application Server Web Port to 8080 and SSL to 8443 (instead of 443). Access to port 80 and 443 is often restricted to system administrators. If ports are already in use, you can choose other open ports. Check for your system how to find open/available ports.

Press the Test button

When the Test completes without errors and the Save button (bottom, right) is activated, click the Save button. Wait a few minutes until the Adempiere Server Setup screen disappears and the deployment is finished.

Image:Note.gif Note:

The database does not have a user adempiere or a database adempiere at this point, so these tests will not be checked. The user and database will be created in the next step.

If you are having problems, see the detailed instructions on this dialog in the pages InstallServer and ServerSetupHelp

Image:Note.gif Note:

The setup process will have created several files in the $ADEMPIERE_HOME and $ADEMPIERE_HOME\utils directories with names like adempiere.properties, adempiereEnv.properties and myEnvironment.bat. The adempiere.properties file can be copied to a new name and a different properties file created to, for example, create a sandbox version of the database with a database name like adempiere_sandbox.

Import ADempiere Data

Image:Caution.gif Caution!

The following script will DROP any existing adempiere database. Do not run this command if you already have data loaded.

In a shell, navigate to $ADEMPIERE_HOME\utils and execute 'RUN_ImportAdempiere.[sh|bat]'.

See CreateDatabase for more information.

Apply Migration Scripts

The database installed above will be at the state of the release version and will have all migration scripts applied. You may need to apply migration scripts which were downloaded with the patches.

If you are not installing patches, skip this step.

SQL - Prior to Release 3.8.0

The migration scripts can be found in the *_migra_*.[zip|tar] file downloaded above. Unzip the contents to a convenient directory. The scripts can be applied in a number of ways, using database tools or the command line. Refer to the documentation for your database.

XML - Since Release 3.8.0

The XML migration scripts to apply should be saved in the $ADEMPIERE_HOME\migrations directory. These scripts will be included in *_migra_*.zip file. Unzip the contents to $ADEMPIERE_HOME\migrations. To apply the scripts, execute the command $ADEMPIERE_HOME\utils\RUN_MigrateXML.[sh|bat] from a shell.

Run ADempiere

Start the Application Server

In a shell, navigate to $ADEMPIERE_HOME\utils. Execute 'RUN_Server2.[sh|bat]' and wait for the server to fully start - it will end this phase with "INFO [Server] JBoss .... Started in xx:xx:xx ms", which will take around 30 seconds to 3 minutes depending on your computer.

Starting the Application Server Automatically

In Windows, if you would like to run the server as a service, in a shell, navigate to $ADEMPIERE_HOME\utils\windows and run Adempiere_Service_Install.bat. You will need to open the Services Window (Control Panel→Administrative Tools→Services) to set the properties so the service starts automatically or manually. Note that this won't work Windows Server 2013 until the ADempiere software is upgraded.

In linux, you can use nohup or an equivalent tool.

Launching the ADempiere Application

'Congratulations!'

At this point, your installation is complete and you can move on to Launching the ADempiere Application.

Uninstall or Revert to Previous Version

To uninstall the software, simple delete the $ADEMPIERE_HOME directory. To delete the database, use the database administrator to drop the adempiere database and user.

To revert to the previous version, delete the $ADEMPIERE_HOME directory and copy the previous version to $ADEMPIERE_HOME. Restore the backed-up copy of the database using $ADEMPIER_HOME\utils\RUN_DBRestore.[sh|bat].

System Specific Installations

The following links provide detailed instructions for manual installations on various operating systems.

Windows

Linux-General

Linux-Debian/Ubuntu

Linux-RedHat/Fedora

Linux-Other

Open Source OS

IBM

Other

Installation From Trunk (SVN)

OS and DB Setup

Step By Step Series

contributed by Alejandro Falcone

Application Server Setup

Personal tools