Follow the instructions below to download WSO2 API Manager. You can download the binary distribution from the Web page or download and build the source code.
Downloading from the Web page
- In your Web browser, go to http://wso2.com/products/api-manager.
- If you are a new user downloading WSO2 products for the first time, register and log in.
- Once you are logged in, click the Binary button in the upper right corner of the page.
The binary distribution contains the binary files for both MS Windows and Linux operating systems, compressed into a single ZIP file. This distribution is recommended for many users.
Building from source
WSO2 invites you to contribute by checking out the source from the Subversion (SVN) source control system using the following commands, building the product and making changes, and then committing your changes back to the source repository. For information on using Subversion, see http://svnbook.red-bean.com.
Checking out the source
You can download the complete WSO2 Carbon platform, which is recommended if you intend to modify the source. You can check out the complete source anonymously from SVN with the following commands (replace x.x.x with the version of Carbon you want to build). The Carbon project comes in three sub projects: Orbit, Kernel, and Platform. Download and build them in that particular order.
Orbit:
$ svn checkout https://svn.wso2.org/repos/wso2/carbon/orbit/tags/x.x.x wso2carbon
Kernel:
$ svn checkout https://svn.wso2.org/repos/wso2/carbon/kernel/tags/x.x.x wso2carbon
Platform:
$ svn checkout https://svn.wso2.org/repos/wso2/carbon/platform/tags/x.x.x wso2carbon
Access through a firewall
If you are behind a corporate firewall that is blocking HTTP access to the Subversion repository, you can try the developer connection:
$ svn checkout https://svn.wso2.org/repos/wso2/trunk/carbon carbon
Access through a proxy
The Subversion client can be configured to access through a proxy. Specify the proxy to use in the "servers" configuration file in:
- "~/.subversion" directory for Linux/Unix
- "%APPDATA%\Subversion" hidden directory for Windows. (Try "echo %APPDATA%")
The comments in the file explain what to do. If you don't have this file, get the latest Subversion client and run any command. It will create the configuration directory and template files.
For example, edit the 'servers' file and add something similar to the following:
[global] http-proxy-host = your.proxy.name http-proxy-port = 3128
Building the product
Following are the commands you can run to create complete release artifacts, including the binary and source distributions.
Before you build,
- Install Maven and JDK. See Installation Prerequisites for compatible versions.
- Set the environment variable
MAVEN_OPTS=”-Xms768m -Xmx3072m -XX:MaxPermSize=1200m” to avoid the mavenOutOfMemoryError. - Make sure the build server has an active Internet connection to download dependencies while building.
| This command... | Creates... |
|---|---|
mvn clean install -Dproduct=AM | The binary and source distributions of only API Manager. To build the entire Carbon core project, omit the |
mvn clean install -Dmaven.test.skip=true -Dproduct=AM | The binary and source distributions, without running any of the unit tests. |
mvn clean install -Dmaven.test.skip=true -Dproduct=AM -o | The binary and source distributions, without running any of the unit tests, in offline mode. This can be done only if you've already built the source at least once. |
Committing your changes
If you are a committer, you can commit your changes using the following command (SVN will prompt you for your password):
$ svn commit --username your-username -m "A message"