Author: channa Date: Fri Aug 8 02:10:50 2008 New Revision: 20587 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=20587
Log: Updated documentation to address points 2 and 4 of MASHUP-1064. Modified: branches/mashup/java/1.5/java/modules/distribution/installer/mashupserver-setup.nsi.readme.txt branches/mashup/java/1.5/java/xdocs/installationguide.html Modified: branches/mashup/java/1.5/java/modules/distribution/installer/mashupserver-setup.nsi.readme.txt URL: http://wso2.org/svn/browse/wso2/branches/mashup/java/1.5/java/modules/distribution/installer/mashupserver-setup.nsi.readme.txt?rev=20587&r1=20586&r2=20587&view=diff ============================================================================== --- branches/mashup/java/1.5/java/modules/distribution/installer/mashupserver-setup.nsi.readme.txt (original) +++ branches/mashup/java/1.5/java/modules/distribution/installer/mashupserver-setup.nsi.readme.txt Fri Aug 8 02:10:50 2008 @@ -10,7 +10,7 @@ 4. Run MakeNSISW (Compiler GUI) of NSIS from Start -> Programs -> NSIS -5. Load the mashupserver-setup.nsi script using File -> Load Script ... +5. Load the mashupserver-setup.nsi script, available in the 'modules/distribution/target/dist' directory using File -> Load Script ... 6. When the Compiler successfully completes the tasks, the installer executable will be created by the name of wso2-mashup-server-win-setup.exe Modified: branches/mashup/java/1.5/java/xdocs/installationguide.html URL: http://wso2.org/svn/browse/wso2/branches/mashup/java/1.5/java/xdocs/installationguide.html?rev=20587&r1=20586&r2=20587&view=diff ============================================================================== --- branches/mashup/java/1.5/java/xdocs/installationguide.html (original) +++ branches/mashup/java/1.5/java/xdocs/installationguide.html Fri Aug 8 02:10:50 2008 @@ -1,259 +1,290 @@ -<!-- - ~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com) - ~ - ~ Licensed 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. - --> -<html> -<head> - <meta http-equiv="content-type" content=""> - <title>WSO2 Mashup Server [EMAIL PROTECTED]@ Installation Guide</title> - <link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all"> -</head> -<body> -<div id="main-content"> -<h1>WSO2 Mashup Server [EMAIL PROTECTED]@ Installation Guide</h1> -This document describes the distribution packages available in the WSO2 -Mashup Server - the binary distribution and the source distribution for -more -advanced users. It is followed by simple instructions on how to install -and -run the WSO2 Mashup Server using the binary distribution and how to -build the -WSO2 Mashup Server using the source distribution. <br> -<br> -<strong>Table of Contents</strong> -<div class="toc"> -<ul> - <li><a href="#Distributi">Distribution Packages</a></li> - <li><a href="#Installing">Installing and Running the WSO2 Mashup -Server using the Binary Distribution</a> - <ul> - <li><a href="#Pre-requis">Pre-requisites</a></li> - <li><a href="#Installing1">Installing on MS Windows</a></li> - <li><a href="#Installing2">Installing on Linux</a></li> - </ul> - </li> - <li><a href="#Building">Building WSO2 Mashup Server Using the Source -Distribution</a> - <ul> - <li><a href="#Pre-requis1">Pre-requisites</a></li> - <li><a href="#Setting">Setting up the Environment and Tools</a></li> - <li><a href="#Building1">Building WSO2 Mashup Server</a></li> - <li><a href="#BuildingInstaller">Building the Windows Installer</a></li> - </ul> - </li> -</ul> -</div> -<h2 id="Distributi">Distribution Packages</h2> -The following distribution packages are available for <a - href="http://dist.wso2.org/products/mashup/@mashup_version@/";>download</a> -<ol> - <li>Binary Distribution : Includes a binary file (.zip) for both MS -Windows and Linux operating systems. Recommended for normal users. </li> - <li>Source Distribution : Includes the source that is used to build -the binary files. Recommended for more advanced users. </li> -</ol> -<h2 id="Installing">Installing and Running the WSO2 Mashup Server using -the Binary Distribution</h2> -<h3 id="Pre-requis">Pre-requisites</h3> -<table class="MsoTableGrid" - style="margin-left: 0.5in; border-collapse: collapse;" border="1" - cellpadding="5" cellspacing="0"> - <tbody> - <tr> - <td><a href="http://java.sun.com/javase/downloads/index.jsp";>Java -SE Development Kit</a></td> - <td>JDK 1.5 or later (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>Web browser- To start the Mashup Server Web Console </td> - <td>Mozilla Firefox, MS Internet Explorer 6 or 7. Once your run -the WSO2 Mashup Server and point the browser to https://localhost:7443 -you can access your Web Console. See <a href="adminguide.html">Web -Console guide</a> for more details. </td> - </tr> - <tr> - <td>Disk</td> - <td>No minimum requirement. The installation will require -approximately 90MB excluding the space allocated for log files. </td> - </tr> - <tr> - <td>Operating System</td> - <td>Tested on MS Windows - XP/ Vista & Linux.</td> - </tr> - </tbody> -</table> -<br> -<h3 id="Installing1">Installing on MS Windows</h3> -<ol> - <li><a - href="http://dist.wso2.org/products/mashup/[EMAIL PROTECTED]@.zip">Download</a> -the WSO2 Mashup Server binary distribution. </li> - <li>Extract the zip archive.</li> - <li>Set the <a href="setting-java-home.html">JAVA_HOME</a> -environment variable to your Java installation. </li> - <li>Execute the WSO2 Mashup Server starting script. e.g., WSO2Mashup -Server_HOME\bin\startup.bat </li> - <li>Check your WSO2 Mashup Server instance using the URL -https://localhost:7443, which will take you to the WSO2 Mashup Server -Web Console. (Refer to the <a href="adminguide.html">Web -Console guide</a> for more details).</li> -</ol> -<br> -<span style="font-weight: bold;">Installing Using the Windows Installer -</span><br> -<ol> - <li><a - href="http://dist.wso2.org/products/mashup/[EMAIL PROTECTED]@-setup.exe">Download</a> -the WSO2 Mashup Server Windows setup.</li> - <li>Run the .exe file and follow the wizard entering data where -necessary.</li> - <li>After -the installation, the WSO2 Mashup Server will be installed as a windows -service. You will also have a monitoring icon in the Windows -System Tray. You can use this to easily start, stop and monitor the -status of your server. The WSO2 Mashup Server service and the -System Tray Monitor will be started automatically at system -startup. You can manually start the monitor using shortcuts -installed in the Windows Programmes menu.</li> - <li>Check your WSO2 Mashup Server instance using the URL -https://localhost:7443, which will take you to the WSO2 Mashup Server -Web Console. (Refer to the <a href="adminguide.html">Web -Console guide</a> for more details).<br> - </li> -</ol> -<br> -<h3 id="Installing2">Installing on Linux</h3> -<ol> - <li><a - href="http://dist.wso2.org/products/mashup/[EMAIL PROTECTED]@.zip">Download</a> -the WSO2 Mashup Server binary distribution. </li> - <li>Extract the tar.gz archive. Example, unzip [EMAIL PROTECTED]@.zip -d /opt </li> - <li>Set the JAVA_HOME environment variable to your Java installation -using the export command or by editing /etc/profile. For example, -export JAVA_HOME="/opt/j2sdk" </li> - <li>Execute the WSO2 Mashup Server starting script. Example, cd -/opt/wso2-mashup-server/bin; sh startup.sh </li> - <li>Check your WSO2 Mashup Server instance using the URL -https://localhost:7443/ which will take you to the WSO2 Mashup Server -Web Console. (Refer to the <a href="adminguide.html">Web -Console guide</a> for more details.)</li> -</ol> -<span style="font-weight: bold;"><br> -Please refer to the <a href="usermanagement.html">User Management Guide</a> -for details on -how to setup the administrative account for the Mashup Server.</span><br> -<br> -<h2 id="Building">Building WSO2 Mashup Server Using the Source -Distribution</h2> -<h3 id="Pre-requis1">Pre-requisites</h3> -<table class="MsoTableGrid" - style="margin-left: 0.5in; border-collapse: collapse;" border="1" - cellpadding="5" cellspacing="0"> - <tbody> - <tr> - <td><a href="http://java.sun.com/javase/downloads/index.jsp";>Java -SE Development Kit</a></td> - <td> JDK 1.5 or a later version (For instructions on setting up -the JDK in different operating systems, visit <a - href="http://java.sun.com";>http://java.sun.com</a>) - <p>To build the WSO2 Mashup Server from the Source distribution, -it is necessary that you have the JDK 1.5 or a later version.</p> - </td> - </tr> - <tr> - <td><a href="http://maven.apache.org/";>Apache Maven</a>- To build -the Mashup Server from the Source </td> - <td>To build the WSO2 Mashup Server from its source distribution, -you will need Maven 2.0.7 or a later version. </td> - </tr> - <tr> - <td>Operating System</td> - <td>MS Windows - XP/ Vista or Linux</td> - </tr> - </tbody> -</table> -<h3 id="Setting">Setting up the Environment and Tools</h3> -<p><strong>Maven:</strong></p> -<p>The WSO2 Mashup Server build is based on <a - href="http://maven.apache.org/maven-1.x/";>Apache Maven</a>. Hence, it -is a pre-requisite to have Maven (version 2.0.7 or later) and JDK -(version 1.5 or later) installed to build the WSO2 Mashup Server from -the source distribution. Extensive instructions on Maven builds are -available on the Maven site.</p> -<p>This guide however contains the easiest path for quick environment -setting. Advanced users can learn more about <a - href="http://maven.apache.org/guides/getting-started/index.html";>Maven</a>.</p> -<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 -MAVEN2_HOME and edit the path. e.g., "C:\Program Files\Apache Software -Foundation\maven-2.0.7"; path %MAVEN2_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 maven--version to verify that it is correctly installed.</li> -</ol> -<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 your choice.</li> - <li>Set the environment variable MAVEN2_HOME and add MAVEN2_HOME/bin -to the path as well. </li> -(Refer to more instructions on how to install Maven in Unix based -operating systems.) -</ol> -<p>Once Maven is properly installed, you can start building the WSO2 -Mashup Server.</p> -<h3 id="Building1">Building WSO2 Mashup Server</h3> -<ol> - <li><a href="http://dist.wso2.org/products/mashup/@mashup_version@/#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 Mashup Server. </li> -</ol> -<code>mvn clean install</code> -<p>This will create the complete release artifacts including the binary -and source distributions. The build artifacts will be places in -modules/distribution/target.<br> -</p> -<p><strong>Note</strong>: The first time you run Maven it will -automatically download the dependent .jar files. Therefore, the first -run will take more time.<br> -</p> -<h3 id="BuildingInstaller">Building the Windows Installer</h3> -<p>To build the Windows installer, you should first download the -Nullsoft Scriptable Install System (NSIS) from -http://nsis.sourceforge.net and install it in your build machine.<br> -</p> -<p>The <code>mvn clean install -Dbuild-setup </code> command will -build a windows installer in -modules/distribution/target. Please refer to the -mashupserver-setup.nsi.readme.txt file available on your source -distribution for further details on using the NSIS script.<br> -</p> -</div> -<p>© 2007-2008 WSO2 Inc.</p> -</body> -</html> +<!-- +~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com) +~ +~ Licensed 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. +--> +<html> +<head> + <meta http-equiv="content-type" content=""> + <title>WSO2 Mashup Server [EMAIL PROTECTED]@ Installation Guide</title> + <link href="css/mashup-docs.css" rel="stylesheet" type="text/css" + media="all"> +</head> + +<body> + +<div id="main-content"> +<h1>WSO2 Mashup Server [EMAIL PROTECTED]@ Installation Guide</h1> +This document describes the distribution packages available in the WSO2 +Mashup Server - the binary distribution and the source distribution for more +advanced users. It is followed by simple instructions on how to install and +run the WSO2 Mashup Server using the binary distribution and how to build the +WSO2 Mashup Server using the source distribution. <br> +<br> +<strong>Table of Contents</strong> + +<div class="toc"> +<ul> + <li><a href="#Distributi">Distribution Packages</a></li> + <li><a href="#Installing">Installing and Running the WSO2 Mashup Server + using the Binary Distribution</a> + <ul> + <li><a href="#Pre-requis">Pre-requisites</a></li> + <li><a href="#Installing1">Installing on MS Windows</a></li> + <li><a href="#Installing2">Installing on Linux</a></li> + </ul> + </li> + <li><a href="#Building">Building WSO2 Mashup Server Using the Source + Distribution</a> + <ul> + <li><a href="#Pre-requis1">Pre-requisites</a></li> + <li><a href="#Setting">Setting up the Environment and Tools</a></li> + <li><a href="#Building1">Building WSO2 Mashup Server</a></li> + <li><a href="#BuildingInstaller">Building the Windows Installer</a></li> + </ul> + </li> +</ul> +</div> + +<h2 id="Distributi">Distribution Packages</h2> +The following distribution packages are available for <a +href="http://dist.wso2.org/products/mashup/@mashup_version@/";>download</a> +<ol> + <li>Binary Distribution : Includes a binary file (.zip) for both MS Windows + and Linux operating systems. Recommended for normal users. </li> + <li>Source Distribution : Includes the source that is used to build the + binary files. Recommended for more advanced users. </li> +</ol> + +<h2 id="Installing">Installing and Running the WSO2 Mashup Server using the +Binary Distribution</h2> + +<h3 id="Pre-requis">Pre-requisites</h3> + +<table class="MsoTableGrid" +style="margin-left: 0.5in; border-collapse: collapse;" border="1" +cellpadding="5" cellspacing="0"> + <tbody> + <tr> + <td><a href="http://java.sun.com/javase/downloads/index.jsp";>Java SE + Development Kit</a></td> + <td>JDK 1.5 or later (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>Web browser- To start the Mashup Server Web Console </td> + <td>Mozilla Firefox, MS Internet Explorer 6 or 7. Once your run the + WSO2 Mashup Server and point the browser to https://localhost:7443 + you can access your Web Console. See <a href="adminguide.html">Web + Console guide</a> for more details. </td> + </tr> + <tr> + <td>Disk</td> + <td>No minimum requirement. The installation will require approximately + 90MB excluding the space allocated for log files. </td> + </tr> + <tr> + <td>Operating System</td> + <td>Tested on MS Windows - XP/ Vista & Linux.</td> + </tr> + </tbody> +</table> +<br> + + +<h3 id="Installing1">Installing on MS Windows</h3> +<ol> + <li><a + href="http://dist.wso2.org/products/mashup/[EMAIL PROTECTED]@.zip">Download</a> + the WSO2 Mashup Server binary distribution. </li> + <li>Extract the zip archive.</li> + <li>Set the <a href="setting-java-home.html">JAVA_HOME</a> environment + variable to your Java installation. </li> + <li>Execute the WSO2 Mashup Server starting script. e.g., WSO2Mashup + Server_HOME\bin\startup.bat </li> + <li>Check your WSO2 Mashup Server instance using the URL + https://localhost:7443, which will take you to the WSO2 Mashup Server Web + Console. (Refer to the <a href="adminguide.html">Web Console guide</a> + for more details).</li> +</ol> +<br> +<span style="font-weight: bold;">Installing Using the Windows Installer +</span><br> + +<ol> + <li><a + href="http://dist.wso2.org/products/mashup/[EMAIL PROTECTED]@-setup.exe">Download</a> + the WSO2 Mashup Server Windows setup.</li> + <li>Run the .exe file and follow the wizard entering data where + necessary.</li> + <li>After the installation, the WSO2 Mashup Server will be installed as a + windows service. You will also have a monitoring icon in the Windows + System Tray. You can use this to easily start, stop and monitor the + status of your server. The WSO2 Mashup Server service and the System Tray + Monitor will be started automatically at system startup. You can manually + start the monitor using shortcuts installed in the Windows Programmes + menu.</li> + <li>Check your WSO2 Mashup Server instance using the URL + https://localhost:7443, which will take you to the WSO2 Mashup Server Web + Console. (Refer to the <a href="adminguide.html">Web Console guide</a> + for more details).<br> + </li> +</ol> +<br> + + +<h3 id="Installing2">Installing on Linux</h3> +<ol> + <li><a + href="http://dist.wso2.org/products/mashup/[EMAIL PROTECTED]@.zip">Download</a> + the WSO2 Mashup Server binary distribution. </li> + <li>Extract the tar.gz archive. Example, unzip + [EMAIL PROTECTED]@.zip -d /opt </li> + <li>Set the JAVA_HOME environment variable to your Java installation using + the export command or by editing /etc/profile. For example, export + JAVA_HOME="/opt/j2sdk" </li> + <li>Execute the WSO2 Mashup Server starting script. Example, cd + /opt/wso2-mashup-server/bin; sh startup.sh </li> + <li>Check your WSO2 Mashup Server instance using the URL + https://localhost:7443/ which will take you to the WSO2 Mashup Server Web + Console. (Refer to the <a href="adminguide.html">Web Console guide</a> + for more details.)</li> +</ol> +<span style="font-weight: bold;"><br> +Please refer to the <a href="usermanagement.html">User Management Guide</a> +for details on how to setup the administrative account for the Mashup +Server.</span><br> +<br> + + +<h2 id="Building">Building WSO2 Mashup Server Using the Source +Distribution</h2> + +<h3 id="Pre-requis1">Pre-requisites</h3> + +<table class="MsoTableGrid" +style="margin-left: 0.5in; border-collapse: collapse;" border="1" +cellpadding="5" cellspacing="0"> + <tbody> + <tr> + <td><a href="http://java.sun.com/javase/downloads/index.jsp";>Java SE + Development Kit</a></td> + <td>JDK 1.5 or a later version (For instructions on setting up the JDK + in different operating systems, visit <a + href="http://java.sun.com";>http://java.sun.com</a>) + + <p>To build the WSO2 Mashup Server from the Source distribution, it + is necessary that you have the JDK 1.5 or a later version.</p> + </td> + </tr> + <tr> + <td><a href="http://maven.apache.org/";>Apache Maven</a>- To build the + Mashup Server from the Source </td> + <td>To build the WSO2 Mashup Server from its source distribution, you + will need Maven 2.0.7 or a later version. </td> + </tr> + <tr> + <td>Operating System</td> + <td>MS Windows - XP/ Vista or Linux</td> + </tr> + </tbody> +</table> + +<h3 id="Setting">Setting up the Environment and Tools</h3> + +<p><strong>Maven:</strong></p> + +<p>The WSO2 Mashup Server build is based on <a +href="http://maven.apache.org/maven-1.x/";>Apache Maven</a>. Hence, it is a +pre-requisite to have Maven (version 2.0.7 or later) and JDK (version 1.5 or +later) installed to build the WSO2 Mashup Server from the source +distribution. Extensive instructions on Maven builds are available on the +Maven site.</p> + +<p>This guide however contains the easiest path for quick environment +setting. Advanced users can learn more about <a +href="http://maven.apache.org/guides/getting-started/index.html";>Maven</a>.</p> +<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 MAVEN2_HOME + and edit the path. e.g., "C:\Program Files\Apache Software + Foundation\maven-2.0.7"; path %MAVEN2_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 maven--version to verify that it is correctly installed.</li> +</ol> +<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 your choice.</li> + <li>Set the environment variable MAVEN2_HOME and add MAVEN2_HOME/bin to the + path as well. </li> + (Refer to more instructions on how to install Maven in Unix based operating + systems.) </ol> + +<p>Once Maven is properly installed, you can start building the WSO2 Mashup +Server.</p> + +<h3 id="Building1">Building WSO2 Mashup Server</h3> +<ol> + <li><a + href="http://dist.wso2.org/products/mashup/@mashup_version@/#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 Mashup Server. </li> +</ol> +<code>mvn clean install</code> + +<p>This will create the complete release artifacts including the binary and +source distributions. The build artifacts will be places in +modules/distribution/target.<br> +</p> + +<p><strong>Note</strong>: The first time you run Maven it will automatically +download the dependent .jar files. Therefore, the first run will take more +time.<br> +</p> + +<h3 id="BuildingInstaller">Building the Windows Installer</h3> + +<p>To build the Windows installer, you should first download the Nullsoft +Scriptable Install System (NSIS) from http://nsis.sourceforge.net and install +it in your build machine.</p> +<ul> + <li>Please refer to the mashupserver-setup.nsi.readme.txt file available in + the '/modules/distribution/installer' directory of your source + distribution for details on using the NSIS script. </li> + <li> +<p>The <code>mvn clean install -Dbuild-setup </code> command will build a +windows installer in modules/distribution/target directory. +</li> +<li> +If you want the +installer to include the dashboard, use the <code>-Dbuild-setup-dashboard</code> + +parameter instead. +</div></li></ul> + +<p>© 2007-2008 WSO2 Inc.</p> +</body> +</html> _______________________________________________ Mashup-dev mailing list [email protected] http://mailman.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
