This documentation is for WSO2 Governance Registry 4.1.1. View documentation for the latest release.
Skip to end of metadata
Go to start of metadata

Follow the below instructions to install WSO2 Governance Registry (source) version 4.1.1 on Windows.


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

Step 1. Obtain Installation Pack

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

Step 2. Extract the Archive

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

Step 3. Set up JAVA_HOME

JAVA_HOME environment variable set up is required to run WSO2 Governance Registry. The variable points to 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.

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

1. In order to set the variable, you need to know the system folder where JDK is installed. Unless the installation path was changed by the user during the installation process, it is installed in 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 sub-directories (for example, jdk1.5.0_08). If you have just recently installed the Java Development Kit, it will be located 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_25. (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 below instructions to set up the JAVA_HOME environment variable using "System Properties."

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

2. Click "Properties."

3. The "System Properties" window opens with its functional tabs. Go to the "Advanced" tab.

4. In the "Advanced" tab, click on the "Environment Variables" button.

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

6. 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_25).

6. 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_25).

7. Click "OK."

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

If you need to set up variables only for the user that is 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.


Variable set up will be effective for the CMD opened after this operation. If a CMD runs before the variable is set up, this change will not be effective for that CMD. To ensure that the variable set up is effective and that the variable value is reset, close and reopen the CMD from which you will be running Governance Registry, or close and reopen the browser (for example, Total Commander) from which you are going to run the CMD.

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. Click "Start" "Run."

2. Type "cmd" click "OK" to run CMD.

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


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

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

4. JAVA_HOME is effectively set up.


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 below instructions to check if JAVA_HOME was set up correctly:

1. Click "Start" "Run."

2. Type "cmd" click "OK" to run CMD.

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


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

Step 4: Set up the Environment and Tools


The WSO2 Governance Registry 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 Governance Registry 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 (for example, Linux)
  1. Download the Apache Maven tar ball or the ZIP archive.
  2. Expand it to a directory of your choice.
  3. Set the environment variable as 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, the path may be 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 WSO2 Governance Registry.

Step 5: Build WSO2 Governance Registry

  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 Governance Registry:


    You will require a connection to the Internet for the Maven build to download the 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.


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

Step 6: Run Governance Registry Start Script

In order to run the Governance Registry Management Console, you need to run the Governance Registry start script.

Follow the instructions below:

1. Click "Start" "Run."

2. Type "cmd" click "OK" to run "CMD."

3. Go to GREG_HOME\bin via the command:

cd GREG_HOME\bin

For example, cd c:\greg\wso2greg-4.1.1-src\bin.

4. Execute the following command:

wso2server.bat --run

5. The operation log is displayed.


Make sure no errors occurred.

Step 7: Access Governance Registry Management Console

Governance Registry is installed and environment variables are set up. Proceed to Starting Governance Registry Management Console on Windows for instructions on how to run the Governance Registry Management Console.

  • No labels