OGCE Gadget Container

From Ogce

Contents 1 Overview 2 Features 3 Prerequisites 4 Get the Code 4.1 SVN Check Out 4.2 Just Want the Tar? 5 Build It 5.1 Set Up Your Database 5.2 Install the Container 5.3 Build a war 6 Detailed MySQL Installation Instructions

Overview

Our goal in this project is to build a gadget layout container and gadget host server that are compatible with the Open Social API. We are inspired by the Apache Shindig project, although we are not currently using or extending this code base (hence our names).

The gadget container is currently available as a demonstration preview. This is a new project, and we will be making many updates and improvements.

Additional technical details are described at http://docs.google.com/View?docid=dmxthpg_107f5gmnpgr

Features

• Incorporate externally created websites as IFrames. Add the content that you want.
• User profile management
• Support for OpenID login and profiles
• Control skins
• Use tab layouts
• Drag and drop gadgets between columns

Prerequisites

You need

• Java 1.5 or newer
• MySQL 5.0 or newer
• Maven 2.0.7 or newer

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

Set Up Your Database

1. Install a copy of MySQL if you don't have one.
2. Run our SQL script, UserDB.sql

The MySQL script does following things:

1. tries to create a database called "hibernate"
2. creates a user with user name being "portal_admin" and password being "admin_pass"
3. creates necessary tables used by gadget container

Install the Container

1. cd ishindig-trunk
2. Edit ishindig-trunk/pom.xml to specify your local properties.
   1. Update the <site.base> to use your IP address or hostname including port number.
   2. Update <hibernate.username> and <hibernate.password> to match the values you used when you created the database.
3. Run the command mvn clean install
4. Start your tomcat server: ./startup.sh
5. Point your browser to http://localhost:7070/ishindig-webapp

Note on Port Numbers: The build procedure above will override Tomcat's default server.xml with our own copy. We use port 7070 so this server will not interfere with others using port 8080.

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

Detailed MySQL Installation Instructions

The following instructions don't attempt to cover all possibilities. In particular, we set the installation up to run as the root user, which you may not want to do. See the MYSQL manual for the terrible details, particularly on setting the root password.

1. Download MySQL 5.x
2. As root, unpack the release in /usr/local/
3. Link your mysql distribution to /usr/local/mysql: ln -sn mysql-xxx-yyyy mysql
4. Install the database: cd /usr/local/mysql; ./scripts/mysql_install_db --user=root
5. Start the database: ./bin/mysqld_safe --user=root&

Go back to your portal download directory, check UserDB.sql, and run the command

 mysql -u root < UserDB.sql