Author: ruwan Date: Thu Jun 18 12:19:35 2009 New Revision: 39362 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=39362
Log: Adding the deployment guide and the webapp deployment guide Added: branches/esb/java/2.1/product/docs/xdoc/deployment_guide.xml branches/esb/java/2.1/product/docs/xdoc/webapp_deployment_guide.xml Modified: branches/esb/java/2.1/product/docs/site.xml Modified: branches/esb/java/2.1/product/docs/site.xml URL: http://wso2.org/svn/browse/wso2/branches/esb/java/2.1/product/docs/site.xml?rev=39362&r1=39361&r2=39362&view=diff ============================================================================== --- branches/esb/java/2.1/product/docs/site.xml (original) +++ branches/esb/java/2.1/product/docs/site.xml Thu Jun 18 12:19:35 2009 @@ -65,8 +65,9 @@ <item name="User Guide" href="user_guide.html"/> <item name="Installation Guide" href="installation_guide.html"/> <item name="Quick Start" href="quickstart_guide.html"/> + <item name="Deployment Guide" href="deployment_guide.html"/> <item name="Extending ESB" href="extensions_guide.html"/> - <item name="Configuration Language" href="configuration_language.html"/> + <item name="Configuration" href="configuration_language.html"/> </menu> <menu name="Samples"> <item name="Samples Index" href="samples_index.html"/> Added: branches/esb/java/2.1/product/docs/xdoc/deployment_guide.xml URL: http://wso2.org/svn/browse/wso2/branches/esb/java/2.1/product/docs/xdoc/deployment_guide.xml?pathrev=39362 ============================================================================== --- (empty file) +++ branches/esb/java/2.1/product/docs/xdoc/deployment_guide.xml Thu Jun 18 12:19:35 2009 @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> + +<!-- + ~ Copyright (c) 2005-2008, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. + ~ + ~ WSO2 Inc. licenses this file to you under the Apache License, + ~ Version 2.0 (the "License"); you may not use this file except + ~ in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + ~ + --> + +<!DOCTYPE html + 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 - Deployment 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) Deployment Guide + </h1> + <h2> + Available Deployment options + </h2> + <p> + <a href="installation_guide.html">Standalone Deployment Guide</a> : + Describes the default standalone installation and deployment of the ESB + </p> + <p> + <a href="clustered_deployment_guide.html">Clustered Deployment Guide</a> : + Contains details on the clustered deployment of the ESB. + </p> + <p> + <a href="webapp_deployment_guide.html">Webapp Deployment Guide</a> : + Contains the information on deploying the ESB on an existing Application Server + </p> + <h2> + Other Resources + </h2> + <p/> + <p> + <a href="http://wso2.org/taxonomy/term/257/all";>The WSO2 Oxygen Tank + Library</a> : The Library contains articles, tutorials, + presentations, and other knowledge base items published on The Oxygen + Tank. + </p> + <p> + <a href="http://wso2.org/wiki/display/esbjava";>Wiki Space</a> : + This is the working Wiki for WSO2 ESB. + </p> + </body> +</html> Added: branches/esb/java/2.1/product/docs/xdoc/webapp_deployment_guide.xml URL: http://wso2.org/svn/browse/wso2/branches/esb/java/2.1/product/docs/xdoc/webapp_deployment_guide.xml?pathrev=39362 ============================================================================== --- (empty file) +++ branches/esb/java/2.1/product/docs/xdoc/webapp_deployment_guide.xml Thu Jun 18 12:19:35 2009 @@ -0,0 +1,173 @@ +<?xml version="1.0"?> + +<!-- + ~ Copyright (c) 2009, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. + ~ + ~ WSO2 Inc. licenses this file to you under the Apache License, + ~ Version 2.0 (the "License"); you may not use this file except + ~ in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> + +<!DOCTYPE html + 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> + <title> + WSO2 ESB - Webapp Deployment 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> + [ <a href="docs_index.html"> Documentation Index </a> ] + <h1> + WSO2 Enterprise Service Bus (ESB) Webapp Deployment Guide + </h1> + + <p> + WSO2 ESB can be deployed on different application servers such as IBM WebSphere, + BEA WebLogic Server, JBoss and Apache Tomcat. This guide describes how to deploy the ESB + on Apache Tomcat in a step by step aproach. It should be the same approach for the + other application server deployments as well, but it will require some knowledge on the + Application server for you to get it working on that particular application server. + </p> + <h2>Step 1 - Downloading and installing Apache Tomcat</h2> + + <p> + You can download the latest version of Apache Tomcat from here (We will be using Apache + Tomcat 5.5.20 to demonstrate this particular deployment). Extract the downloaded distribution + to a specific location and define the environment variables properly. (Assume you extracted + the downloaded Tomcat into the folder \opt\software\apache-tomcat-5.5.20) + </p> + + <pre>E.g.: - + CATALINA_HOME=\opt\software\apache-tomcat-5.5.20 + </pre> + + <h2>Step 2 - Downloading and installing WSO2 ESB</h2> + + <p> + Download the WSO2 ESB distribution from here and extract to a specific location. + (E.g.:- /opt/software/wso2esb-2.1.0). + </p> + + <p> + Copy the following directories in the extracted distribution to a different location + (this is where we are planning to treat as the ESB_HOME, E.g.:- /opt/software/esb-home) + </p> + + <pre> + - conf + - database + - resources + - repository + </pre> + + <h2>Step 3 - Enable HTTPS on the Apache Tomcat</h2> + + <p> + Next you will need to enable HTTPS on Apache Tomcat since WSO2 ESB administration console + runs over HTTPS. To do this, open up the server.xml file located at $CATALINA_HOME/conf + using your favourite and uncomment the following + </p> + + <pre> + <Connector port="8443" maxHttpHeaderSize="8192" + maxThreads="150" minSpareThreads="25" maxSpareThreads="75" + enableLookups="false" disableUploadTimeout="true" + acceptCount="100" scheme="https" secure="true" + clientAuth="false" sslProtocol="TLS"/></pre> + + <p> + Then you will need to provide the keystore file location along with it's password as below. + </p> + + <pre> + <Connector port="8443" maxHttpHeaderSize="8192" + maxThreads="150" minSpareThreads="25" maxSpareThreads="75" + enableLookups="false" disableUploadTimeout="true" + acceptCount="100" scheme="https" secure="true" + clientAuth="false" sslProtocol="TLS" + keystoreFile = "/opt/software/wso2esb-2.1.0/resources/security/wso2carbon.jks" + keystorePass="wso2carbon"/></pre> + + <h2>Step 4 - Setting environmental variables</h2> + + <p> + You will have to set an environment variable with the name CARBON_HOME pointing it to + the directory which you copied the above files to. + </p> + + <pre>E.g.:- + CARBON_HOME=/opt/software/esb-home + </pre> + + <h2>Step 5 - Copying required files to Apache Tomcat</h2> + + <p>Now create a folder inside the webapps folder of Tomcat.</p> + <pre>E.g.:- + /opt/software/apache-tomcat-5.5.20/webapps/esb + </pre> + + <p> + Next, you need to copy the WEB-INF folder of the extracted distribution of the ESB to + the created webapp directory. + </p> + <pre>E.g.:- + cp -R /opt/software/wso2esb-2.1.0/webapps/ROOT/WEB-INF /opt/software/apache-tomcat-5.5.20/webapps/esb/ + </pre> + + <h2>Step 6 - Configuring the WSO2 ESB</h2> + + <ol> + <li>Open the carbon.xml file which is in the CARBON_HOME/conf folder and specify the + following URL as the ServerURL https://localhost:8443/esb/services/ + </li> + <li>Then you need to specify the absolute paths of the WSO2CARBON_DB of the two files + registry.xml and user-mgt.xml + <pre>jdbc:derby:database/WSO2CARBON_DB;create=true</pre> has to be replaced with + <pre>jdbc:derby:/opt/software/esb-home/WSO2CARBON_DB;create=true</pre> + </li> + <li>In order for the logging to work properly you need to copy the log4j.properties file + found at the lib directory of the extracted distribution to the webapp classpath</li> + <li>You need to specify the correct paths for the two .jks files wso2carbon.jks and + client-truststore.jks specified in the HTTPS transport configuration section of the + axis2.xml and also the wso2carbon.jks file specified in the carbon.xml file. + </li> + <li>Further, you need to uncomment the wsdlEPRPrefix parameter of the HTTP and HTTPS + transport receiver configurations and put the value as + <pre>http://${host}:${port}/services</pre> + </li> + <li>Finally you will have to specify the absolute path of the synapse.xml which is in the + axis2.xml file located at CARBON_HOME/conf + +<pre>conf/synapse.xml</pre> +to +<pre>/opt/software/esb-home/conf/synapse.xml</pre> + </li> + </ol> + <h2>Step 7 - Starting the Apache Tomcat Server</h2> + + <p> + Now you can start the Apache Tomcat server by giving the command from the tomcat + installation bin directory</p> + <pre> ./catalina.sh run</pre> + + <h2>Step 7 - Login to the WSO2 ESB Administration Console</h2> + + <p>Now you should be able to login to the WSO2 ESB Administration Console as,</p> + <pre> https://localhost:8443/esb/carbon</pre> + </body> +</html> _______________________________________________ Esb-java-dev mailing list [email protected] https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
