Child pages
  • Installation and Setup Guide
Skip to end of metadata
Go to start of metadata

Knowledge base tool installation and setup guide

About this document

Conventions

This document provides some examples with values than need to be adjusted with your specific values. Those valus are marked with greater than and smaller than signes with some text in the middle, usually the text says something about the expected value. An example would be:

sed -i s/2.5.3/<YOUR_SAKAI_VERSION>/g pom.xml

To fill in your own value, you need to replace the entire text <YOUR_SAKAI_VERSION> with your own value, for instance 2.5.5. In this specific case the string would look like this:

sed -i s/2.5.3/2.5.5/g pom.xml

Prerequisites

Sakai versions

The tool is developed and tested with sakai 2.5.3. This means that the tool should work with any 2.5 version with little adjustment. The tool should be able to run with sakai 2.6 and 2.7 without any real issues, except for the build scripts that need to be adjusted to K1 and K2.

Installation steps for 2.5

  • Install the Entitybroker
    The 2.5 version of the tool depends on the enitybroker that needs to be installed into sakai. The knowledge base is tested and deployed with the following version of the entitybroker:
    URL: https://source.sakaiproject.org/svn/entitybroker/trunk
    Repository Root: https://source.sakaiproject.org/svn
    Repository UUID: 66ffb92e-73f9-0310-93c1-f5514f145a0a
    Revision: 63913
    Node Kind: directory
    Schedule: normal
    Last Changed Author: aaronz@vt.edu
    Last Changed Rev: 62559
    Last Changed Date: 2009-05-18 17:52:24 +0200 (Mon, 18 May 2009)
    
  • Make sure to install and deploy the entitybroker as defined above.
  • Check out the source from the svn reposiory. This example checks out the trunk version. You should check if what version is available for your specific sakai version, if any.
    svn co https://source.sakaiproject.org/contrib/edia/knowledgebase/trunk/  edia-sakai-knowledgebase
    
  • OPTIONALLY if you sakai minor version does not match the sakai version of the main pom.xml file. Update the build files to you exact sakai version. A simple find and replace on the main pom file should work. This example uses sed (Stream EDitor) to find and replace the string "2.5.3" with your sakai version, but you are free to use any text editor that suites your needs.
    sed -i s/2.5.3/<YOUR_SAKAI_VERSION>/g pom.xml
    
    Note that the -i option is used to do a inline edit on the file, and this option is not available on the sed version distributed with Mac OS X.
  • Build and install the tool
    mvn clean install sakai:deploy -Dmaven.tomcat.home=<SAKAI_INSTALLATION_DIR> -Dmaven.test.skip
    

Installation steps for 2.6

  • Check out the source from the svn reposiory. This example checks out the 2.7 branch. You should check if what version is available for your specific sakai version, if any.
    svn co https://source.sakaiproject.org/contrib/edia/knowledgebase/branches/sakai-2.6.x/  edia-sakai-knowledgebase
    
  • OPTIONALLY if you sakai minor version does not match the sakai version of the main pom.xml file. Update the build files to you exact sakai version. A simple find and replace on the main pom file should work. This example uses sed (Stream EDitor) to find and replace the string "2.6.3" with your sakai version, but you are free to use any text editor that suites your needs.
    sed -i s/2.6.3/<YOUR_SAKAI_VERSION>/g pom.xml
    
    Note that the -i option is used to do a inline edit on the file, and this option is not available on the sed version distributed with Mac OS X.
  • Build and install the tool
    mvn clean install sakai:deploy -Dmaven.tomcat.home=<SAKAI_INSTALLATION_DIR> -Dmaven.test.skip
    

Installation steps for 2.7

  • Check out the source from the svn reposiory. This example checks out the 2.7 branch. You should check if what version is available for your specific sakai version, if any.
    svn co https://source.sakaiproject.org/contrib/edia/knowledgebase/branches/sakai-2.7.x/  edia-sakai-knowledgebase
    
  • OPTIONALLY if you sakai minor version does not match the sakai version of the main pom.xml file. Update the build files to you exact sakai version. A simple find and replace on the main pom file should work. This example uses sed (Stream EDitor) to find and replace the string "2.7.1" with your sakai version, but you are free to use any text editor that suites your needs.
    sed -i s/2.7.1/<YOUR_SAKAI_VERSION>/g pom.xml
    
    Note that the -i option is used to do a inline edit on the file, and this option is not available on the sed version distributed with Mac OS X.
  • Build and install the tool
    mvn clean install sakai:deploy -Dmaven.tomcat.home=<SAKAI_INSTALLATION_DIR> -Dmaven.test.skip
    

Installation steps for 2.8

  • Check out the source from the svn reposiory. This example checks out the 2.8 branch. You should check if what version is available for your specific sakai version, if any.
    svn co https://source.sakaiproject.org/contrib/edia/knowledgebase/branches/sakai-2.8.x/  edia-sakai-knowledgebase
    
  • OPTIONALLY if you sakai minor version does not match the sakai version of the main pom.xml file. Update the build files to you exact sakai version. A simple find and replace on the main pom file should work. This example uses sed (Stream EDitor) to find and replace the string "2.8.0" with your sakai version, but you are free to use any text editor that suites your needs.
    sed -i s/2.8.0/<YOUR_SAKAI_VERSION>/g pom.xml
    
    Note that the -i option is used to do a inline edit on the file, and this option is not available on the sed version distributed with Mac OS X.
  • Build and install the tool
    mvn clean install sakai:deploy -Dmaven.tomcat.home=<SAKAI_INSTALLATION_DIR> -Dmaven.test.skip
    

Set up the permissions in Sakai

  1. Log in with administrator permissions
  2. Navigate to the realms tool
  3. Select the !user.template realm
  4. Edit the .anon realm
  5. Select the permissions:
    1. knowledgebase.read
  6. Press done
  7. Select the .auth permission
  8. Select the permissions:
    1. knowledgebase.comment
    2. knowledgebase.read
    3. knowledgebase.vote
  9. Press done
  10. Press save

Cluster deployment

The knowledge base currently uses an internally hosted Solr instance. Of course, this could be done by an externally hosted Solr instance, and the programatic adjustments would be minimal, but for now an internal hosted Solr serves our needs. This instance has a index persisted on the file system. In order to make the tool work in a clustered deployment, the data directory of Solr needs to be available to all the cluster instances. This directory can be configured by setting the following value in sakai.properties:

knowledgebase.solr.data.dir=<PATH_TO_THE_SHARED_DIRECTORY>

  • No labels

2 Comments

  1. Sakai 2.7.0 is packed with entitybroker 1.3.8 which includes 62559 you get when you request 63913 from entitybroker's trunk

    1. Thanks Jean-François for pointing this out to me. The entitybroker packed with 2.7 is fine, the statement about the entitybroker only relates to 2.5 builds. I've updated the instructions.