JForum Install Guide

Up | Install Guide | Upgrade Guide | Jforum Properties

JForum 2.7.1 is available for use in Sakai 2.3 or 2.4 or Sakai 2.5 and higher. It supports Oracle and MySQL 4.1 and MySQL 5.0.xx. HSQLDB may not work with Jforum.

Follow the instructions below to download and build:

1. Get the Source
2. Database Information
3. Dependency on etudes-util
4. Sakai.properties Configurations
5. Build and Deploy Etudes JForum
6. Update Sakai Roles
7. Mask FCK Editor Image Icon
8. Add Jforum Icon to Sakai Left Menu

1) Get the Source

Get the JForum 2.7.1 source and place it at sakai source folder. To get JForum from Sakai Contrib SVN, issue the below SVN commands from your Sakai source folder:

svn co https://source.sakaiproject.org/contrib/etudes/sakai-jforum/tags/2.7.1 sakai-jforum

2) Database Information

Etudes Jforum 2.7.1 works with Mysql4.1+ and Oracle databases.

JForum makes use of Sakai's database connection pool. Etudes JForum tables are created in the sakai database.

3) Dependency on etudes-util

Build etudes-util before building Etudes Jforum.

Get etudes-util from https://source.sakaiproject.org/contrib/etudes/etudes-util/tags/1.0.2

Notes:

a) Default pom.xml files are for sakai 2.6.x. For sakai 2.5.x replace all pom.xml files with pom.xml.sakai.2.5.x under respective folders

b) If you are using sakai version other than 2.6.x before building change the version in pom.xml.

The default version in pom.xml is <version>2.6-SNAPSHOT</version>. Sakai version can be obtained from master/pom.xml from version element.

4) Sakai.properties Configurations

Add the jforum configurations to sakai.properties and customize.

Refer to readme/jforum_config_properties.txt for the properties or the Jforum properties web page.

5) Build and Deploy Etudes JForum

a. Install the below artifacts to the local maven repository from sakai_2-5-x_src/sakai-jforum

mvn install:install-file -DgroupId=jboss -DartifactId=jboss-cache -Dversion=1.3.0.SP2 -Dpackaging=jar -Dfile=lib/jboss-cache-1.3.0.SP2.jar

mvn install:install-file -DgroupId=htmlparser -DartifactId=htmlparser -Dversion=1.5 -Dpackaging=jar -Dfile=lib/htmlparser-1.5.jar

b. Run Maven Commands

Notes:

a) Undeploy any previous versions of Etudes Jforum from the previous version JFORUM source before deploying

b) If you are using sakai version other than 2.6.x before building change the version in pom.xml.

The default version in pom.xml is <version>2.6-SNAPSHOT</version>. Sakai version can be obtained

from master/pom.xml from version element.

c) For sakai 2.5.x replace all pom.xml files with pom.xml.sakai.2.5.x under respective folders

The sample maven goals are

- mvn clean - remove any prior build

- mvn install - compile and package Etudes jforum

- mvn sakai:deploy - install the needed files to the local Servlet container

6) Update Sakai Roles

Update Sakai Roles (under realms) to include JForum permissions

1. Check appropriate JForum permissions under the roles in !site.template.course.

• Check jforum.manage for teacher, instructor, faculty types of roles (maintain).
• Check jforum.member for student types of custom roles that you have (access).

2. 5.2. If you have project sites and related roles in !site.template.project), appropriate permissions (jforum.manage or jforum.member) need to be checked as defined above.

7) Mask FCK Editor Image Icon

This is a necessary step for masking the image icon in the toolbar of the

editor (JForum handles embedded images through the 'Attach files' process).

If you omit this step, you will get a toolbar error!!!

Under sakai source/reference/library/src/webapp/editor/FCKeditor/config.js

file, include this statement

FCKConfig.ToolbarSets["JforumDefault"] = [

['Source','-','Preview'],

['Cut','Copy','Paste','PasteText','PasteWord','-','SpellCheck'],

['Undo','Redo','-','Find','Replace','-','SelectAll','RemoveFormat'],

['Bold','Italic','Underline','StrikeThrough','-','Subscript','Superscript'],

['OrderedList','UnorderedList','-','Outdent','Indent'],

['JustifyLeft','JustifyCenter','JustifyRight','JustifyFull'],

['Link','Unlink','Anchor'],

['Smiley'],

['SpecialChar'], ['Style'],

'/',

['FontFormat','FontName','FontSize'],

['TextColor','BGColor'],

['About']

] ;

and compile and deploy sakai again.

NOTE: If you have already deployed sakai and don't want to redeploy then in tomcat/webapps/library/editor/FCKeditor/config.js you can add the above statement.

8) Add Jforum Icon to Sakai Left Menu

If you are using sakai's default cascading style sheet create the icons folder under tomcat/webapps/library/skin/default/

or download it from here:

and copy the image jforum-menu.png from jforum-tool/src/webapp/images/sakai-menu to

tomcat/webapps/library/skin/default/icons.

Add the below line to tomcat/webapps/library/skin/default/portal.css

.icon-sakai-jforum-tool{

background-image: url(icons/jforum-menu.png);

}