Author: hiranya Date: Mon Jul 6 22:11:24 2009 New Revision: 40897 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=40897
Log: Reviewed and updated the ESB installation guide. Removed unnecessary items from the doc. Fixed a few typos. Modified: branches/esb/java/2.1/product/docs/xdoc/installation_guide.xml Modified: branches/esb/java/2.1/product/docs/xdoc/installation_guide.xml URL: http://wso2.org/svn/browse/wso2/branches/esb/java/2.1/product/docs/xdoc/installation_guide.xml?rev=40897&r1=40896&r2=40897&view=diff ============================================================================== --- branches/esb/java/2.1/product/docs/xdoc/installation_guide.xml (original) +++ branches/esb/java/2.1/product/docs/xdoc/installation_guide.xml Mon Jul 6 22:11:24 2009 @@ -68,15 +68,7 @@ <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> + <a href="#Installing2">Installing on Linux</a> </li> <li> <a href="#Installing1">Installing on MS Windows</a> @@ -103,17 +95,17 @@ Distribution Packages </h2> <p> - The following distribution packages are available for<a + The following distribution packages are available for <a href="http://wso2.org/downloads/esb/";>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. + Linux operating systems, compressed into a single 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. + 2. Source Distribution : Includes the source code for both MS Windows and Linux + operating systems, compressed into a single zip file which can be used to build the binary files. Recommended for more advanced users. </p> <h2 id="Installing"> @@ -133,11 +125,11 @@ </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>) + 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 + that you have JDK 1.5.x version and Maven 2.1.0 or later </p> </td> </tr> @@ -148,12 +140,12 @@ </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. + Apache ActiveMQ 4.1.0 or higher is required to enable the WSO2 ESB JMS + transport and try out JMS samples. The ActiveMQ client libraries must + be installed in the ESB classpath before you can enable the JMS transport. </p> <p> - If you are using any other JMS provider, you will need to install + If you are using any other JMS provider (eg: Apache Qpid), you will need to install any necessary libraries and/or any components. </p> </td> @@ -178,7 +170,7 @@ </td> <td> To build the WSO2 ESB from its source distribution, you will need - Maven 2.0.6 or later + Maven 2.1.0 or later </td> </tr> <tr> @@ -186,12 +178,12 @@ 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 + Mozilla Firefox 3.0 at a resolution of 1024x768 is recommended. MS + Internet Explorer 7 may be used as well, with some minor limitations. Once the WSO2 ESB is started point the browser to - https://localhost:9443/carbon you can access your Management Console. + https://localhost:9443/carbon in order to access your Management Console. See the - <a href="user_guide.html">Web Administrator Guide</a> + <a href="user_guide.html">WSO2 ESB User Guide</a> for more details. </td> </tr> @@ -211,7 +203,7 @@ Disk </td> <td> - No minimum requirement. The installation will require ~50MB + No minimum requirement. The installation will require ~125 MB excluding space allocated for log files and Databases. </td> </tr> @@ -221,7 +213,7 @@ </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 + Vista). Since 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> @@ -231,22 +223,10 @@ <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> + <p> + The following steps will take you through the binary distribution + installation on Unix/Linux systems. + </p> <ol> <li> <a href="http://wso2.org/downloads/esb/";>Download</a> @@ -269,47 +249,17 @@ </li> <li> Check your WSO2 ESB instance using the URL https://localhost:9443/carbon - which will take you to the WSO2 ESB Management Console. + which will take you to the WSO2 ESB Management Console. (Note that server + start up may take time) </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://wso2.org/downloads/esb//";>deb - </a> - or - <a href="http://wso2.org/downloads/esb/";>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"> + <h2 id="Installing1"> <strong>Installing on MS Windows</strong> - </h3> + </h2> <p> The following steps will take you through the installation for the MS Windows operating system. @@ -360,7 +310,7 @@ </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>) + systems, visit <a href="http://java.sun.com";>http://java.sun.com</a>) </td> </tr> <tr> @@ -370,7 +320,7 @@ </td> <td> To build the WSO2 ESB from its source distribution, you will need - Maven 2.0.6 or later + Maven 2.1.0 or later </td> </tr> <tr> @@ -393,11 +343,11 @@ <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) + The WSO2 ESB build is based on <a href="http://maven.apache.org/";>Apache + Maven 2</a>. Hence, it is a prerequisite to have Maven (version 2.1.0 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. + source distribution. Extensive instructions on using Maven 2 are available + on the Maven website. </p> <p> Please refer to the @@ -420,12 +370,11 @@ Expand it to a directory of choice. </li> <li> - Set the environment variable MAVEN_HOME and add MAVEN_HOME/bin to the + Set the environment variable M2_HOME and add M2_HOME/bin to the path as well. </li> <li> - Refer to more instructions on how to install Maven in Unix based - operating systems. + Run mvn --version to verify that it is correctly installed. </li> </ol> <ul> @@ -438,9 +387,9 @@ Download and run the Apache Maven Windows installer package. </li> <li> - Set the 'Environment Variables' (create the system variable MAVEN_HOME + Set the 'Environment Variables' (create the system variable M2_HOME and edit the path. e.g., "C:\Program Files\Apache Software - Foundation\maven-2.0.6"; path %MAVEN_HOME%\bin) + Foundation\maven-2.0.6"; path %M2_HOME%\bin) </li> <li> Make sure that the system variable @@ -471,10 +420,11 @@ </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 + WSO2 ESB. Note that you will require a connection to the Internet for the Maven build + to download dependencies required for the build. + <br/> <p> - <strong>mvn clean install</strong> + Command: <strong>mvn clean install</strong> </p> </li> </ol> _______________________________________________ Esb-java-dev mailing list [email protected] https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
