Quick Summary#

• Please reinstall in a new directory. Then move your modified templates into the new templates/ -directory. You MUST have the default template in place, else things might not work. If you have modified the default template, please rename your old template to "mymodifications" or something. You must NOT modify the default template anymore.

• Replace jspwiki.properties with your old configuration file. See below for the things that you will need to do.

• Set "jspwiki.security=off" in your configuration file. This will make JSPWiki compatible with the old 2.2. Once you have JSPWiki running, you can set it to "jaas" and enjoy the new Wiki.Admin.Security system.

• You can copy your old filters.xml to WEB-INF/classes

• Empty Tomcat and JSPWiki caches (from jspwiki.workDir).

• Restart Tomcat

New, important options#

These are options that you need to deal with when upgrading in your jspwiki.properties file.

jspwiki.baseURL #

In the 2.2 era, the baseURL was optional, unless you were using RSS. The idea was that if you don't specify a baseURL, then all URLs will be relative. With 2.4 this functionality has been split to a new property, "jspwiki.referenceStyle", and baseURL has been made mandatory.

Therefore, you now must set the baseURL to point at the base installation of your JSPWiki. E.g. with Tomcat this would mean that if you extract JSPWiki.war under "webapps/mywiki", then the baseURL would be http://yourhost/mywiki/. Don't forget the trailing slash!

jspwiki.workDir#

This is the directory that JSPWiki uses to store all the Lucene indexes, local indexes, uploaded files until they are completed (at which point they're moved to the repository), etc.

You need to set this property to point at an empty directory, which should not be accessible through the web browser (i.e don't put it in your JSPWiki installation directory...)

jspwiki.security#

This is a new setting that will determine how the authentication system works. The possible choices are:

• off : This will turn off JSPWiki security so that it will work like 2.2.
• jaas: Uses the new, spanking Wiki.Admin.Security system. This is the default.

jspwiki.xmlUserDatabaseFile#

This points to a file in the file system which is used to store the XML user database.

jspwiki.xmlGroupDatabaseFile#

This points to a file in the file system which is used to store the XML group database.

jspwiki.specialPage#

Are you seeing the following note when accessing a page?

In 2.2, it was possible to determine absolute paths for pages, like this:

jspwiki.specialPage.UserPreferences = /UserPreferences.jsp

However, thanks to the new URLProviders, this practice may lead to some problems. Therefore, you should make all these paths relative by removing the slash:

jspwiki.specialPage.UserPreferences = UserPreferences.jsp

jspwiki.policy#

The default jspwiki.policy file should be fine for you, but there's a small catch: If you rename your wiki to something else than "JSPWiki", you may need to change the permissions in here accordingly.

Plugin compatibility#

Many of the plugins for 2.2 still work, however, because JSPWiki 2.4 is now a signed jar file, any plugin which is put in the "com.ecyrd.jspwiki" hierarchy needs to be also signed with the same key as JSPWiki.jar, or else it will fail.

StubArticle!