This is version 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 . It is not the current version, and thus it cannot be edited.

Back to current versionRestore this version

Getting Started with JSPWiki#

Installation#

What is JSPWiki?

JSPWiki is a WikiWiki clone, as simple as you need it to be, written in Java and JSP. A WikiWiki is a web site which allows anyone to participate in its development. JSPWiki supports all the traditional wiki features, as well as very detailed access control and security integration using JAAS.

Requirements

• A JSP engine that supports Servlet API 2.5. We recommend TomcatContent unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png for a really easy installation. Tomcat 6.x or later is supported.

• JDK 1.6 or higher

Quick and simple install

1. Install Tomcat from http://tomcat.apache.org/Content unavailable! (broken link)https://jspwiki-vm1.apache.org/images/out.png (or any other servlet container)
2. Download JSPWiki, or build it from source
3. Optionally, only if you wish your JSPWiki URL different from /JSPWiki: rename the JSPWiki.war file from the download to something based on your desired URL
   • For example, if you want your URL to be http://.../wiki, rename it to wiki.war
   • This name will be referred to as appname below
4. Deploy this war on Tomcat, by f.ex., placing this WAR in your $TOMCAT_HOME/webapps folder and then (re)starting Tomcat
   • Note that JSPWiki can also be run on a Docker container or through portable binaries
5. Point your browser at http://<myhost>/<appname>/Install.jsp
6. Follow the installation dialog by answering a couple of simple questions
7. Restart Tomcat
8. Point your browser to http://<myhost>/<appname>/

That's it, you can start creating pages now, here is the Wiki Syntax!

Customizing your Installation

As noted above, it is assumed that you have read/write access to some directories. Most of the time this is fine. Sometimes however, you may wish to change these locations, or change how JSPWiki is configured (i.e.: your base URL, RSS feeds, Java Mail configuration, and a large etcetera).

In the $TOMCAT_HOME/lib folder (or equivalent based on your servlet container), place a jspwiki-custom.properties file, which can contain any overrides to the defaults. See Configuration for these default values.

Review these defaults to look for values you may wish to override. Some common values to override include:

• jspwiki.baseURL
• jspwiki.xmlUserDatabaseFile
• jspwiki.xmlGroupDatabaseFile
• jspwiki.fileSystemProvider.pageDir
• jspwiki.basicAttachmentProvider.storageDir,
• log4j.appender.FileLog.File.

The custom file can also be placed in the WEB-INF folder of the WAR, but storing this file in $TOMCAT_HOME/lib allows you to upgrade the JSPWiki WAR without needing to re-insert your customizations (no war surgery required).

Installing core pages

There is a set of core pages (in different languages) in the download that you can load into your wiki. Unzip the contents of jspwiki-corepages.zip into your newly created directory. You can find the rest of the documentation in the JSPWiki-doc.zip file.

(Re)start tomcat.

Point your browser at http://<where your Tomcat is installed>/MyWiki/. You should see the Main Wiki page.

The WEB-INF/jspwiki.policy file is used to change access permissions for the Wiki.

Configuration#

Have a look at the default jspwiki.properties file in the installation. There is quite some extensive documentation about all the configurations you can make for your wiki. We dumped it's contents here too.

There are several options to configure JSPWiki (in order of precedence) :

• JVM arguments (Java System properties)
• environment variables
• jspwiki-custom.properties property file (somewhere on the classpath)
• jspwiki.properties (packaged inside jspwiki.jar packaged inside JSPWiki.war)

A few examples to start JSPWiki in Tomcat with a custom baseURL (a very obvious property you may want to change) :

Using JVM args :

export CATALINA_OPTS="-Djspwiki.baseURL=http://www.example.com/mywiki"
/usr/local/tomcat/bin/startup.sh

Using envvars :

export jspwiki.baseURL=http://www.example.com/mywiki
/usr/local/tomcat/bin/startup.sh

See also CustomUserPreferences

Advanced usage#

To set up a development environment for JSPWiki see DevelopmentEnvironment

JSPWiki is easily extendable. You can write your own (Java) programs to customize or extend the behavior of JSPWiki. These "plugpoints" come in three flavors:

• Plugins
• Filters
• Providers

For UI Customisation see:

• WikiSkin
• WikiTemplate

Plugins#

A plugin is called when a page is rendered and a specific code is found in the page text, more details

Filters#

Wiki filters allow you to pre- and postprocess the information that flies back and forth between the Wiki engine and the browser, more details

Providers#

Providers are the storage engines you use when saving pages. By default we use the FileSystemProvider, but there are more, more details.

Reserved Pages#

These are pages with a fixed name that are special, more details

---

Category.Documentation