Skip to end of metadata
Go to start of metadata

Follow the instructions below to install WSO2 Gadget Server on Windows.

Note

Before you install the Gadget Server, ensure that your system meets the minimum hardware and software requirements described in GS Installation Prerequisites.



Step 1. Obtain Installation Pack

Download the latest version of the program (for downloading instructions, see Obtaining GS).


Step 2. Extract the Archive

After the download is complete, extract installation files to the user-defined folder (further to be referred to as GS_HOME).


Step 3. Set up JAVA_HOME

JAVA_HOME environment variable set up is needed to run WSO2 GS. The variable points at the directory where the Java™ Development Kit (JDK) is installed on the computer.

Reference

Environment variables are global system variables accessible by all the processes running under the operating system.

Locate the Installation Folder of the Java™ Development Kit (JDK) on the Machine

1. In order to set the variable, it is necessary to know the system folder to which JDK is installed. Unless the installation path was changed by the user during the installation process, it is installed into the default folder C:\Program Files\Java. Open the directory C:\Program Files\Java using the browser.

2. Inside that path there will be one or more subdirectories, for example, jdk1.5.0_08. If you have just installed the Java Development Kit, it is in the newest directory, which you can find by sorting by date. For example, it may be installed in C:\Program Files\Java\jdk1.6.0_27. This is the installation path.


There are two ways to set up JAVA_HOME: via "System Properties", or via "Windows Command Prompt".

JAVA_HOME Setup via System Properties

Follow the instructions below to set up the JAVA_HOME environment variable using "System Properties".

1. Right-click the "My Computer" icon on the desktop and select "Properties."

2. The "System Properties" window opens with its functional tabs. Go to the "Advanced" tab and click the "Environment Variables" button.

3. The "Environment variables" window opens. Click the "New" button under "System variables" (for all users).

4. The "New system variable" input box opens. Fill in the required fields:

  • In the "Variable name" field, enter "JAVA_HOME" without quotes.
  • In the "Variable value" field, enter the installation path of the Java Development Kit. For example, c:\Program Files\Java\jdk1.6.0_27.

5. In the "New User Variable" popup, fill in the required fields:

  • In the "Variable name" field, enter "JAVA_HOME" without quotes.
  • In the "Variable value" field, enter the installation path of the Java Development Kit, for example, C:\Program Files\java\jdk1.6.0_27.

6. Click "OK."

*"System variables"* or *"User variables"*?

In case there is a need to set up variables only for the user currently logged in, JAVA_HOME should be set up in "User Variables" (the same way as in "System variables"). These changes will not affect any other users.


Notice

Variable set up will be effective for the CMD opened after this operation. In case a CMD was run before the variable was set up, this change will not be effective for it. To ensure the variable set up is effective, and variable value is reset, close and reopen the CMD you will be running Gadget Server from, or close and reopen the browser (e.g. Total commander) you are going to run the CMD from.

JAVA_HOME Setup via Windows Command Prompt (CMD)

Alternatively, you can temporarily set the JAVA_HOME environment variable within a Windows command prompt window (CMD).

1. Open the "CMD" prompt. (Click the "Start" -> "Run" and then type "cmd" and click "OK" to run the CMD)

2. In the opened CMD, enter the following command and press <Enter>:

set JAVA_HOME=<JDK_INSTALLATION_PATH>

Where "<JDK_INSTALLATION_PATH>" is the actual JDK installation directory.

For example, set JAVA_HOME=c:\Program Files\java\jdk1.6.0_27.

3. JAVA_HOME is effectively set up.

Notice

A variable set via the SET command under CMD is a local variable, available to the current CMD session only.


Verify JAVA_HOME Set Up

Follow the instructions below to check if JAVA_HOME was set up correctly:

1. Open the "CMD" prompt. (Click the "Start" -> "Run" and then type "cmd" and click "OK" to run the CMD)

2. In the opened CMD window, enter the following command and press "Enter":

set JAVA_HOME

3. The program shows that JAVA_HOME is set to the JDK installation path, for example, JAVA_HOME=:c\Program Files\java\jdk1.6.0_27.
This means that JAVA_HOME was set up correctly.


Step 4: Set up the Environment and Tools

Maven:

The WSO2 GS build is based on Apache Maven 2. 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 GS from the source distribution. Extensive instructions on using Maven 2 are available on the Maven website.

Please refer to the Maven Getting Started Guide for more information on Maven

  • Unix based OS (e.g., Linux)
  1. Download Apache Maven tar ball or the ZIP archive.
  2. Expand it to a directory of choice.
  3. Set the environment variable M2_HOME and add M2_HOME/bin to the path as well.
  4. Run mvn - version to verify that it is installed correctly.
  • MS Windows
  1. Download and run the Apache Maven Windows installer package.
  2. Set the "Environment Variables" (create the system variable M2_HOME and edit the path. For example, C:\Program Files\Apache Software Foundation\maven-2.0.6; path %M2_HOME%\bin).
  3. Make sure that the system variable JAVA_HOME is set to the location of your JDK, for example, C:\Program Files\Java\jdk1.5.
  4. Run mvn - version to verify that it is installed correctly.

Once Maven is properly installed, you can start building the Gadget Server.


Step 5: Build WSO2 GS

  1. Download the source distribution, which is available as a ZIP archive.
  2. Expand the source archive to a directory of your choice.
  3. All the necessary build scripts are included with the source distribution.
  4. You can run the following command inside that directory to build the WSO2 GS. Note that you will require a connection to the Internet for the Maven build to download dependencies required for the build.
    Command mvn clean install

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.

Note

The first time you run Maven it will automatically download the dependent JAR files. Therefore the first run will take more time.


Step 6: Run GS Start Script

In order to run GS management console, it is necessary to run GS start script.

Follow the instructions below:

1. Open the "CMD" prompt. (Click the "Start" -> "Run" and then type "cmd" and click "OK" to run the CMD)

2. Go to GS_HOME\bin via command:

cd <GS_HOME>\bin

For example, cd c:\wso2wso2gs-1.4.0-src\bin.

3. Execute the following command:

wso2server.bat --run

4. Operation log is displayed.

Note

Make sure no errors occurred.


Step 7: Access the GS

GS is installed, started and environment variables are set up. Proceed to Accessing the Gadget Server section for instructions on how to run the GS Management Console or the Gadget Portal.

  • No labels