Installation Prerequisites

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.

System requirements

Physical

3 GHz Dual-core Xeon/Opteron (or latest)
4 GB RAM (2 GB for JVM and 2 GB for the operating system)
10 GB free disk space
~ Recommended minimum - 2 Cores. For high concurrencies and better performances - 4 Cores.

Disk space is based on the expected storage requirements that are calculated by considering the file uploads and the backup policies. For example, if three WSO2 product instances are running in a single machine, it requires a 4 GHz CPU, 8 GB RAM (2 GB for the operating system and 6 GB (2 GB for each WSO2 product instance)) and 30 GB of free space.

Virtual Machine (VM)

2 compute units minimum (each unit having 1.0-1.2 GHz Opteron/Xeon processor)
4 GB RAM
10 GB free disk space
One CPU unit for the operating system and one for JVM.

Three WSO2 product instances running would require VM of 4 compute units, 8 GB RAM, and 30 GB free space.
~ 512 MB 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.

EC2

1 c5.large instance to run one WSO2 product instance.

Three WSO2 product instances can be run in 1 EC2 Extra-Large instance. Based on the I/O performance of the c5.large instance, it is recommended to run multiple instances in a larger instance (c5.xlarge).

Environment compatibility

Operating systems/
Databases

All WSO2 Carbon-based products are Java applications that can be run on any platform that is Oracle JDK 1.7/1.8 compliant.

WSO2 API Manager is also compatible with IBM JDK 1.7.*/1.8.*. For more information on JDKs that WSO2 products are tested with, see Tested Operating Systems and JDKs.
If you want to start WSO2 API Manager with IBM JDK, open the <API-M_HOME>/repository/conf/security/Owasp.CsrfGuard.Carbon.properties file and replace 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. 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.
On a production deployment, it is recommended that WSO2 products are installed on latest releases of RedHat Enterprise Linux or Ubuntu Server LTS.
For environments that WSO2 products are tested with, see Compatibility of WSO2 Products.
To find out if this version of the product has issues running on your OS due to the JDK version, see Known Incompatibilities.
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 API Manager 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. To build the product from the source distribution (both JDK and Apache Maven are required). To run Apache Ant.	JDK 1.7./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. Open the `catalina-server.xml` file from the `<APIM_HOME>/repository/conf/tomcat/` directory. Set the `compression` parameter (under each of the connector configurations) to false as shown below: compression="off" Restart the server. We do not recommend OpenJDK as we do not support it or test our products with it.	http://java.sun.com/javase/ downloads/index.jsp
Apache ActiveMQ JMS Provider	To enable the product's JMS transport and try out JMS samples. The ActiveMQ client libraries must be installed in the product's classpath before you can enable the JMS transport.	5.5.0 or later If you use any other JMS provider (e.g., Apache Qpid), install any necessary libraries and/or components.	http://activemq.apache.org
Apache Ant	To compile and run the product samples in `<APIM_HOME>/samples` .	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.	3.0.*	http://maven.apache.org
Web Browser	To access the 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. Click one of the following links for instructions: