Welcome to Apache Synapse Installation Guide. This guide provides information on,
You should have following pre-requisites installed on your system to run Apache Synapse.
|Java SE Development Kit||1.6.0_23 or higher (For instructions on setting up the JDK on different operating systems, visit Java homepage. )|
|Apache Ant - To run Synapse samples||
To compile and run the sample clients, an Ant installation is required. Ant 1.7.0 version or higher is recommended.
|Apache Maven - To build Synapse from the source||To build Apache Synapse from its source distribution, you will need Maven 3.2.x or later.|
|Memory||No minimum requirement - A heap size of 1GB is generally sufficient to process typical SOAP messages. Requirements may vary with larger message size and on the number of messages processed concurrently.|
|Disk||No minimum requirement. The installation will require ~75 MB excluding space allocated for log files and databases.|
|Operating System||Linux, Solaris, macOS, MS Windows - XP/2003/2008 (Not fully tested on Windows Vista/7/8/10). Since Apache Synapse is a Java application, it will generally be possible to run it on other operating systems with a JDK 1.6.x or higher runtime. Linux is recommended for production deployments.|
The following distribution packages are available for download.
The following guide will take you through the binary distribution installation on different platforms.
Apache Synapse build is based on Apache Maven 3. Hence, it is a prerequisite to have Maven (version 3.2.0 or later) installed in order to build Synapse from the source distribution. Instructions on installing Maven 3 are available on the Maven website. Follow these steps to build Synapse after setting up Maven 3.
This will create the complete set of release artifacts including the binary distribution in the modules/distribution/target/ directory which can be installed using the above instructions.