WSO2 ESB - Documentation Index

WSO2 Enterprise Service Bus (ESB) Documentation Index

Getting Started

Installation Guide : Gives basic steps on how to download, install, and run WSO2 ESB using the binary distribution, and how to build WSO2 ESB using the source distribution.

Quick Start Guide : Demonstrates two sample applications covering the basic and the most common usage scenarios of the WSO2 ESB - Message mediation and Service mediation.

User Guide : A manual on how to run and configure the WSO2 ESB through the management console. Descriptions include how to manage the underlying Synapse configuration elements and the integrated registry, and how to interpret statistics generated by the system.

Administrator Guide : A manual on how to administrate and configure the WSO2 ESB through the management console. Descriptions on advanced configurations like Remote/Embedded Registry configuration, adding external libraries, Key store & User management. Briefly describes the performance tunning the ESB as well.

Deployment Guide : A manual on how to deploy the WSO2 ESB on different Application Servers, including the configuration that are required to setup the ESB on those Application Servers.

Samples

Samples Setup Guide : Provides step-by-step instructions on how to install the prerequisites, and set up the samples given in this distribution - generic instructions on how to start the sample server, deploy a service, and run the client.

How to Run the WSO2 ESB Samples : While the document above gives you a generic description on how to set up and and run the WSO2 ESB samples, this document takes each sample, one by one and discusses the objective of the sample, its prerequisites, and its expected behavior when the sample is built.

Advanced Topics

Extending Synapse : Explains how to write custom mediator implementations and custom configuration implementations for mediators by extending Apache Synapse through WSO2 ESB. It also provides guidelines on how to configure these mediators.

Synapse Configuration Language : Describes the configuration language used by the underlying Synapse mediation engine. This document is provided only as a reference, as the WSO2 ESB management console allows users to configure the underlying engine graphically, through the management console

Secure Vault : Describes how you can keep the secret information securely within the WSO2 ESB. You can secure any secret including the passwords, keys or pass phrases.

Catalogs

Mediator Catalog : Comprehensive catalog of all the available default mediators in the WSO2 ESB 2.1.1.

Endpoint Catalog : Comprehensive catalog of all the available default endpoints in the WSO2 ESB 2.1.1.

Transport Catalog : Comprehensive catalog of all the available default transports in the WSO2 ESB 2.1.1.

Other Resources

Frequently Asked Questions : Contains a set of FAQ's on WSO2 ESB, and the related Axis2, Synapse components.

WSO2 ESB Features : Gives a high level overview of the features pf the WSO2 ESB.

Java Docs : Application Programing Interface of the Apache Synapse version used underneath the WSO2 ESB. If you want to write advanced custom mediators, you will need this API.

The WSO2 Oxygen Tank Library : The Library contains articles, tutorials, presentations, and other knowledge base items published on The Oxygen Tank.

Wiki Space : This is the working Wiki for WSO2 ESB.