ERP/2.50/Openbravo ERP Installation

Contents 1 Introduction 2 License 3 Community Appliance 3.1 General information 3.1.1 Included software 3.1.2 Minimum requirements and image details 3.1.2.1 VMware appliance 3.1.2.2 Xen appliance 3.1.2.3 QEMU appliance 3.1.2.4 Parallels appliance 3.1.2.5 VirtualBox appliance 3.1.3 Logging into Openbravo ERP 3.1.4 Linux passwords 3.1.5 Direct database access 3.1.5.1 Linux, MAC and *BSD 3.1.5.2 Windows 3.1.6 Misc 3.2 Installation and usage 3.2.1 Common steps 3.2.2 VMware 3.2.3 Xen appliance 3.2.3.1 Running on Amazon EC2 3.2.4 QEMU appliance 3.2.5 Parallels appliance 3.2.6 VirtualBox appliance 4 Custom Installation 4.1 System Requirements 4.1.1 Operating Systems 4.1.2 Architectures 4.1.3 Databases Supported 4.1.4 Stack required 4.2 Deployment Topology 4.3 Technology Stack Installation 4.4 Downloading Openbravo ERP 4.4.1 Downloading the tarball 4.4.2 Mercurial clone 4.5 Openbravo ERP Installation 4.5.1 Editing the Configuration files 4.5.2 Compilation 4.5.3 Database cleanup 4.5.4 Configuration Validation 5 Using Openbravo ERP 5.1 Logging into Openbravo ERP 6 Configuring Openbravo ERP 6.1 Installing a translation 6.2 Configuring the default date and time formats 6.3 Configuring the default numbering format 7 Upgrading from previous versions 8 Openbravo ERP FAQ 9 Support

Introduction

This article describes the installation procedure for Openbravo ERP 2.50.

In this release, you can install Openbravo ERP following two different approaches:

• Community Appliance (recommended): you can download and install a fully configured appliance that runs in your preferred virtualization environment. The appliance includes both Openbravo ERP as well as its underlaying technology stack and allows you to get started with Openbravo ERP in just a few minutes and with only a few clicks.

• Custom installation (experts only): a custom installation gives you full control over your deployment environment and allows you to choose your preferred configuration for the technology stack. However, it requires you to install and configure all components of the technology stack as well as compiling Openbravo ERP from sources.

License

Openbravo ERP is licensed under the Openbravo Public License Version 1.1:

The contents of this file are subject to the Openbravo Public License Version 1.1 (the "License"), being the Mozilla Public License version 1.1 with a permitted attribution clause; you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.openbravo.com/product/legal/license/.

Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.

The Original Code is (C) Openbravo ERP. The Initial Developer of the Original Code is Openbravo SL. All portions are Copyright (C) 2001-2008 Openbravo SL. All Rights Reserved.

Community Appliance

A virtual appliance is a minimally preinstalled and preconfigured application and operating system, designed to run under VMware, Xen or any other virtualization technology. The Openbravo ERP project provides virtual appliances to simplify the evaluation process. For that purpose, these appliances include a sample database client called BigBazaar.

The appliance images are available at the SourceForge download area.

General information

Included software

The appliances include the following software:

• Openbravo ERP 2.50MP1.
• PostgreSQL 8.3.7 with ossp-uuid support, version 1.6.2.
• Sun JDK 1.6.0_14.
• Apache Ant 1.7.1.
• Apache httpd 2.2.9.
• Apache Tomcat 6.0.18.
• Tomcat Native 1.1.16.
• mod_jk 1.2.27.
• APR 1.2.12.
• OpenSSH 4.9p1 (client and server).

Minimum requirements and image details

VMware appliance

• Supported versions: VMWare Player 1.x, 2.x, VMware Server, VMware WorkStation or VMware Fusion.
• File name: OpenbravoERP-2.50-x86.vmware.zip.
• Allocated free space: 2GB.
• Allocated RAM memory: 512MB.
• Allocated swap space: 128MB.
• Networking: bridged.

Xen appliance

• Supported versions: Xen 3.0.3 or higher. Can be deployed to Amazon EC2.
• File name: OpenbravoERP-2.50-x86.xen.tar.gz
• Allocated free space: 2GB.
• Allocated swap space: 128MB.

QEMU appliance

• Supported versions: QEMU 0.8 or higher. Optionally use KQEMU to increase performance.
• File name: OpenbravoERP-2.50-x86.qemu-parallels.zip.
• Allocated free space: 2GB.
• Allocated swap space: 128MB.

Parallels appliance

• Supported versions: Parallels Workstation, Desktop or Server.
• File name: OpenbravoERP-2.50-x86.qemu-parallels.zip.
• Allocated free space: 2GB.
• Allocated swap space: 128MB.

VirtualBox appliance

• Supported versions: VirtualBox or VirtualBox-OSE.
• File name: OpenbravoERP-2.50-x86.virtualbox.zip.
• Allocated free space: 2GB.
• Allocated swap space: 128MB.

Logging into Openbravo ERP

1. At the end of the boot process, a message appears indicating the IP address you need to launch Openbravo ERP. In your chosen web browser, type that IP address into the address box. The login screen appears.
2. In the Username box, type Openbravo
3. In the Password box, type openbravo

   Both the username and password are case sensitive.

Linux passwords

• root access: passwordless, log in as root and set the password with 'passwd'. One cannot ssh as root until this password is set.
• SSH access: username openbravo and password openbravo.

Note that these passwords are not used to login to Openbravo ERP, but in Linux.

Direct database access

For security reasons the appliance runs a firewall (iptables) that blocks every external access except to the SSH (22), HTTP (80) and HTTPS (443) ports. So in order to connect to the database using an external tool, such as PgAdmin3, it is necessary to establish a SSH tunnel, described as follows.

Linux, MAC and *BSD

1. Open a command-line terminal and type the following command, replacing ip_address with the correct IP address:

   ssh -N -L 5433:localhost:5432 openbravo@ip_address

   This forwards the appliance's PostgreSQL port into the 5433 port of the user's local client machine, tunneled over a SSH connection.

2. Type the openbravo user password and leave this terminal open.
3. Open the PostgreSQL client (e.g. PgAdmin3), specify the following connection settings and click OK:
   • Name: OpenbravoERP
   • Host: localhost
   • Port: 5433
   • Username: tad
   • Password: tad

The connection will be available as long as the previous SSH connection is opened.

Windows

Use PuTTY to connect to PostgreSQL in Windows. PuTTY is an open source and free SSH client:

1. Select Session.
2. In the Host Name box, enter IP Address of the Openbravo Network machine.
3. Select Connection > SSH > Tunnels.
4. In the Source port field, enter 5433.
5. In the Destination field, enter localhost:5432.
6. Click Add.
7. Click Open to open the SSH connection.
8. Type the openbravo user name and its password and leave this terminal open.

Misc

• The tomcat context is located in /var/lib/tomcat/webapps/openbravo.
• Web Services can be installed by logging-in as the openbravo SSH user and running:

  $ ant installWebService

• The Tomcat manager URL is the following one: http://<ip_address>/manager/html

The Manager username is admin and the password openbravo.

Installation and usage

Common steps

In general, the process of running Openbravo ERP on a virtual appliance are as follows:

1. Download a virtualization program. See below for specific instructions on VMware, Xen, QEMU, Parallels and VirtualBox.
2. Download the virtual appliance and open it with the virtualization program.
3. The following message is shown at the end of the boot process, indicating the URL to access Openbravo ERP with your web browser:

   Welcome to Openbravo ERP Community

   To login to Openbravo ERP use your web browser to go to http://<IP_ADDRESS>

VMware

Use VMware Player (freeware) to run pre-built virtual machines on your desktop. To run the Openbravo appliance, follow these steps:

1. Download and install VMware Player. There are versions for Microsoft Windows and Linux. VMware Fusion is the Macintosh version.
2. Download the latest version of the Openbravo VMware image and unpack the files.
3. Run VMware Player (or VMware Fusion on a Mac).
4. Select the decompressed .vmx file.

If there is DHCP on your network, no further steps are required. The final boot message within the virtual machine play window will show the URL to access Openbravo ERP from your browser.

If your network does not have DHCP you can either:

• Create an internal subnet. Through which you will be able to access the virtual machine. Openbravo ERP cannot access the Internet via an internal subnet.
• Specify a fixed IP address and gateway.

To create an internal subnet:

1. Launch the VMware player.
2. Change the network adapter options from Bridged to NAT.
3. Restart the virtual machine.

To set a fixed IP address and gateway:

1. Log in as root (passwordless)
2. Type the following commands to set a specific ip IP_ADDRESS and a gateway IP_GATEWAY:

   $ /sbin/ifconfig eth0 IP_ADDRESS netmask 255.255.255.0 up
   

   $ /sbin/route add default gw IP_GATEWAY

3. Finally to make the IP address available to the Internet, assign some DNS servers to it:

   $ echo "nameserver IP_DNS1" >> /etc/resolv.conf
   

   $ echo "nameserver IP_DNS2" >> /etc/resolv.conf

4. To launch Openbravo ERP, launch your chosen web browser and type 'http://<IP_ADDRESS>' into the address box, where 'IP_ADDRESS' is the IP address you specified in step 2.

Xen appliance

Xen is an open source and free virtualization software. To run the Openbravo ERP appliance within Xen, follow these steps.

Running on Amazon EC2

To deploy the Xen appliance into Amazon EC2, follow these steps. Make sure all the environment variables are correctly configured:

1. Bundle the image using the following command:

   $ ec2-bundle-image -i OpenbravoERP-2.50MP1-x86.ext3 -r i386 -k $EC2_PRIVATE_KEY -c $EC2_CERT -u $EC2_USER_ID

2. Upload the image into a Amazon S3 bucket:

   $ ec2-upload-bundle -b OpenbravoERP -m /tmp/OpenbravoERP-2.50MP1-x86.fs.manifest.xml -a $EC2_ACCESS_KEY -s $EC2_SECRET_KEY

3. Register the image:

   $ ec2-register OpenbravoERP/OpenbravoERP-2.50MP1-x86.fs.manifest.xml
   

   ami-xxxxxx

4. Use the ami-xxxxxx returned by this command to run the instance:

   $ ec2-run-instance ami-xxxxxx

QEMU appliance

The installation and its networking configuration are out of the scope of this document. Assuming it is ready, run the following command:

$ qemu -hda OpenbravoERP-2.50MP1-x86.qemu-parallels -m 512 -net tap -net nic

Parallels appliance

Decompress OpenbravoERP-2.50-x86.qemu-parallels.gz and open the OpenbravoERP-2.50-x86.qemu-parallels file with Parallels.

VirtualBox appliance

• Decompress OpenbravoERP-2.50-x86.virtualbox.gz, this will result in the OpenbravoERP-2.50-x86.virtualbox.vdi file.
• Open VirtualBox and click on Machine -> New. Enter Openbravo ERP Community in the Name and select Linux 2.6 in OS Type. Click on Next.
• Select 512MB of Base Memory Size. Click on Next.
• Click on Existing to add the image. Then Add, and browse to select the OpenbravoERP-2.50-x86.virtualbox.vdi file. Click on Select, then on Next and finally in Finish.

In order to use Openbravo ERP it is necessary to access the virtual appliance through the network. There are two options here:

• Use VirtualBox version 2.2 or higher, edit the preferences of the virtualmachine you just created and select Bridge in the network settings. This is the recommended method.
• Forward (NAT) the http port (80) from the virtual appliance to a random port (8000) in the host machine. This is easier to do than the previous method, and it is recommended for testing. Run the following commands:

$ VBoxManage setextradata "Openbravo ERP Community" "VBoxInternal/Devices/pcnet/0/LUN#0/Config/guesthttpd/HostPort" 8000
$ VBoxManage setextradata "Openbravo ERP Community" "VBoxInternal/Devices/pcnet/0/LUN#0/Config/guesthttpd/GuestPort" 80
$ VBoxManage setextradata "Openbravo ERP Community" "VBoxInternal/Devices/pcnet/0/LUN#0/Config/guesthttpd/Protocol" TCP

Where "Openbravo ERP Community" matches with the name given to the appliance in its creation.

Afterwards it is necessary to shut down VirtualBox and start the appliance again. Then, to access Openbravo ERP enter http://localhost:8000 in a web browser.

Custom Installation

A custom installation provides you with maximum deployment flexibility and full control over the technology stack and its configuration. However, it can be laborious and requires a high degree of experience.

For this reason, we recommend to novice users not to attempt custom installations and to instead evaluate Openbravo ERP using the Community Appliance.

System Requirements

Operating Systems

• Microsoft Windows 2000, XP*, Vista
• Linux
  • Ubuntu *
  • rPath *
  • CentOS
  • Debian
  • Gentoo
  • openSUSE
  • Red Hat
• FreeBSD
• Mac OS X
• OpenSolaris
• Solaris 10

* Openbravo only tests these versions. If you want to help testing the versions in other platforms please write to the Early Releases Discussion forum to coordinate your efforts with the other releases.

Architectures

• x86 *
• x86_64 *
• IA-64
• Sparc
• PowerPC
• AIX

* Openbravo only tests these architectures. If you want to help testing other architectures please write to the Early Releases Discussion forum to coordinate your efforts with the other releases.

Databases Supported

• Oracle 10g R2 or 11g, Standard or Enterprise editions (11g recommended).
• PostgreSQL 8.3.5 or higher.

Stack required

• Java 2 Platform Standard Edition 6.0 or higher.
• Apache-Tomcat 5.5 or higher (6.0.x recommended).
• Apache-Ant 1.7.0 or higher (1.7.1 recommended).

Deployment Topology

A custom installation allows you to choose your preferred deployment topology, depending on your data volume and user load:

• Single server.
• Dual server, with one database server and one application server.
• Multi-server, with multiple servers running a database RAC and multiple application servers with a load balancer.

Technology Stack Installation

You can optimize your installation of Openbravo ERP, depending on how you intend to use it:

• For production environments, follow these steps.
• For development environments, follow these steps.

Downloading Openbravo ERP

You can to obtain a copy of the source code by either:

• Downloading a source code tarball.
• Checking out the source code from the Openbravo Mercurial repository.

Downloading the tarball

You can download a tarball of the Openbravo ERP source code from SourceForge.

Once the download is complete, you can extract the code with the following command:

tar -xvf OpenbravoERP-2.50xx.tar.bz2

Mercurial clone

1. To be able to check out Openbravo ERP source code from Openbravo Mercurial repository you need to first install the Mercurial client.
2. Once the Mercurial client is installed, move to the directory to which you want to check out the source code.
3. To check out the latest source code tag, type the command:

   hg clone http://code.openbravo.com/erp/devel/main OpenbravoERP-2.50
   

   hg up 2.50

Openbravo ERP Installation

Once you have obtained the source code follow these steps to install it.

Editing the Configuration files

1. Move to the OpenbravoERP-2.50alpha-rX in a command line terminal and run ant setup.
2. Move to the OpenbravoERP-2.50alpha-rX/config directory.
3. Access the graphical configuration wizard:
   • Linux: make executable and run setup-properties-linux.bin
   • Windows: run setup-properties-windows.exe
4. Configure the Openbravo.properties and log4j.lcf files using the configuration wizard.

These configuration wizard can also run in text mode without a graphical system. It will detect the correct display mode for your system.

Compilation

Before starting with compilation, check that Openbravo.properties and log4j.lcf files (in the config directory) have been properly configured. If not, edit them manually.

1. In the command line type:

   ant install.source

   The ant install.source command creates the database from *.xml files and installs Openbravo ERP.

2. If you have explicitly selected war as the deploy.mode during the setup, you must deploy the openbravo.war file into the Apache Tomcat context directory using the command:

   ant deploy.context

   Note that this step is not needed if you selected the default options.

Database cleanup

If you are using PostgreSQL database, you must clean the database before you access Openbravo ERP to prevent performance issues. Use the command:

vacuumdb -f -z -h ''hostname'' -d ''dbname'' -U ''username''

Replacing hostname with the actual hostname of your DB server, dbname with the database name (by default openbravo), and username with the name of the DB user (by default tad).

Configuration Validation

Before you access your Openbravo instance, it is strongly recommended that you run the following command to validate your system configuration:

ant diagnostic

Using Openbravo ERP

Logging into Openbravo ERP

1. Open your chosen web browser.
2. In the address bar, type the context URL. The context URL takes the form:

   http://hostname:port/context_name

   For example:

   http://localhost:8080/openbravo

3. The Login screen appears:

   

4. In the Username box, type the default username Openbravo.
5. In the Password box, type the defalt password openbravo.
6. Click Login. Openbravo ERP starts.

   

Login troubleshooting: If the error page HTTP Status 404 - File not found appears instead of the Login page, it means that there is a problem with the context URL. Check that the your_context_name directory has been created inside the Apache Tomcat webapps directory.

Note: the first time you log into Openbravo ERP, the system logs you on using the System Administrator role, so you can only see administration tasks on the Application menu. If you try to access business options (for example Business partners, products and sales and procurement orders) the message AccessTableNoView will display instead. To access business options, you must change your role to an Admin role, such as BigBazaar Adminor Openbravo Admin.

1. Click the Openbravo link in the upper left hand corner of the window. The User Options window appears.

   

   From the Role Information menu, select an Admin role (Openbravo Admin or BigBazaar Admin).

2. To set the Admin role as default, select the Set as default checkbox.

Configuring Openbravo ERP

After Openbravo ERP is properly installed and running, you can customize it to suit your country or region.

Installing a translation

Openbravo ERP supports different languages. To translate the application into your language, download a translation.

Configuring the default date and time formats

To change the default Openbravo ERP date format launch the setup tool inside the config/setup-tool directory.

Once all the changes are done, recompile and deploy Openbravo ERP:

ant compile.complete.deploy

Configuring the default numbering format

You can modify the way numbers are displayed in reports for example whether , or . is used as the decimal point.

1. In the directory where Openbravo ERP is installed, navigate to the config folder.
2. Using a text editor edit the Format.xml file.
3. Modify the default numbering formats as required.
4. Save the Format.xml file
5. Restart the Tomcat service.

Upgrading from previous versions

An upgrade path is available from the 2.40 series to 2.50. To update from 2.50 to the latest 2.50 maintenance pack (e.g. 2.50MP1) download the Core OBX module and apply it using the Module Management Console inside Openbravo ERP.

Community Appliance users who want to upgrade their appliance should first increase the system RAM memory to 1024MB at least. And due to a bug in the 2.50 appliance delete the /opt/AppsOpenbravo/README file before launching the upgrade.

Openbravo ERP FAQ

Openbravo's ERP Frequently Asked Questions (FAQ).

Support

For any question or doubt regarding Openbravo ERP installation, post them in Openbravo Help forum or join #openbravo IRC channel in Freenode.

Category: Installation ERP