Version 2.12.1 (05.05.2024), see SystemInfo

05.05.2024

Installation#

Download > Apache Mirros > binaries > webapp > JSPWiki.war
Unpack war file with
Option 1
unzip JSPWiki.war -d JSPWiki

Option 2 (no extra folder is created)
apt install default-jdk    # jar is part of jdk
cd /usr/lib/jvm/        # see java versions
jar -xvf JSPWiki.war
Copy folder JSPWiki to <tomee_home>\webapps

Configuration#

Initial setup is done with ../JSPWiki/Install.jsp

The jspwiki.properties file is now embedded in the \WEB-INF\lib\jspwiki-war-2.10.1.jar file (\ini\jspwiki.properties).
If you want to change it, you need to create a custom (second) file called jspwiki-custom.properties, see Advanced Installation. You can place it under /tomee/lib/ (done) or under /JSPWiki/WEB-INF/
Here are all configuration options

Upgrade#

  • Replace webapps/JSPWiki with new version
  • ../JSPWiki/Install.jsp => note down the admin password !!!
  • keep default > Setup
  • our jspwiki-custom.properties is in /tomee/lib, so no need to adopt
  • stop tomee, clean temp folder, start tomee
  • JSPWiki is up and running, but change admin password
  • add TablePlugin again
cd ../webapps/JSPWiki
copy -r * ../backup/..
rm -r *
Download at https://archive.apache.org/dist/jspwiki/ > binaries > webapp > JSPWiki.war  
jar -xvf JSPWiki.war
rm JSPWiki.war
restart tomee
https://www.inetone.de/JSPWiki/Install.jsp
Edit:
Anwendungsname = ...
Seitenspeicherung = ...
Hit Next => Copy admin password !!
Restart tomee
Change admin password

TablePlugin
Download Table.jar see blow / Upload to server

mv /home/ftpuser/Table.jar /markus/tomee/webapps/JSPWiki/WEB-INF/lib
vi /markus/tomee/lib/jspwiki-custom.properties, add
jspwiki.plugin.searchPath = brushed.jspwiki.tableplugin

Additional settings#

> locale -a
echo LANG=de_DE.UTF-8 > /etc/locale.conf
echo KEYMAP=de-latin1-nodeadkeys > /etc/vconsole.conf
ln -s /usr/share/zoneinfo/Europe/Berlin /etc/localtime
LANG=de_DE.UTF-8;export LANG
KEYMAP=de-latin1-nodeadkeys;export KEYMAP

Edit catalina.sh:

JAVA_OPTS="-Dfile.encoding=UTF-8"

Plugins#

Therea are core plugins and contributed plugins.

Download: open the contributed plugin page > Info > More Information ... > Links > Download jar file
and install

1. jar into $WIKI_HOME/WEB-INF/lib/
2. in the Plugin search paths section of the jspwiki-custom.properties file,
edit the comma-delimited jspwiki.plugin.searchPath property to include the package designation of the plugin, example com.acme.plugin
(make use comma only, not comma+space!)

Example TablePlugin
1. Copy Table.jar to the folder $WIKI_HOME/WEB-INF/lib/ (or server classpath)
2. Edit jspwiki-custom.properties

jspwiki.plugin.searchPath = brushed.jspwiki.tableplugin

Markup#

Collapsible#

%%collapsebox-closed
! Heading
... box ...
/%

Escape character for JSPWiki is a tilde (~)#

~
Example: double underscore (instead of bold style) Preface~_~_Ending
Example: link with brackets (instead of indicating another link) http://www.testserver.de?show=data~[32~]&language=de
                       Alternative for links is using hex-codes: http://www.testserver.de?show=data%5B32%5D&language=de

Table auto fit#

Afais not possible with standard JSPWiki table, but only with TablePlugin:
[{Table style='width:auto'

||Component||Speed
|USB 3.0 (5Gbps)|625 MB/s
|PCIe 2.0 x1|250 MB/s

}]	

This answers lots of questions:
Ldap Integration | JSPWiki@WikiMatrix

Home

AdministeringJSPWiki + Page Security


Security #

Policies#

edit WEB-INF/jspwiki.policy
1. disable free registration
//    permission org.apache.wiki.auth.permissions.WikiPermission "*", "editPreferences";
//    permission org.apache.wiki.auth.permissions.WikiPermission "*", "editProfile";
2. disable all Anonymous and Asserted permissions !

via ACL#

Roles
  • Anonymous
  • Asserted
  • Authenticated
  • All
Note: Roles are case sensitive, use "All", not "all"! Grants
  • view
  • edit
  • comment
  • rename
  • delete
[{ALLOW view Janne,Mike Morris,Authenticated}]
[{ALLOW edit Janne,Managers}]
[{ALLOW view All}]
[{ALLOW edit Authenticated}]

UnusedPages / UndefinedPages / Page Index#

If you delete pages via browser or file system (or database) those pages do not get updated unless you clean the web server cache.
  1. stop werb server
  2. rm work, rm temp
  3. start web server

General#

Quick start#

  • For testing things, try the SandBox.
  • For a quick look on what Wiki is, check out OneMinuteWiki.
  • For a guideline on good working habits with wiki, see WikiEtiquette.

Installation issues#

  • If you run Microsoft Windows, or you are having trouble with UTF-8 then you probably want to take a look at InstallationTips for further information.

Documentation#

Miscellaneous#

  • There are several ways you can get in touch with JSPWiki Community. Check them out!
  • To see what this particular wiki is about, click on the Wiki name on the top left corner of the browser window, or click here.