Author: rajika Date: Tue Feb 3 00:16:02 2009 New Revision: 30295 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=30295
Log: Updated installtion guide Modified: trunk/esb/java/docs/xdoc/installation_guide.xml Modified: trunk/esb/java/docs/xdoc/installation_guide.xml URL: http://wso2.org/svn/browse/wso2/trunk/esb/java/docs/xdoc/installation_guide.xml?rev=30295&r1=30294&r2=30295&view=diff ============================================================================== --- trunk/esb/java/docs/xdoc/installation_guide.xml (original) +++ trunk/esb/java/docs/xdoc/installation_guide.xml Tue Feb 3 00:16:02 2009 @@ -20,397 +20,474 @@ --> <!DOCTYPE html - PUBLIC "-//W3C//DTD XHTML 1.1//EN" - "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"; > + PUBLIC "-//W3C//DTD XHTML 1.1//EN" + "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"; > <html xmlns="http://www.w3.org/1999/xhtml";> - <head> - <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"/> - <title> - WSO2 ESB - Installation Guide - </title> - <link href="css/esb-docs.css" rel="stylesheet"/> - <link href="styles/dist-docs.css" rel="stylesheet" type="text/css" media="all"/> - </head> - <body xml:lang="en"> - <h1> - WSO2 Enterprise Service Bus (ESB) Installation Guide - </h1> - <p/> - <p> - This document describes the distribution packages available in WSO2 ESB - - the binary distribution and the source distribution for more advanced - users. It is followed by simple instructions on how to install and run - WSO2 ESB using the binary distribution and how to build WSO2 ESB using the - source distribution. - </p> - <h2> - Table of Contents - </h2> - <div class="toc"> - <ul> - <li> - <a href="#Distributi">Distribution Packages</a> - </li> - <li> - <a href="#Installing">Installing and Running WSO2 ESB using the - Binary Distribution</a> - <ul> - <li> - <a href="#Prerequisi">Prerequisites</a> - </li> - <li> - <a href="#Installing2">Installing on Linux</a> - </li> - <li> - <a href="#Installing1">Installing on MS Windows</a> - </li> - </ul> - </li> - <li> - <a href="#Building">Building WSO2 ESB Using the Source Distribution</a> - <ul> - <li> - <a href="#Prerequisi1">Prerequisites</a> - </li> - <li> - <a href="#Setting">Setting Up the Environment and Tools</a> - </li> - <li> - <a href="#Building1">Building WSO2 ESB</a> - </li> - </ul> - </li> - </ul> - </div> - <h2 id="Distributi"> - Distribution Packages - </h2> - <p> - The following distribution packages are available for <a - href="http://dist.wso2.org/products/esb/java/1.7/";>download</a>. - </p> - <p> - 1. Binary Distribution : Includes binary files for both MS Windows and - Linux operating systems as a zip file. Recommended for normal users. - </p> - <p> - 2. Source Distribution : Includes the source for both MS Windows and Linux - operating systems as a zip file that is used to build the binary files. - Recommended for more advanced users. - </p> - <h2 id="Installing"> - Installing and Running WSO2 ESB using the Binary Distribution - </h2> - <h3 id="Prerequisi"> - Prerequisites - </h3> - <p/> - <table border="2"> - <tbody> - <tr> - <td> - <a href="http://java.sun.com/javase/downloads/index.jsp";>Java SE - Development Kit</a> - </td> - <td> - 1.5.x (For instructions on setting up the JDK on different operating - systems, visit <a href="http://java.sun.com";>http://java.sun.com</a>) - <p/> - <p> - To build WSO2 ESB from the Source distribution, it is necessary - that you have JDK 1.5.x version and Maven 2.0.6 or later - </p> - </td> - </tr> - <tr> - <td> - <a href="http://activemq.apache.org/";>Apache ActiveMQ</a> - -JMS Provider - </td> - <td> - <p> - ActiveMQ 4.1.0 or later can be used with the JMS transport, and - the ESB ships with all the necessary client libraries to run with - an ActiveMQ installation. - </p> - <p> - If you are using any other JMS provider, you will need to install - any necessary libraries and/or any components. - </p> - </td> - </tr> - <tr> - <td> - <a href="http://ant.apache.org/";>Apache Ant</a> - To run - ESB samples - </td> - <td> - <p> - To compile and run the sample clients, an Ant version is required. - Ant 1.7.0 version is recommended. - </p> - </td> - </tr> - <tr> - <td> - <a href="http://maven.apache.org/";>Apache Maven</a>- To - build ESB from Source - </td> - <td> - To build the WSO2 ESB from its source distribution, you will need - Maven 2.0.6 or later - </td> - </tr> - <tr> - <td> - Web browser- To start the ESB Management Console - </td> - <td> - Mozilla Firefox 2.0 at a resolution of 1024x768 is recommended. MS - Internet Explorer 7 may be used as well, with some limitations. Once - the WSO2 ESB is started point the browser to - https://localhost:9444/esb you can access your Management Console. - See the <a href="administratorguide.html">Web Administrator Guide</a> - for more details. - </td> - </tr> - <tr> - <td> - Memory - </td> - <td> - No minimum requirement - A heap size of 256~512MB is generally - sufficient to process typical SOAP messages. Requirements may vary - with larger message size and on the number of messages processed - concurrently - </td> - </tr> - <tr> - <td> - Disk - </td> - <td> - No minimum requirement. The installation will require ~50MB - excluding space allocated for log files and Databases. - </td> - </tr> - <tr> - <td> - Operating System - </td> - <td> - Linux, Solaris, MS Windows - XP/ Vista (Not fully tested on Windows - Vista). As the WSO2 ESB is a Java application, it will generally be - possible to run it on other operating systems with a JDK 1.5.x - runtime. Linux/Solaris is recommended for a production deployment. - </td> - </tr> - </tbody> - </table> - <p/> - <h3 id="Installing2"> - <strong>Installing on Linux / Unix</strong> - </h3> - <ol> - <li> - <a href="http://dist.wso2.org/products/esb/wso2-esb-java-1.7-bin.zip";>Download</a> - the WSO2 ESB binary distribution. - </li> - <li> - Extract the zip archive where you want the WSO2 ESB installed (e.g. into - /opt) - </li> - <li> - Set the JAVA_HOME environment variable to your Java home using the - export command or by editing /etc/profile, and add the Java /bin - directory to your PATH - </li> - <li> - Execute the WSO2 ESB start script or the daemon script from the bin - directory. e.g. ./wso2-esb.sh OR ./wso2-esb-daemon.sh start OR - ./wso2-esb-daemon.sh console - </li> - <li> - Check your WSO2 ESB instance using the URL https://localhost:9444/esb - which will take you to the WSO2 ESB Management Console. - </li> - <li> - Login as "admin" using the default password "admin" - </li> - </ol> - <h3 id="Installing1"> - <strong>Installing on MS Windows</strong> - </h3> - <p> - The following steps will take you through the installation for the MS - Windows operating system. - </p> - <ol> - <li> - <a href="http://dist.wso2.org/products/esb/wso2-esb-java-1.7-bin.zip";>Download</a> - the WSO2 ESB binary distribution. - </li> - <li> - Extract the zip archive where you want the WSO2 ESB installed - </li> - <li> - Set the <a href="setting-java-home.html">JAVA_HOME</a> - environment variable to your Java installation, and the PATH environment - variable to the Java /bin directory. - </li> - <li> - Execute the WSO2 ESB start script from the bin folder. e.g. wso2-esb.bat - </li> - <li> - If you would like to install the WSO2 ESB as a Windows service, use the - install-wso2-esb-service.bat script - </li> - <li> - Check your WSO2 ESB instance using the URL https://localhost:9444/esb - which will take you to the WSO2 ESB Management Console. - </li> - <li> - Login as "admin" using the default password "admin" - </li> - </ol> - <h2 id="Building"> - Building WSO2 ESB Using the Source Distribution - </h2> - <h3 id="Prerequisi1"> - Prerequisites - </h3> - <p/> - <table border="2"> - <tbody> - <tr> - <td> - <a href="http://java.sun.com/javase/downloads/index.jsp";>Java SE - Development Kit</a> - </td> - <td> - 1.5.x (For instructions on setting up the JDK in different operating - systems, visit <a href="http://java.sun.com";>http://java.sun.com</a>) - </td> - </tr> - <tr> - <td> - <a href="http://maven.apache.org/";>Apache Maven</a>- To - build ESB from Source - </td> - <td> - To build the WSO2 ESB from its source distribution, you will need - Maven 2.0.6 or later - </td> - </tr> - <tr> - <td> - Operating System - </td> - <td> - Linux, Solaris, MS Windows - XP/ Vista (Not fully tested on Windows - Vista) - </td> - </tr> - </tbody> - </table> - <p/> - <h3 id="Setting"> - Setting up the Environment and Tools - </h3> - <p/> - <p> - <strong>Maven:</strong> - </p> - <p> - The WSO2 ESB build is based on <a href="http://maven.apache.org/";>Apache - Maven</a>. Hence, it is a prerequisite to have Maven (version 2.0.6 or later) - and JDK (version 1.5.x) installed in order to build WSO2 ESB from the - source distribution. Extensive instructions on Maven builds are available - on the Maven site. - </p> - <p> - Please refer to the <a - href="http://maven.apache.org/guides/getting-started/index.html";>Maven - Getting Started Guide</a> for more information on Maven - </p> - <ul> - <li> - Unix based OS (e.g., Linux) - </li> - </ul> - <ol> - <li> - Download Apache Maven tar ball or the zip archive. - </li> - <li> - Expand it to a directory of choice. - </li> - <li> - Set the environment variable MAVEN_HOME and add MAVEN_HOME/bin to the - path as well. - </li> - <li> - Refer to more instructions on how to install Maven in Unix based - operating systems. - </li> - </ol> - <ul> - <li> - MS Windows - </li> - </ul> - <ol> - <li> - Download and run the Apache Maven Windows installer package. - </li> - <li> - Set the 'Environment Variables' (create the system variable MAVEN_HOME - and edit the path. e.g., "C:\Program Files\Apache Software - Foundation\maven-2.0.6"; path %MAVEN_HOME%\bin) - </li> - <li> - Make sure that the system variable <a href="setting-java-home.html">JAVA_HOME</a> - is set to the location of your JDK, e.g., C:\Program Files\Java\jdk1.5 - </li> - <li> - Run mvn --version to verify that it is correctly installed. - </li> - </ol> - <p> - Once Maven is properly installed, you can start building the WSO2 ESB. - </p> - <h3 id="Building1"> - Building WSO2 ESB - </h3> - <ol> - <li> - <a href="http://dist.wso2.org/products/esb/java/1.7/#source";>Download</a> - the source distribution, which is available as a zip archive. - </li> - <li> - Expand the source archive to a directory of your choice. - </li> - <li> - All the necessary build scripts are included with the source - distribution. - </li> - <li> - You can run the following command inside that directory to build the - WSO2 ESB. You will need a connection to the Internet for the Maven build - to download dependencies required for the build - <p> - <strong>mvn clean install</strong> - </p> - </li> - </ol> - <p> - This will create the complete release artifacts including the binary and - source distributions in the modules/distribution/target/ directory - </p> - <p> - Note: The first time you run Maven it will automatically download the - dependent .jar files. Therefore, the first run will take more time. - </p> - </body> + <head> + <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"/> + <title> + WSO2 ESB - Installation Guide + </title> + <link href="styles/dist-docs.css" rel="stylesheet" type="text/css" media="all"/> + </head> + <body xml:lang="en"> + <h1> + WSO2 Enterprise Service Bus (ESB) Installation Guide + </h1> + <p/> + + <p>This installation guide provides information on,</p> + <ol> + <li>the prerequisites for WSO2 ESB</li> + <li>installation instructions</li> + <li>starting up WSO2 ESB, and</li> + <li>accessing the management console</li> + </ol> + + <p> + This document describes the distribution packages available in WSO2 ESB - + the binary distribution and the source distribution for more advanced + users. It is followed by simple instructions on how to install and run + WSO2 ESB using the binary distribution and how to build WSO2 ESB using the + source distribution. + </p> + + <h2> + Table of Contents + </h2> + <div class="toc"> + <ul> + <li> + <a href="#Distributi">Distribution Packages</a> + </li> + <li> + <a href="#Installing">Installing and Running WSO2 ESB using the + Binary Distribution + </a> + <ul> + <li> + <a href="#Prerequisi">Prerequisites</a> + </li> + <li> + <a href="#Installing2">Installing on Linux</a> + <ul> + <li> + <a href="#Installing3">Installing using Binary Distribution</a> + </li> + <li> + <a href="#Installing4">Installing using Binary Installers (deb/rpm)</a> + </li> + </ul> + </li> + <li> + <a href="#Installing1">Installing on MS Windows</a> + </li> + </ul> + </li> + <li> + <a href="#Building">Building WSO2 ESB Using the Source Distribution</a> + <ul> + <li> + <a href="#Prerequisi1">Prerequisites</a> + </li> + <li> + <a href="#Setting">Setting Up the Environment and Tools</a> + </li> + <li> + <a href="#Building1">Building WSO2 ESB</a> + </li> + </ul> + </li> + </ul> + </div> + <h2 id="Distributi"> + Distribution Packages + </h2> + <p> + The following distribution packages are available for<a + href="http://dist.wso2.org/products/esb/java/";>download</a>. + </p> + <p> + 1. Binary Distribution : Includes binary files for both MS Windows and + Linux operating systems as a zip file(.dep and .rpm packages are also available + which you can install using your package manager). Recommended for normal users. + </p> + <p> + 2. Source Distribution : Includes the source for both MS Windows and Linux + operating systems as a zip file that is used to build the binary files. + Recommended for more advanced users. + </p> + <h2 id="Installing"> + Installing and Running WSO2 ESB using the Binary Distribution + </h2> + <h3 id="Prerequisi"> + Prerequisites + </h3> + <p/> + <table border="2"> + <tbody> + <tr> + <td> + <a href="http://java.sun.com/javase/downloads/index.jsp";>Java SE + Development Kit + </a> + </td> + <td> + 1.5.x (For instructions on setting up the JDK on different operating + systems, visit<a href="http://java.sun.com";>http://java.sun.com</a>) + <p/> + <p> + To build WSO2 ESB from the Source distribution, it is necessary + that you have JDK 1.5.x version and Maven 2.0.6 or later + </p> + </td> + </tr> + <tr> + <td> + <a href="http://activemq.apache.org/";>Apache ActiveMQ</a> + -JMS Provider + </td> + <td> + <p> + ActiveMQ 4.1.0 or later can be used with the JMS transport, and + the ESB ships with all the necessary client libraries to run with + an ActiveMQ installation. + </p> + <p> + If you are using any other JMS provider, you will need to install + any necessary libraries and/or any components. + </p> + </td> + </tr> + <tr> + <td> + <a href="http://ant.apache.org/";>Apache Ant</a> + - To run + ESB samples + </td> + <td> + <p> + To compile and run the sample clients, an Ant version is required. + Ant 1.7.0 version is recommended. + </p> + </td> + </tr> + <tr> + <td> + <a href="http://maven.apache.org/";>Apache Maven</a>- To + build ESB from Source + </td> + <td> + To build the WSO2 ESB from its source distribution, you will need + Maven 2.0.6 or later + </td> + </tr> + <tr> + <td> + Web browser- To start the ESB Management Console + </td> + <td> + Mozilla Firefox 2.0 at a resolution of 1024x768 is recommended. MS + Internet Explorer 7 may be used as well, with some limitations. Once + the WSO2 ESB is started point the browser to + https://localhost:9443/carbon you can access your Management Console. + See the + <a href="administratorguide.html">Web Administrator Guide</a> + for more details. + </td> + </tr> + <tr> + <td> + Memory + </td> + <td> + No minimum requirement - A heap size of 256~512MB is generally + sufficient to process typical SOAP messages. Requirements may vary + with larger message size and on the number of messages processed + concurrently + </td> + </tr> + <tr> + <td> + Disk + </td> + <td> + No minimum requirement. The installation will require ~50MB + excluding space allocated for log files and Databases. + </td> + </tr> + <tr> + <td> + Operating System + </td> + <td> + Linux, Solaris, MS Windows - XP/ Vista (Not fully tested on Windows + Vista). As the WSO2 ESB is a Java application, it will generally be + possible to run it on other operating systems with a JDK 1.5.x + runtime. Linux/Solaris is recommended for a production deployment. + </td> + </tr> + </tbody> + </table> + <p/> + + <h2 id="Installing2">Installing on Linux/Unix</h2> + <p>Again, there are two methods of installing on Linux:</p> + <ol> + <li> + <a href="#linux_binary">Using Binary Distribution</a> + </li> + <li> + <a href="#linux_binary_installers">Using Binary Installers + (deb/rpm) + </a> + </li> + </ol> + + <a name="linux_binary"></a> + <h3 id="Installing3"> + <strong>Installing using Binary Distribution</strong> + </h3> + <ol> + <li> + <a href="http://dist.wso2.org/products/esb/java/";>Download</a> + the WSO2 ESB binary distribution. + </li> + <li> + Extract the zip archive where you want the WSO2 ESB installed (e.g. into + /opt) + </li> + <li> + Set the <a href="setting-java-home.html">JAVA_HOME</a> + environment variable to your Java home using the + export command or by editing /etc/profile, and add the Java /bin + directory to your PATH + </li> + <li> + Execute the WSO2 ESB start script or the daemon script from the bin + directory. e.g. ./wso2server.sh OR ./daemon.sh start OR + ./wso2server.sh --console + </li> + <li> + Check your WSO2 ESB instance using the URL https://localhost:9443/carbon + which will take you to the WSO2 ESB Management Console. + </li> + <li> + Login as "admin" using the default password "admin" + </li> + </ol> + + <a name="linux_binary_installers"></a> + <h3 id="Installing4">Installing using Binary Installers (deb/rpm)</h3> + + <p>The following steps will take you through the binary distribution + installation. + </p> + <ol> + <li>Download WSO2 ESB + <a + href="http://dist.wso2.org/products/esb/java/";>deb + </a> + or + <a href="http://dist.wso2.org/products/esb/java/";>RPM</a> + binary. + </li> + <li>Install Debian binary ( deb ) e.g., dpkg -i + wso2esb-2.0.0_all.deb (To install deb, log on to the + system as root user. If you want to uninstall WSO2 ESB try + dpkg -r wso2esb-2.0.0_all.deb) + </li> + <li>Install RPM binary ( rpm ) e.g., rpm -Uvh + wso2esb-2.0.0_all.rpm (To install rpm, log on to the + system as root user. If you want to uninstall WSO2 ESB try + rpm -e wso2esb-2.0.0_all.rpm) + </li> + <li>Execute/start the WSO2 ESB from the shell. e.g., /etc/init.d/wso2-esb start + <br/> + (You can also stop the server from the shell. e.g., /etc/init.d/wso2-esb stop) + </li> + </ol> + + <h3 id="Installing1"> + <strong>Installing on MS Windows</strong> + </h3> + <p> + The following steps will take you through the installation for the MS + Windows operating system. + </p> + <ol> + <li> + <a href="http://dist.wso2.org/products/esb/java/";>Download</a> + the WSO2 ESB binary distribution. + </li> + <li> + Extract the zip archive where you want the WSO2 ESB installed + </li> + <li> + Set the + <a href="setting-java-home.html">JAVA_HOME</a> + environment variable to your Java installation, and the PATH environment + variable to the Java /bin directory. + </li> + <li> + Execute the WSO2 ESB start script from the bin folder. e.g. wso2server.bat + </li> + <li> + If you would like to install the WSO2 ESB as a Windows service, use the + install.bat script + </li> + <li> + Check your WSO2 ESB instance using the URL https://localhost:9443/carbon + which will take you to the WSO2 ESB Management Console. + </li> + <li> + Login as "admin" using the default password "admin" + </li> + </ol> + <h2 id="Building"> + Building WSO2 ESB Using the Source Distribution + </h2> + <h3 id="Prerequisi1"> + Prerequisites + </h3> + <p/> + <table border="2"> + <tbody> + <tr> + <td> + <a href="http://java.sun.com/javase/downloads/index.jsp";>Java SE + Development Kit + </a> + </td> + <td> + 1.5.x (For instructions on setting up the JDK in different operating + systems, visit<a href="http://java.sun.com";>http://java.sun.com</a>) + </td> + </tr> + <tr> + <td> + <a href="http://maven.apache.org/";>Apache Maven</a>- To + build ESB from Source + </td> + <td> + To build the WSO2 ESB from its source distribution, you will need + Maven 2.0.6 or later + </td> + </tr> + <tr> + <td> + Operating System + </td> + <td> + Linux, Solaris, MS Windows - XP/ Vista (Not fully tested on Windows + Vista) + </td> + </tr> + </tbody> + </table> + <p/> + <h3 id="Setting"> + Setting up the Environment and Tools + </h3> + <p/> + <p> + <strong>Maven:</strong> + </p> + <p> + The WSO2 ESB build is based on<a href="http://maven.apache.org/";>Apache + Maven</a>. Hence, it is a prerequisite to have Maven (version 2.0.6 or later) + and JDK (version 1.5.x) installed in order to build WSO2 ESB from the + source distribution. Extensive instructions on Maven builds are available + on the Maven site. + </p> + <p> + Please refer to the + <a + href="http://maven.apache.org/guides/getting-started/index.html";>Maven + Getting Started Guide + </a> + for more information on Maven + </p> + <ul> + <li> + Unix based OS (e.g., Linux) + </li> + </ul> + <ol> + <li> + Download Apache Maven tar ball or the zip archive. + </li> + <li> + Expand it to a directory of choice. + </li> + <li> + Set the environment variable MAVEN_HOME and add MAVEN_HOME/bin to the + path as well. + </li> + <li> + Refer to more instructions on how to install Maven in Unix based + operating systems. + </li> + </ol> + <ul> + <li> + MS Windows + </li> + </ul> + <ol> + <li> + Download and run the Apache Maven Windows installer package. + </li> + <li> + Set the 'Environment Variables' (create the system variable MAVEN_HOME + and edit the path. e.g., "C:\Program Files\Apache Software + Foundation\maven-2.0.6"; path %MAVEN_HOME%\bin) + </li> + <li> + Make sure that the system variable + <a href="setting-java-home.html">JAVA_HOME</a> + is set to the location of your JDK, e.g., C:\Program Files\Java\jdk1.5 + </li> + <li> + Run mvn --version to verify that it is correctly installed. + </li> + </ol> + <p> + Once Maven is properly installed, you can start building the WSO2 ESB. + </p> + <h3 id="Building1"> + Building WSO2 ESB + </h3> + <ol> + <li> + <a href="http://dist.wso2.org/products/esb/java/";>Download</a> + the source distribution, which is available as a zip archive. + </li> + <li> + Expand the source archive to a directory of your choice. + </li> + <li> + All the necessary build scripts are included with the source + distribution. + </li> + <li> + You can run the following command inside that directory to build the + WSO2 ESB. You will need a connection to the Internet for the Maven build + to download dependencies required for the build + <p> + <strong>mvn clean install</strong> + </p> + </li> + </ol> + <p> + This will create the complete release artifacts including the binary and + source distributions in the modules/distribution/target/ directory which can be installed using + the above instructions. + </p> + <p> + Note: The first time you run Maven it will automatically download the + dependent .jar files. Therefore, the first run will take more time. + </p> + </body> </html> \ No newline at end of file _______________________________________________ Esb-java-dev mailing list [email protected] https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
