DevelopmentEnvironment


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 in git: See http://jspwiki.apache.org/development/source_and_guide.html

Process#

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%

Screenshots#

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 Documentation and 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:

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

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


Category.Documentation