Installation Guide

Information

Installation instructions for the BlogWow tool for system administrators. See the User Guide for steps to add the tool to a site or setup the permissions for the tool.

• Stable release version:
  • BlogWow 0.9.9
• Required versions for 0.9.9:
  • Sakai 2.2.x or higher
  • EntityBroker 1.2.0

How to get the source code and build the tool

• BlogWow works on Sakai 2.2.x or higher, it will NOT work on earlier versions

1. Change to your sakai source directory (e.g. /opt/<sakai-src>/)
2. Checkout the most recent stable version (in this case 0.9.9)
   svn checkout https://source.sakaiproject.org/contrib/programmerscafe/blogwow/tags/0.9.9 blogwow
   1. subversion will create a blogwow directory for you, you can use any directory name you like, just change the last blogwow into the word you want.
3. Add entity broker project (required)
   • If you are running Sakai 2.5.0 then entitybroker 1.2.0 is already included
   1. Checkout entity broker 1.2.0 (or highest tag) into your sakai source directory (use subclipse or the command below)
      svn co https://source.sakaiproject.org/svn/entitybroker/tags/1.2/ entitybroker
   2. Build entity broker using maven sakai from within the entitybroker folder
      • If you are using maven 2 then run mvn clean install sakai:deploy
4. Change to blogwow source directory (e.g. /opt/<sakai-src>/blogwow)
5. Run maven sakai
   • This will download all needed jars and compile the source code
   • You may need to add the following repositories to your maven build.properties get all needed jars:
     1. http://source.sakaiproject.org/maven/
     2. http://www2.caret.cam.ac.uk/maven
     3. http://ponder.org.uk/maven
   • If you are using maven 2 then run mvn clean install sakai:deploy
6. Start tomcat and check the log for errors, there should be none if all jars were downloaded and installed correctly

Permissions defined

• blogwow.create - user can create/use a blog in the site
• blogwow.entry.write - user can write entries in their own blog
• blogwow.entry.write.any - user can write entries in any blog
• blogwow.entry.read - user can read group only entries in any blog in this site
• blogwow.entry.read.any - user can read all entries (including private) in any blog in this site
• blogwow.comments.add - user can add comments to any blog in this site
• blogwow.comments.remove.any - user can remove comments from any blog in this site

Getting started

• Note: you will need to set the permissions for all existing sites and it is a good idea to set these permissions for the site.template so they will be inherited in any newly created sites
  • You can use these directions to set the permissions for individual sites by selecting the correct site when on the step with site.template on it

1. Set the tool permissions for the maintain role (or instructor type role) - requires admin access
   1. Click Realm
   2. Click !site.template
   3. Click Role Id - maintain
   4. Check the following boxes
      • blogwow.create
      • blogwow.entry.write.any
      • blogwow.entry.read.any
      • blogwow.comments.add
      • blogwow.comments.remove.any
   5. Click the Done Button
2. Set the tool permissions for the access role (or student type role) - requires admin access
   1. Click Realm
   2. Click !site.template
   3. Click Role Id - access
   4. Check the following boxes
      • blogwow.create
      • blogwow.entry.write
      • blogwow.entry.read
      • blogwow.comments.add
   5. Click the Done Button
3. To grant users admin privileges (to make someone a super admin)
   1. Click Realm
   2. Click /site/!admin
   3. Click Grant Ability at top menu
   4. Enter user id
   5. Select role - admin
   6. Click the Save Button