This guide tells you how to set up a JSPWiki Development Environment.

It assumes you are using a Windows based environment

See also HowToWriteAPlugin

Prerequisites#

Install Java#

Install Eclipse#

Install Tomcat (optional)#

Install Maven#

Source Code#

The source code is at: http://svn.apache.org/repos/asf/jspwiki/trunkContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png
See http://jspwiki.apache.org/development/source_and_guide.htmlContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png

Process#

Go to the source directory e.g. C:/code/jspwiki and run: 
mvn eclipse:eclipse

To compile the code run: 

mvn package

To start jspwiki run: 

cd jspwiki-war
mvn tomcat7:run

Once this completes go to http://localhost:8080/JSPWikiContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png and you should see an empty wiki.

JSPWiki_Default.png

Configuration#

The default configuration file is found at <jspwiki.dir>/jspwiki-war/src/main/resources/ini/jspwiki.properties For more information see Configuration
It is recommended not to change the above file, but rather create a custom file here:
<jspwiki.dir>/jspwiki-war/src/main/resources/jspwiki-custom.properties

One of the important properties in the jspwiki.properties file is the below:

  • # jspwiki.fileSystemProvider.pageDir = C:/Data/jspwiki

By default this line ia commented out so it will go to the Java *<user.home>/jspwiki-files* directory. For Example:

  • C:/Users/<username>/jspwiki-files
  • C:/Documents and Settings/<username>/jspwiki-files
  • /home/<username>/jspwiki-files

In there will be all the content files for the wiki pages.

Category.Documentation
This particular version was published on 17-Jan-2015 14:02 by David Vittor.  Top