Skip to end of metadata
Go to start of metadata

Follow the instructions below to install WSO2 Gadget Server (source) on Linux or Solaris from the command line.


Before you install the Gadget Server, ensure that GS Installation Prerequisites are satisfied.

Establish an SSH connection to the Linux/Solaris machine or log in on the text Linux console.

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 in your home directory by executing the following command:


Step 3. Build WSO2 Gadget Server

Run the following command to build the WSO2 GS in directory you extract installation files.


You need an Internet connection for Maven to download dependencies required for the build.

mvn clean install

It will create the complete release artifacts including the binary and source distributions in the modules/distribution/target/ directory.


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

Step 4. 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.


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

Edit BASHRC file in your home directory to add the JAVA_HOME environment variable. To set up JAVA_HOME, perform the following steps.

1. Open the BASHRC file in your favorite Linux text editor, for example, vi, emacs, pico, or mcedit.

2. Add the following two (2) lines at the bottom of the file:

export JAVA_HOME=/usr/java/jdk1.6.0_25
export PATH=${JAVA_HOME}/bin:${PATH}

3. Save the file.


If you do not know how to work with text editors in Linux SSH session, run the following command:

cat >> .bashrc

Paste the string from the clipboard and press "Ctrl+D."

4. In order to verify the effective JAVA_HOME variable set up, execute the following command:


The system returns the JDK installation path.

Step 5. Execute the WSO2 Gadget Server Start Script

Follow the instructions below to execute the WSO2 GS start script from the bin folder.

1. Establish a SSH connection to the Linux server or log in on the text Linux console.

2. Go to <GS_HOME>/bin, where "<GS_HOME>" is the actual folder where WSO2 GS distribution files are stored.

3. Execute the following command to start the Gadget Server:

sh ./

When trying to execute the Gadget Server binary from a shell after it is installed, if the error message 'Permission denied' pops up, check the file permission of the .sh script and set the execution permission.

4. Operation log is displayed. Gadget Server is running. The last line in the following example indicates the GS has been started successfully.

Step 6. Access the GS

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

  • No labels