WSO2 Governance Registry - Installation Guide [ Documentation Index ]

WSO2 Governance Registry Installation Guide

This installation guide provides information on,

  1. the prerequisites for WSO2 Governance Registry
  2. installation instructions
  3. starting up WSO2 Governance Registry
  4. accessing the management console

This document describes the distribution packages available in WSO2 Registry - the binary distribution and the source distribution for more advanced users. It is followed by simple instructions on how to install and run WSO2 Governance Registry using the binary distribution and how to build WSO2 Registry using the source distribution.

Table of Contents

Distribution Packages

The following distribution packages are available for download.

1. Binary Distribution : Includes binary files for both MS Windows and Linux operating systems as a zip file. Recommended for normal users.

2. Source Distribution : Includes the source for both MS Windows and Linux operating systems as a zip file that is used to build the binary files. Recommended for more advanced users.

Installing and Running WSO2 Governance Registry using the Binary Distribution

Prerequisites

Java SE Development Kit 1.6.0_24 or later (For instructions on setting up the JDK on different operating systems, visit http://java.sun.com)

To build WSO2 Governance Registry from the Source distribution, it is necessary that you have JDK 1.6.0_24 or later and Maven 2.1.0 or later

Apache Ant - To extract jar files required for remote Registry

Ant script is provided to extract the jar files required to run the remote Registry API. This would simplify the process of setting up remote client applications. Ant 1.7.0 version is recommended.

Apache Maven- To build Registry from Source To build the WSO2 Governance Registry from its source distribution, you will need Maven 2.1.0 or later
Web browser- To start the Registry Management Console The Management Console requires you to enable JavaScript of the Web browser, with MS IE 7, 8 and 9. In addition to JavaScript, ActiveX should also be enabled with IE. This can be achieved by setting your security level to medium or lower.
Memory Minimum memory 1GB
Disk The installation will require ~200MB excluding space allocated for log files and Databases.
Operating System Linux, MS Windows. As the WSO2 Governance Registry is a Java application, it will generally be possible to run it on other operating systems with a JDK 1.6 runtime.

Installing on Linux/Unix

The following steps will take you through the linux/unix distribution installation.

  1. Download the WSO2 Governance Registry binary distribution.
  2. Extract the zip archive where you want the WSO2 Governance Registry installed (e.g. /opt)
  3. Set the JAVA_HOME environment variable to your Java home using the export command or by editing /etc/profile, and add the Java /bin directory to your PATH
  4. Execute the WSO2 Governance Registry start script or the daemon script from the bin directory. e.g. ./wso2server.sh OR ./daemon.sh start OR ./wso2server.sh --console Usage of the shell scripts:

    i) ./wso2server.sh {console | start | stop | restart | status | dump | version}

    ii) ./daemon.sh {console | start | stop | restart | status | dump}

    Usage: wso2server.sh [command]

    command:

    • --debug <port> Start the server in remote debugging mode port: The remote debugging port
    • --start Start Carbon as a Unix daemon in the background
    • --console Start Carbon as a Unix daemon in the foreground
    • --stop Stop the Carbon Unix daemon
    • --status Get the status of the Carbon Unix daemon
    • --dump Print a thread dump of the Carbon Unix daemon
    • --restart Restart the Carbon Unix daemon
    • --version What version of the Carbon server are you running
  5. Check your WSO2 Governance Registry instance using the URL https://localhost:9443/carbon which will take you to the WSO2 Governance Registry Management Console.
  6. Login as "admin" using the default password "admin"

Installing on MS Windows

The following steps will take you through the installation for the MS Windows operating system.

  1. Download the WSO2 Governance Registry binary distribution.
  2. Extract the zip archive where you want the WSO2 Governance Registry installed
  3. Set the JAVA_HOME environment variable to your Java installation, and the PATH environment variable to the Java /bin directory.
  4. Execute the WSO2 Governance Registry start script from the bin folder. e.g. wso2server.bat Usage of start script: wso2server.bat {start | stop | run | restart | version}
    • --debug <port> Start the server in remote debugging mode port: The remote debugging port
    • --start Start Carbon as a background process
    • --run Run the server
    • --stop Stop the Carbon background process
    • --restart Restart the Carbon background process
    • --version What version of the Carbon server are you running
  5. Check your WSO2 Governance Registry instance using the URL https://localhost:9443/carbon which will take you to the WSO2 Governance Registry Management Console.
  6. Login as "admin" using the default password "admin"

Building WSO2 Governance Registry Using the Source Distribution

Prerequisites

Java SE Development Kit 1.6.0_24 or later (For instructions on setting up the JDK in different operating systems, visit http://java.sun.com)
Apache Maven- To build Registry from Source To build the WSO2 Governance Registry from its source distribution, you will need Maven 2.1.0 or later
Operating System Linux, Solaris, MS Windows - XP/ Vista (Not fully tested on Windows Vista)

Setting up the Environment and Tools

Maven:

The WSO2 Governance Registry build is based on Apache Maven. Hence, it is a prerequisite to have Maven (version 2.1.0 or later) and JDK (version 1.6.0_24 or later) installed in order to build WSO2 Governance Registry from the source distribution. Extensive instructions on Maven builds are available on the Maven site.

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

  1. Download Apache Maven tar ball or the zip archive.
  2. Expand it to a directory of choice.
  3. Set the environment variable MAVEN_HOME and add MAVEN_HOME/bin to the path as well.
  4. Refer to more instructions on how to install Maven in Unix based operating systems.
  1. Download and run the Apache Maven Windows installer package.
  2. Set the 'Environment Variables' (create the system variable MAVEN_HOME and edit the path. e.g., "C:\Program Files\Apache Software Foundation\maven-2.1.0"; path %MAVEN_HOME%\bin)
  3. Make sure that the system variable JAVA_HOME is set to the location of your JDK, e.g., C:\Program Files\Java\jdk1.6
  4. Run mvn --version to verify that it is correctly installed.

Once Maven is properly installed, you can start building the WSO2 Registry.

Building 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 need a connection to the Internet for the Maven build to download dependencies required for the build. 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.

Running Samples

WSO2 Governance Registry samples are available at GREG_HOME/samples directory. The instructions to run sample are given in README file of the respective samples.

Please refer the Sample Guide