[Carbon-dev] svn commit r30448 - branches/carbon/1.5/trunk/registry/docs/xdoc

chathura at wso2.com chathura at wso2.com
Thu Feb 5 00:57:45 PST 2009


Author: chathura
Date: Thu Feb  5 00:57:44 2009
New Revision: 30448
URL: http://wso2.org/svn/browse/wso2?view=rev&revision=30448

Log:

added the installation guide.



Added:
   branches/carbon/1.5/trunk/registry/docs/xdoc/installation_guide.xml

Added: branches/carbon/1.5/trunk/registry/docs/xdoc/installation_guide.xml
URL: http://wso2.org/svn/browse/wso2/branches/carbon/1.5/trunk/registry/docs/xdoc/installation_guide.xml?pathrev=30448
==============================================================================
--- (empty file)
+++ branches/carbon/1.5/trunk/registry/docs/xdoc/installation_guide.xml	Thu Feb  5 00:57:44 2009
@@ -0,0 +1,334 @@
+<?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 Registry - Installation Guide </title>
+  <link href="css/registry-docs.css" rel="stylesheet"/>
+  <link href="styles/dist-docs.css" rel="stylesheet" type="text/css"
+  media="all" />
+</head>
+
+<body xml:lang="en">
+<h1>WSO2 Registry Installation Guide </h1>
+
+<p></p>
+
+<p>This installation guide provides information on,</p>
+<ol>
+  <li>the prerequisites for WSO2 Registry</li>
+  <li>installation instructions</li>
+  <li>starting up WSO2 Registry</li>
+  <li>accessing the management console</li>
+</ol>
+
+<p>This document describes the distribution packages available in WSO2
+Registry - the binary distribution and the source distribution for more
+advanced users. It is followed by simple instructions on how to install and
+run WSO2 Registry using the binary distribution and how to build WSO2
+Registry 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 Registry 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 Registry 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 Registry</a> </li>
+    </ul>
+  </li>
+  <li><a href="#samples">Running Samples</a></li>
+</ul>
+</div>
+
+<h2 id="Distributi">Distribution Packages </h2>
+
+<p>The following distribution packages are available for <a
+href="http://dist.wso2.org/products/registry/java/">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 Registry using the Binary
+Distribution </h2>
+
+<h3 id="Prerequisi">Prerequisites </h3>
+
+<p></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>To build WSO2 Registry 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://ant.apache.org/">Apache Ant</a> - To extract jar
+        files required for remote Registry </td>
+      <td><p>Ant script is provided to extract the jar files required to run
+        the remote Registry API. This would simplify the process of setting
+        up remote client applications. Ant 1.7.0 version is recommended. </p>
+      </td>
+    </tr>
+    <tr>
+      <td><a href="http://maven.apache.org/">Apache Maven</a>- To build
+        Registry from Source </td>
+      <td>To build the WSO2 Registry from its source distribution, you will
+        need Maven 2.0.6 or later </td>
+    </tr>
+    <tr>
+      <td>Web browser- To start the Registry Management Console </td>
+      <td>The Management Console requires you to enable Javascript of the Web
+        browser, with MS IE 6 and 7. In addition to JavaScript, ActiveX
+        should also be enabled with IE. This can be achieved by setting your
+        security level to medium or lower. 
+
+        <p>NOTE:</p>
+
+        <p>On Windows Server 2003, it is not allowed to go below the medium
+        security level in Internet Explorer 6.x and the default medium
+        security setting with IE does not allow sufficient level of JS or
+        ActiveX enablement for the management console to run.</p>
+      </td>
+    </tr>
+    <tr>
+      <td>Memory </td>
+      <td>Minimum memory 256MB</td>
+    </tr>
+    <tr>
+      <td>Disk </td>
+      <td>The installation will require ~150MB excluding space allocated for
+        log files and Databases. </td>
+    </tr>
+    <tr>
+      <td>Operating System </td>
+      <td>Linux, MS Windows. As the WSO2 Registry is a Java application, it
+        will generally be possible to run it on other operating systems with
+        a JDK 1.5.x runtime.</td>
+    </tr>
+  </tbody>
+</table>
+
+<p></p>
+
+<h2 id="Installing2">Installing on Linux/Unix</h2>
+
+<p>The following steps will take you through the linux/unix distribution
+installation. </p>
+<ol>
+  <li><a href="http://dist.wso2.org/products/registry/java/">Download</a> the WSO2
+    Registry binary distribution. </li>
+  <li>Extract the zip archive where you want the WSO2 Registry installed
+    (e.g. /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 Registry start script or the daemon script from the
+    bin directory. e.g. ./wso2server.sh OR ./daemon.sh start OR
+    ./wso2server.sh --console 
+    <p>Usage of the shell scripts:</p>
+    <p>i) ./wso2server.sh {console | start | stop | restart | status | dump |
+    version}</p>
+    <p>ii) ./daemon.sh {console | start | stop | restart | status | dump}</p>
+    <p>Usage: wso2server.sh [command]</p>
+    <p>command:</p>
+    <ul>
+      <li>--debug &lt;port&gt; Start the server in remote debugging mode. 
+        <p>port: The remote debugging port.</p>
+      </li>
+      <li>--run Run the server</li>
+      <li>--start Start Carbon as a Unix daemon in the background</li>
+      <li>--console Start Carbon as a Unix daemon in the foreground</li>
+      <li>--stop Stop the Carbon Unix daemon</li>
+      <li>--status Get the status of the Carbon Unix daemon</li>
+      <li>--dump Print a thread dump of the Carbon Unix daemon</li>
+      <li>--restart Restart the Carbon Unix daemon</li>
+      <li>--version What version of the Carbon server are you running 
+        <p></p>
+      </li>
+    </ul>
+  </li>
+  <li>Check your WSO2 Registry instance using the URL
+    https://localhost:9443/carbon which will take you to the WSO2 Registry
+    Management Console. </li>
+  <li>Login as "admin" using the default password "admin" </li>
+</ol>
+<a></a> 
+
+<h2 id="Installing1">Installing on MS Windows</h2>
+
+<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/registry/java/">Download</a> the WSO2
+    Registry binary distribution. </li>
+  <li>Extract the zip archive where you want the WSO2 Registry 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 Registry start script from the bin folder. e.g.
+    wso2server.bat 
+    <p>Usage of start script: wso2server.bat {start | stop | version}</p>
+    <ul>
+      <li>--start Start Carbon as a Unix daemon in the background</li>
+      <li>--stop Stop the Carbon Unix daemon</li>
+      <li>--version What version of the Carbon server are you running 
+        <p></p>
+      </li>
+    </ul>
+  </li>
+  <li>Check your WSO2 Registry instance using the URL
+    https://localhost:9443/carbon which will take you to the WSO2 Registry
+    Management Console. </li>
+  <li>Login as "admin" using the default password "admin" </li>
+</ol>
+
+<h2 id="Building">Building WSO2 Registry Using the Source Distribution </h2>
+
+<h3 id="Prerequisi1">Prerequisites </h3>
+
+<p></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
+        Registry from Source </td>
+      <td>To build the WSO2 Registry 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></p>
+
+<h3 id="Setting">Setting up the Environment and Tools </h3>
+
+<p></p>
+
+<p><strong>Maven:</strong> </p>
+
+<p>The WSO2 Registry 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 Registry 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
+Registry. </p>
+
+<h3 id="Building1">Building WSO2 Registry </h3>
+<ol>
+  <li><a href="http://dist.wso2.org/products/registry/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 Registry. 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>
+
+<p></p>
+
+<h2 id="samples"><a id="Running">Running Samples</a></h2>
+
+<p></p>
+
+<p>WSO2 Registry samples are available at CARBON_HOME/samples directory. The
+instructions to run sample are given in README file of the respective
+samples.</p>
+</body>
+</html>



More information about the Carbon-dev mailing list