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 Tomcat (optional)#
Source Code#The source code is in git: http://jspwiki.apache.org/development/source_and_guide.html
JSPWiki source is organized as a standard maven project so it can be easily imported out of the box by your favourite IDE.
To compile the code run:
To compile the code without running all the tests:
mvn -Dmaven.test.skip=true package
To start jspwiki run:
cd jspwiki-war mvn org.codehaus.cargo:cargo-maven2-plugin:run
Once this completes go to http://localhost:8080/JSPWiki and you should see an empty wiki.
The cargo plugin is configured to attach a remote debugger on port 5005.
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%
Configuration#The default configuration file is found at <jspwiki.dir>/jspwiki-war/src/main/resources/ini/jspwiki.properties
For more information see Documentation.
One of the important properties in the jspwiki.properties 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:/Documents and Settings/<username>/jspwiki-files
In there will be all the content files for the wiki pages.