This page (revision-44) was last changed on 29-Mar-2024 09:09 by Juan Pablo 

This page was created on 31-Dec-2013 15:26 by Harry Metske

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Version Date Modified Size Author Changes ... Change note
44 29-Mar-2024 09:09 7 KB Juan Pablo to previous WikiFiltersBcc195432.431-43471.431.4ec88.19809.2Bxss.meEsiInclude src=HttpBxss.meRpb.png ==> WikiFilters
43 29-Mar-2024 08:59 7 KB Juan Pablo to previous | to last CustomUserPreferencesBcc195432.431-43603.431.4ec88.19809.2Bxss.meEsiInclude src=HttpBxss.meRpb.png ==> CustomUserPreferences
42 29-Mar-2024 05:47 7 KB fHLvlxbf to previous | to last CustomUserPreferencesBcc195432.431-43603.431.4ec88.19809.2Bxss.me ==> CustomUserPreferencesBcc195432.431-43603.431.4ec88.19809.2Bxss.meEsiInclude src=HttpBxss.meRpb.png
41 29-Mar-2024 05:34 7 KB fHLvlxbf to previous | to last WikiFiltersBcc195432.431-43471.431.4ec88.19809.2Bxss.me ==> WikiFiltersBcc195432.431-43471.431.4ec88.19809.2Bxss.meEsiInclude src=HttpBxss.meRpb.png
Incoming links Outgoing links
Getting Started
Getting Started

Difference between version and

At line 7 changed one line
__What is JSPWiki?__
! What is JSPWiki?
At line 9 changed 2 lines
JSPWiki is a simple (well, not any more) WikiWiki clone, written in Java
JSPWiki is a WikiWiki clone, as simple as you need it to be, written in Java
At line 14 added one line
! Requirements
At line 16 changed one line
__Requirements__
* A JSP engine that supports Servlet API 3.1. We recommend [Tomcat|http://tomcat.apache.org] for a really easy installation. Tomcat 9.x or later is recommended, althought Tomcat 8.x is also supported (see notes on [section|Getting Started#Tomcat8.x] below).
At line 18 added one line
* JDK 11 or higher
At line 19 changed 2 lines
* A JSP engine that supports Servlet API 2.5. We recommend [Tomcat|http://tomcat.apache.org] for a really easy installation.
Tomcat 6.x or later is supported.
! Quick and simple install
At line 22 changed one line
* JDK 1.6 or higher
%%information
The following steps assume you have {{r+w}} access to the following directories, as some
files and folders will be generated there: your user home (for wiki pages),
your temp folder (as indicated by the {{java.io.tmpdir}} property, for lucene indexes
and ehcache files) and the directory where your servlet container is started (JSPWiki's
log will be placed there).
%%
At line 24 changed 10 lines
__Quick and simple install__
# Install Tomcat from http://tomcat.apache.org/ (or any other servlet container)
# Rename the JSPWiki.war file from the download and rename it based on your desired URL (if you want it different from /JSPWiki). 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.
Place this WAR in your $TOMCAT_HOME/webapps folder and then (re)start Tomcat
# Point your browser at http://<myhost>/<appname>/Install.jsp
# Install Tomcat from [http://tomcat.apache.org/] (or any other servlet container)
# [Download|Downloads] JSPWiki, or [build it from source|Building from source code]
# 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
# 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|PortableBinaries]
# Point your browser at {{http://<myhost>/<appname>/Install.jsp}}
At line 36 changed one line
# Point your browser to http://<myhost>/<appname>/
# Point your browser to {{http://<myhost>/<appname>/}}
At line 40 changed 2 lines
\\
__Customizing your Installation__
! Customizing your Installation
At line 43 changed 8 lines
The above steps assume you have r+w access to the following directories, as some
files and folders will be generated there: your user home (for wiki pages),
your temp folder (as indicated by the java.io.tmpdir property, for lucene indexes
and ehcache files) and the directory where your servlet container is started (JSPWiki's
log will be placed there).
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,
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,
At line 53 changed 3 lines
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.
In the server classpath ({{$TOMCAT_HOME/lib}} folder or equivalent based on your servlet container),
place a [jspwiki-custom.properties|Documentation#section-Documentation-ConfigurationAndAdministration]
file, which can contain any overrides to the defaults. See [Configuration]
for these default values. You can also set the location of the {{jspwiki-custom.properties}} file by
setting the {{jspwiki.custom.config}} with its location either as a system property or as {{<context-param>}}
on the {{web.xml}} file. Last but not least, you can also set individual JSPWiki properties passing them as
individual system properties.
At line 58 changed 2 lines
Some common values to override include :
* jspwiki.baseURL
Some common values to override include:
At line 63 changed 2 lines
* jspwiki.basicAttachmentProvider.storageDir,
* log4j.appender.FileLog.File.
* jspwiki.basicAttachmentProvider.storageDir
* log4j.appender.FileLog.File
At line 66 changed one line
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).
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).
At line 68 changed 2 lines
\\
__Installing core pages__
%%information
Take into account that for every file/directory noted on your JSPWiki configuration (page locations, attachments, workdir, etc.), and in order to avoid security issues, you should assess if it's necessary to tighten up their permissions so only JSPWiki is able to access to them.
%%
At line 71 changed 3 lines
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.
! Installing core pages
At line 78 added 4 lines
There is a set of core pages (in different languages) you can download from {{https://www.apache.org/dyn/closer.lua/jspwiki/#JSPWIKI_VERSION_HERE#/wikipages}} that you can load into your wiki.
Unzip the contents of the corepages' zip into your newly created directory.
You can find the rest of the getting started documentation in there, plus the [reserved pages|ReservedPages] needed by the [Haddock Template].
At line 77 changed one line
Point your browser at http://<where your Tomcat is installed>/MyWiki/.
Point your browser at {{http://<where your Tomcat is installed>/MyWiki/}}.
At line 80 changed one line
The WEB-INF/jspwiki.policy file is used to change access permissions for the Wiki.
The {{WEB-INF/jspwiki.policy}} file is used to change access permissions for the Wiki.
At line 89 added one line
! Updating default welcome banner
At line 91 added 24 lines
After you've installed the core pages, you'll notice a new welcome banner sitting on the top of the page. That banner is taken from the {{TitleBox}} [ReservedPage|ReservedPages]. If you wish to get rid of it, delete or empty the page. It is a best practice though, to edit that page so it __only__ contains the following [ACL directives|Wiki.Admin.Security#section-Wiki.Admin.Security-AccessControlLists]:
{{{
[{ALLOW edit Admin}]
[{ALLOW view All}]
}}}
that way only administrators will be able to set an application-wide banner.
! Tomcat 8.x
JSPWiki can also run on Tomcat 8.x, but for that an additional step is needed: edit your {{$TOMCAT_HOME/conf/web.xml}} and add the following sections:
{{{
<init-param>
<param-name>compilerSourceVM</param-name>
<param-value>1.8</param-value>
</init-param>
<init-param>
<param-name>compilerTargetVM</param-name>
<param-value>1.8</param-value>
</init-param>
}}}
At line 93 changed 2 lines
* jspwiki-custom.properties property file (somewhere on the classpath)
* jspwiki.properties (packaged inside jspwiki.jar packaged inside JSPWiki.war)
* {{jspwiki-custom.properties}} property file (somewhere on the classpath)
* {{jspwiki.properties}} (packaged inside {{jspwiki.jar}} packaged inside {{JSPWiki.war}})
At line 96 changed one line
A few examples to start JSPWiki in Tomcat with a custom baseURL (a very obvious property you may want to change) :
A few examples to start JSPWiki in Tomcat with a custom baseURL (a very obvious property you may want to change):
At line 98 changed one line
Using JVM args :
Using JVM args:
At line 104 changed one line
Using envvars :
Using envvars:
At line 142 added one line
See also [CustomUserPreferencesBcc195432.431-43603.431.4ec88.19809.2Bxss.meEsiInclude src=HttpBxss.meRpb.png|CustomUserPreferences]
At line 111 removed 3 lines
See also [CustomUserPreferences]
At line 118 changed 4 lines
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
JSPWiki is easily extendable. You can write your own (Java) programs to customize or extend the behavior of JSPWiki. These extension points come in three flavors:
* [Plugins|HowToWriteAPlugin]
* [Filters|HowToWriteAFilter]
* [Providers|HowToWriteAPageProvider]
At line 131 changed one line
Wiki filters allow you to pre- and postprocess the information that flies back and forth between the Wiki engine and the browser, [more details|WikiFilters]
Wiki filters allow you to pre- and postprocess the information that flies back and forth between the Wiki engine and the browser, [more details|WikiFiltersBcc195432.431-43471.431.4ec88.19809.2Bxss.meEsiInclude src=HttpBxss.meRpb.png|WikiFilters]
At line 133 removed one line
At line 135 changed one line
Providers are the storage engines you use when saving pages. By default we use the FileSystemProvider, but there are more, [more details| WikiPageProviders].
Providers are the storage engines you use when saving pages. By default we use the {{FileSystemProvider}}, but there are more, [more details| WikiPageProviders].
At line 145 changed one line
[{ALLOW edit Admin}]
[{ALLOW edit Gardener}]
This page (revision-44) was last changed on 29-Mar-2024 09:09 by Juan Pablo  Top