This documentation is for WSO2 Enterprise Service Bus version 5.0.0. View documentation for the latest ESB.
Due to a known issue do not use JDK1.8.0_151 with WSO2 products. Use JDK 1.8.0_144 until JDK 1.8.0_162-ea is released.
Skip to end of metadata
Go to start of metadata

Prior to installing any WSO2 Carbon-based product, it is necessary to have the appropriate prerequisite software installed on your system. Verify that the computer has the supported operating system and development platforms before starting the installation.

The config-validation.xml file in the <PRODUCT_HOME>/repository/conf/etc directory contains a list of recommended system parameters, which are validated against your system when the server is started. See Configuring config-validation.xml for details.

System requirements

Memory

  • ~ 2 GB minimum
  • ~ 1 GB heap size. This is generally sufficient to process typical SOAP messages but the requirements vary with larger message sizes and the number of messages processed concurrently.

Disk

  • ~ 1 GB, excluding space allocated for log files and databases.

Environment compatibility

  • All WSO2 Carbon-based products are Java applications that can be run on any platform that is Oracle JDK 1.7.*/1.8.* compliantWe do not recommend OpenJDK as we do not support it or test our products with it.

    Note

    WSO2 ESB is also compatible with IBM JDK 1.7.*/1.8.*. For more information on JDKs that WSO2 products are tested with, see Tested JDKs.

    If you want to start WSO2 ESB with IBM JDK, edit the <ESB_HOME>/repository/conf/security/Owasp.CsrfGuard.Carbon.properties file and replace the line org.owasp.csrfguard.PRNG.Provider=SUN with org.owasp.csrfguard.PRNG.Provider=IBMJCE.

  • All WSO2 Carbon-based products are generally compatible with most common DBMSs. The embedded H2 database is suitable for development, testing, and some production environments. For most enterprise production environments, however, we recommend you use an industry-standard RDBMS such as Oracle, PostgreSQL, MySQL, MS SQL, etc. For more information, see Working with Databases in the Administration Guide. Additionally, we do not recommend the H2 database as a user store.
  • It is not recommended to use Apache DS in a production environment due to scalability issues. Instead, use an LDAP like OpenLDAP for user management.
  • For environments that WSO2 products are tested with, see Compatibility of WSO2 Products. 
  • If you have difficulty in setting up any WSO2 product in a specific platform or database, please contact us.

Required applications

The following applications are required for running the ESB and its samples or for building from the source code. Mandatory installs are marked with *.

Application

Purpose

Version

Download Links

Oracle Java SE Development Kit (JDK)*

  • To launch the product as each product is a Java application.

    Note

    To launch WSO2 ESB, you need to have Oracle JDK 1.7.*/1.8.* . You cannot launch WSO2 ESB with Oracle JDK 1.6.* or lower.

     

1.7 or later / 1.8.*

Important!

Some updates of JDK 1.8 (for example, JDK1.8.0_151) are affected by a known issue related to GZIP decoding. Until this issue is fixed, we recommend one of the following approaches:

  • Use either JDK1.8.0_144 or JDK1.8.0_077 updates. We have verified that these versions are not affected by the known issue.
  • Alternatively, you can disable GZIP decoding for your product by following the steps given below. This will ensure that your product is not affected by the known issue.
    1. Open the catalina-server.xml file from the <ESB_HOME>/repository/conf/tomcat/ directory.
    2. Set the compression parameter (under each of the connector configurations) to false as shown below:

      compression="off"
    3. Restart the server.
http://java.sun.com/javase/downloads/index.jsp

Apache Ant

1.7.0 or later

http://ant.apache.org

Apache Maven

  • To build the product from the source distribution (both JDK and Apache Maven are required). If you are installing by downloading and extracting the binary distribution instead of building from the source code, you do not need to install Maven.

Web Browser

  • To access each product's Management Console. The Web Browser must be JavaScript enabled to take full advantage of the Management console.

 

On Windows Server 2003, you must not go below the medium security level in Internet Explorer 6.x.

 



You are now ready to install WSO2 ESB. Click one of the following links for instructions:

  • No labels