JSPWiki portable binaries#

As for 2.10.1, JSPWiki is also available on portable binaries

User notes#

• Based on Siegfried Goeschl's JSPWiki On A Stick

• Launches a JSPWiki instance at http://localhost:9627/JSPWiki, to avoid conflicts with existing servers running on port 80 and/or 8080

The Pre-configured Wikis#

Personal Wiki#

This configuration makes the following assumptions

• You are the one and only user of JSPWiki
• You don't need to authenticate for working with JSPWiki
• Using BasicSearchProvider reg-exp grepping
• No page versioning
• Registered users with admin rights
  • [ user , user ]

Department Public Wiki#

This configuration makes the following assumptions

• A group of mostly trust-worthy people are using the wiki
• Anonymous users have with read-only access
• Using VersioningFileProvider
• LuceneSearchProvider only picks up changes through JSPWiki
• Registered users with read/write access
  • [ admin , lEtMeIn ]
  • [ user , user ]

Dev notes#

Creating The Native Launchers#

The native launchers are under version control and can be re-created manually. In other words there are not automatically built and checked in because

• Downloading all the stuff is time-consuming and would slow the build for everyone
• There should be some manual testing before promoting the native launchers

As of 2.11.0-M8 recreating them is really easy, just run the following command

jspwiki-portable> mvn clean package -Dgenerate-native-launchers=true

and that's it.

Recreating manually the binary launchers#

Under Windows, the above command translates to

# generates the structure needed by the ant commands to build the launchers
jspwiki-portable> mvn clean package 

# downloads launch4j and builds the native launcher for windows
jspwiki-portable> ant woas:download-launch4j-for-win woas:create-windows-app -Djspwiki.tomcat.version=$TOMCAT_VERSION

# downloads appbundler and builds the native launcher for mac
jspwiki-portable> ant woas:download-appbundler-for-mac-on-windows woas:create-mac-app -Djspwiki.tomcat.version=$TOMCAT_VERSION

# updates the module with the just created native launchers
jspwiki-portable> ant woas:update-tomcat-launchers

# builds the portable binaries with the updated native launchers, so manual testing can be performed right away
jspwiki-portable> mvn clean package 

whereas under Unix platforms, it translates to

# generates the structure needed by the ant commands to build the launchers
jspwiki-portable> mvn clean package

# downloads launch4j and builds the native launcher for windows
jspwiki-portable> ant woas:download-launch4j-for-mac woas:create-windows-app -Djspwiki.tomcat.version=$TOMCAT_VERSION

# downloads appbundler and builds the native launcher for mac
jspwiki-portable> ant woas:download-appbundler-for-mac woas:mac-app-oracle-jdk -Djspwiki.tomcat.version=$TOMCAT_VERSION

# updates the module with the just created native launchers
jspwiki-portable> ant woas:update-tomcat-launchers

# builds the portable binaries with the updated native launchers, so manual testing can be performed right away
jspwiki-portable> mvn clean package

As noted above, the generated woas.exe file and woas.app folder are copied to ./jspwiki-portable/src/overlay/launchers/tomcat; after manual testing of these binaries is performed, they can be committed and pushed.