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

It assumes you are using a Windows based environment

See also HowToWriteAPlugin


Install Java#

Install Eclipse#

Install Tomcat (optional)#

Install Maven#

Source Code#

The source code is in git: See


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

To compile the code run:

mvn package

To compile the code without running all the tests:

mvn -Dmaven.test.skip=true package

To start jspwiki run:

cd jspwiki-war
mvn tomcat7:run-war

Once this completes go to http://localhost:8080/JSPWiki and you should see an empty wiki.

Remote Debugging#

To enable remote debugging if running using mvn tomcat7

Run the following before running maven.

# Windows
set MAVEN_OPTS=-agentlib:jdwp=transport=dt_socket,address=8000,server=y,suspend=n

# Linux
export MAVEN_OPTS=-agentlib:jdwp=transport=dt_socket,address=8000,server=y,suspend=n

If using an external tomcat, open the <tomcat>/bin/startup.bat (or .sh) and add jpda before start on the following line:

call "%EXECUTABLE%" jpda start %CMD_LINE_ARGS%




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

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

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

By default this line is 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.