Curriki Installations Instructions

Curriki Installations Instructions

Download

Get the code from SVN

svn co http://svn.xwiki.org/svnroot/xwiki/curriki/trunk/

Configuration to do

There will be three files hand-manipulated: the web/pom.xml and web/src/main/webapp/WEB-INF/hibernate.cfg.xml and web/src/main/webapp/skins/curriki8/javascripts.vm

• in web/src/main/webapp/skins/curriki8/javascripts.vm uncomment the line with JSTrans (there is a comment explaining this) otherwise Javascript translations won't work in the add path
• in hibernate.cfg.xml, modify as needed the database connection. The default hibernate.cfg.xml is mysql with the database named xwiki. If you are doing a new install make sure the database is empty.
• in the web/pom.xml, add sibblings of the element xwikiCfgEditCommentMandatory (for example, add the following,noting that the element names correspond to the element property names used in the script that generates xwiki.cfg) :

<xwikiCfgDefaultSkin>albatross</xwikiCfgDefaultSkin>
<xwikiCfgDefaultBaseSkin>albatross</xwikiCfgDefaultBaseSkin>
<xwikiCfgEncoding>utf-8</xwikiCfgEncoding>

Building

• before you build delete the file wiki/src/main/resources/package.xml which otherwise makes the build create a wrong curriki-wiki.xar

rm wiki/src/main/resources/package.xml

• build using maven by running "mvn install -Pmysql" in your directory (using -Phsqldb or -Ppostgres if you have a different database type)
• in wiki/ build by running "mvn install" (don't forget to delete the wiki/src/main/resources/package.xml file before your build - this file is needed to deploy curriki but get's in the way of the build since the xar packager does not recreate it)

Verify your build

The build is in web/target/curriki-web-1.0-SNAPSHOT (is referenced as xwiki below)

• check xwiki/WEB-INF/xwiki.cfg to make sure the property curriki.system.hostname to the name (and port-number) of your server.
• check the hibernate configs aside (both should be correct based on the changes above)
• rename web/target/curriki-web-1.0-SNAPSHOT/org.curriki.gwt.Main -> web/target/curriki-web-1.0-SNAPSHOT/gwt
• move gwt2.js in web/target/curriki-web-1.0-SNAPSHOT/gwt/ (both of these things can be done over a symbolic link on Unix platforms)

MySQL specific

If you have installed with a mysql database:

• create an empty database with proper rights for access from localhost
• change max_allowed_packet as stated on the MySQL install instructions

Start your container

• tune the memory of the container (I put CATALINA_OPTS="-Xms128m -Xmx512m -server" in catalina.sh)
• install web app in the container (the default webapp name is xwiki, in tomcat, this means that the content of web/target/curriki-web-1.0-SNAPSHOT is copied to /webapps/xwiki.
• start the container

Import your default Wiki

• get the xar file from wiki/target/ or use the xar file attached in the page (warning: it could be outdated)
• import the xar files from the preferences (xar is build in the wiki module)

Log-in an run post-processing

• After importing you will get a message saying that "you are not allowed to view this page". This is normal, because new rights have been importer. Use Admin/admin to log-in as Admin (note uppercase username, lowercase password)
• visit Admin/GiveProgRights and confirm (e.g. http://localhost:8080/curriki/bin/view/Admin/GiveProgRights). Without this some pages won't have proper rights and will show errors (like the Featured Member panel)
• The page Util.JSTrans needs to be resaved for translations to work in javascript dialog boxes
• Change smtp server in the Administration/Global Settings. Without this you cannot send notifications and invitations by email and you will get errors.

Get involved

To communicate with the Curriki developer community, please join the Curriki-devs mailing list at http://lists.xwiki.org/mailman/listinfo/curriki-devs