[Download] | [Documentation Home] | [Release Note]

Installation Guide

This installation guide provides information on,

  1. The prerequisites for WSO2 Gadget Server
  2. Installation instructions
  3. Starting up WSO2 Gadget Server
  4. Accessing the management console
  5. Accessing Gadget Server Portal
This document explains how Gadget Server should be installed & accessed.

Content

Introduction

The WSO2 Gadget Server is a powerful yet simple gadget repository and a portal solution which is aimed at providing a presentation platform for enterprise mashups and services. WSO2 Gadget Server is distributed in several convenient distribution packages, and can be installed either as a standalone server or as part of a J2EE compliant servlet container. WSO2 Gadget Server is distributed under the Apache License, version 2.0. [Download WSO2 Gadget Server]

System Requirements

Java Runtime Environment 1.6.0_24 or higher (For instructions on setting up the JRE in different operating systems, visit http://java.sun.com)
Memory 1GB
Disk Approximately 200 MB will be used for the .zip distribution
Operating System Tested on Windows XP, Linux (Fedora core, Ubuntu, Gentoo), Mac OS X
The Management Console requires full Javascript enablement of the Web browser NOTE: On Windows Server 2003, it is not allowed to go below the medium security level in Internet Explorer 6.x. For more details see http://wso2.org/wiki/display/carbon/System+Requirements

Installing WSO2 Gadget Server in Standalone Mode

Installing on Microsoft Windows

Note: The WSO2 Gadget Server release has been successfully tested only on Windows XP & Windows 2003 server. You can use the install.bat file in the Gadget Server distribution to install Gadget Server as a Windows NT service. This installation script is available at CARBON_HOME/bin. Here are the steps: Once you add WSO2 Gadget Server as an NT service to Windows services, you can start this service from Services in Administrative tools of the Control Panel. Check your WSO2 Gadget Server instance using the URL https://localhost:8443/carbon/

Installing on Linux

  1. Download the WSO2 Gadget Server binary distribution.
  2. Extract the zip archive. e.g., unzip wso2gs-1.4.2.zip -d /opt
  3. Set the JAVA_HOME environment variable to your Java installation using the export command or by editing /etc/profile. e.g., export JAVA_HOME="/opt/j2sdk"
  4. Execute the WSO2 Gadget Server starting script. e.g., cd /opt/wso2gs-1.4.2/bin; sh wso2server.sh
  5. Check your WSO2 Gadget Server instance using the URL https://localhost:8443/carbon/

Troubleshooting Installation

When trying to execute the WSO2 Gadget Server binary from a shell, e.g., /usr/bin/wso2gs (after WSO2 Gadget Server , has been installed), if the error message 'Permission denied' pops up, then check the file permission of the run.sh script and set the execution permission.

Remove Installation

On MS Windows systems, to remove the Gadget Server Windows NT service;

Accessing the Management Console

Once WSO2 Gadget Server has been successfully installed, in order to access the Management Console, first start the server, launch a web browser instance, and then point it to the URL https://localhost:8443/carbon/ (if you are using the default settings). This will take you to the "Sign In" page of the Management Console. Note: By default, WSO2 Gadget Server has two listeners, HTTP and HTTPS. The HTTP listener opens on port 8080, while the HTTPS listener opens on port 8443. The administrator functions are exposed only via the HTTPS port.

Accessing the Portal

Gadget portal can be easily accessed when the server is running by accessing https://localhost:8443/portal/