Portlet Installation

In order to install an individual portlet into your GridSphere portal, please execute the following steps:

  1. Deploy the portlet WAR to Tomcat.
  2. Register the portlet with GridSphere.
  3. Add the portlet to a tab in your portal.
These steps are detailed below.

Deploy the portlet WAR to Tomcat

You must first deploy the portlet WAR file to tomcat. If you have downloaded the binary distribution (the WAR file itself) of the portlet, simply copy the file into Tomcat's webapps directory: 


    > cp my-portlet.war $CATALINA_HOME/webapps/.
If you have downloaded the source distribution of the portlet, utilize Maven's war plugin to build the war and deploy it to tomcat: 

    > cd my-portlet-src-1.0
    > maven war:webapp -Dmaven.war.build.dir=$CATALINA_HOME/webapps
After deploying the portlet war, you must restart Tomcat.

Register the portlet with GridSphere

You must now inform gridsphere that the webapp you have deployed is a portlet application. To do this, log into your GridSphere portal as root and click on the "Administration" tab (if the "Portlets" submenu is not selected, please do so). Next, use the "Portlet Application Manager" to register the portlet webapp with GridSphere. To do this, enter the name of the portlet webapp (this will be the name of the portlet directory without the "src" or the version) in the form in the "Deploy new portlet webapp" fieldset and click the "Deploy" button.

Add the portlet to a tab in your portal

Your portlet application is now deployed to tomcat and registered with GridSphere. The final step in the installation process is adding the portlet to the display of the portal. To do this, please refer to the OGCE2 documentation, which explains how to create portlet groups and display them on tabs in the portal.