OGCE Gadget Container
From Ogce
Contents |
Overview
This project component provides an Open Social-compatible gadget layout container and gadget host server.
Download
The Gadget Container is included as part of the OGCE "All" release. Please see the Portal Download page for instructions for getting the code.
Older Releases
The SC09 release of the Gadget Container is now available. To download, click the link below.
| Date | Download Link | Alt. Link |
|---|---|---|
| June 22, 2009 | ogce-gadget-container-SC09.tar.gz | ogce-gadget-container-SC09.tar.gz |
You can also check out the SC09 tagged release from our SourceForge SVN:
svn co https://ogce.svn.sourceforge.net/svnroot/ogce/tags/ogce-gadget-container-SC09
This will allow you to get bug fixes and minor updates by using svn update.
Features
The OGCE Gadget Container portal includes a bug-fixed and patched Apache Shindig gadget container (version 1.1). This includes support for SSL, so you can securely serve Grid gadgets such as developed in the OGCE's Cyberaide JavaScript project.
- Secure HTTPS access for all pieces: the layout manager, locally served gadgets, and the gadget container.
- Incorporate both locally served and externally created gadgets: GMail, Facebook, Twitter, News Feeds, etc.
- User profile management
- Support for OpenID login and profiles
- Provide skins for different layout colors
- Provide tabbed and tree-based layouts.
- Drag and drop gadgets between columns
Prerequisites
You need
- Java 1.5 or newer
- Apache Maven 2.2.1 or newer. This is provided in the portal download.
The portal uses H2 as its database management system, but you can optionally replace this with MySQL. You can reuse the MySQL installation from other OGCE projects such as the Resource Prediction Service.
As with other OGCE projects, the download includes an Apache Tomcat server and builds with Maven 2 in one step.
Get the Code
Code is currently made available through either SVN checkouts or a gzipped TAR file. We recommend using an SVN client if you want to check for updates. Download the TAR if you just want to try it out.
SVN Check Out
Checkout the gadget container code from our SVN:
svn co https://ogce.svn.sourceforge.net/svnroot/ogce/ShindigOGCE/ishindig-trunk
Just Want the Tar?
You can download a gzipped TAR of everything through SourceForge's SVN viewer: http://ogce.svn.sourceforge.net/viewvc/ogce/ShindigOGCE/ Look for the link Download GNU tarball.
Build It
Quick Start
- cd ishindig-trunk
- Edit conf/ishindig.properties to specify your local properties.
- Update the <site.host> to use your IP address or hostname. Be deault, HTTPS is used and port number is 7443. Probably you also want to change <site.protocol> and <site.port>. See OGCE gadget portal configuration for details about how to change port number.
- Run the command mvn clean install
- Start your tomcat server: ./startup.sh
- Point your browser to https://your_ip_or_domain:7443/ishindig-webapp
Note on Port Numbers: The build procedure above will override Tomcat's default server.xml with our own copy. We use port 7443 so this server will not interfere with others using port 8443.
If you want to change other default configurations, read OGCE gadget portal configuration.
Build a war
If you don't want to use our built-in servlet/jsp container and just want to build a war and deploy it into your own server, run this command
mvn clean install -Dwar.only
This requires that you use a separately running Shindig gadget container.
Configuration Documentation
Please read OGCE gadget portal configuration for a fuller description of database and other configuration options.
Theme Customization
Please read OGCE gadget container theme customization for instructions about how to fully customize the theme.
Cleaning Up and Rebuilding
If you need to uninstall and clean up your distribution, do these steps from the gadget container's top level directory:
./shutdown-tomcat.sh mvn clean
Note this will not delete the H2 database files, so your user accounts and configuration customizations will be preserved. If you want to clean these out also and start from a blank slate, use the maven command
mvn clean -f db-cleaner/pom.xml
Publications
Zhenhua Guo, Raminderjeet Singh, Marlon Pierce Building the PolarGrid Portal Using Web 2.0 and OpenSocial GCE09 Grid Computing Environments 2009 workshop at SC09 Portland Oregon November 20 2009
