Current development on JAMWiki is primarily focused on maintenance rather than new features due to a lack of developer availability. If you are interested in working on JAMWiki please join the jamwiki-devel mailing list.

JAMWiki 0.6.2

Release Notes

JAMWiki 0.6.2 (code name "Red Ragtop") is now available for download. The 0.6.2 release is a minor release that includes several enhancements and minor fixes. Notable changes made during this release include:

  • Upgraded the project dependencies to Servlet 2.4 and JSP 2.0. Bugs in previous JAMWiki configuration settings required these dependencies, so this change should be backwards-compatible.
  • Umlauts, ampersands and other special characters were being double-escaped in the TOC. Fix contributed by Louis Martin.
  • Spanish translations from User:AngelPinazo.

See the README.txt and CHANGELOG.txt files included in the JAMWiki distribution for additional details about this release. Users are also encouraged to visit http://jamwiki.org/ for more detailed documentation, to report any problems, or to contribute to the project.

Changelog

New Features

  • Upgrade project dependencies to Servlet 2.4 and JSP 2.0. Bugs in previous JAMWiki configuration settings required these dependencies, so this change should be backwards-compatible.
  • Upgrade to JSTL 1.1.2 (from 1.0.6).
  • Make the valid login, topic name, and role name patterns configurable.
  • Replace several custom methods with the org.apache.commons.lang equivalent.
  • During setup, create a default directory to use for image and other file uploads to hopefully eliminate some confusion.
  • When using multiple references to the same source, use the first non-empty reference definition instead of using the first reference definition.
  • Make the search engine instance a configurable parameter.
  • Remove the unnecessary "Are you sure" prompt when upgrading.
  • Use JFlex Maven plugin instead of Ant task (RegisDecamps).
  • Updated spam filter patterns.

Bugfixes

  • Resolve a CSS issue that caused the TOC to be invisible on IE6. Reported by bvold.
  • Umlauts, ampersands and other special characters were being double-escaped in the TOC. Fix contributed by Louis Martin.
  • Fix issue where search terms were double-escaped when no search results were found.
  • Reload data handler and other values after upgrade to (hopefully) avoid problems with incorrect data handler instances.

Translation Updates

  • Updated Chinese translations (hfl).
  • Updated Polish translations (dlpa).
  • Updated Spanish translations (AngelPinazo).

Installation Instructions

New Installs

See Installation for the complete installation instructions; see below or the UPGRADE.txt for upgrade instructions - DO NOT attempt to upgrade JAMWiki using the new installation process!

The basic steps for performing a new JAMWiki install are:

  1. Download the latest JAMWiki release from http://sourceforge.net/projects/jamwiki/.
  2. Deploy the JAMWiki WAR file. See your web application server's documentation for specific deployment instructions. The WAR file should be deployed as an exploded WAR to avoid potential issues.
  3. (Optional) If using an external database create a new database instance that can be used by JAMWiki, or verify that a database user is available with permission to create tables and sequences. If support is needed for double-byte character sets be sure that the database uses UTF-8 encoding.
  4. (Optional) If using an external database verify that your JDBC driver is in the web application server's classpath.
  5. Update the org.jamwiki.pattern value in the logging.properties file with the location where log files should be written. The logging.properties file can be found in the /WEB-INF/classes/ directory of your installation. Note that the web application server must have permission to write to the specified log location.
  6. Once the JAMWiki WAR file has been deployed and the web application server started, view the http://<server>/<context>/ page, where <server> is the application server URL, and <context> is the application server context. The JAMWiki configuration process will begin automatically.

The configuration process begins automatically with the first JAMWiki pageview after setup. Configuration will request the following information:

  1. A directory (accessible to the application server) into which JAMWiki files can be written.
  2. A directory (accessible to the web/application server) into which images and other files can be uploaded.
  3. The relative path (with respect to the web/application server doc root) to the image upload directory.
  4. The login and password of an administrative user.
  5. (Optional) If using an external database for persistency then the database settings must be provided.
  6. (Optional) Once setup is complete, JAMWiki can be customized by using the Special:Admin page, accessible to admins by clicking on the "Admin" link on the top right portion of all JAMWiki pages.

Once the configuration settings have been verified JAMWiki will create the admin user account, database tables (if using an external database), base properties, and default topics. Once configuration is complete JAMWiki redirects to the starting page, ready for use. If any problems occur during installation please review the detailed installation instructions on Installation. If your problem persists please report it on Bug Reports and include any relevant information from your log files with the problem report.

Upgrades

Users of JAMWiki 0.4.0 or later can upgrade using a mostly-automated wizard process; those using older versions should first upgrade to 0.4.0 or else follow the manual upgrade steps outlined in UPGRADE.txt.

To upgrade using the automated process follow these steps:

  1. Download the latest JAMWiki release from http://sourceforge.net/projects/jamwiki/.
  2. Back up all database and/or file data prior to upgrading.
  3. Back up the jamwiki.properties file and the logging.properties from the the /WEB-INF/classes/ directory. These files will need to be restored after the new JAMWiki WAR file has been deployed.
  4. If you have made any changes to any other files under the /WEB-INF/ directory be sure that they are backed up as well as they will need to be restored after the new JAMWiki WAR file has been deployed.
  5. Remove the old JAMWiki installation by deleting your existing JAMWiki web application. For some web application servers you may also want to clear the application server's cache.
  6. Install the new JAMWiki WAR file. See your web application server's documentation for instructions.
  7. Restore the files that were backed up in steps three and four to their previous locations under the /WEB-INF/ and /WEB-INF/classes/ directories, overwriting any new files.
  8. (Optional) If using an external database, make sure that your JDBC driver is available in the web application server's classpath.
  9. Verify that the web application server process has read and write access to all files in the new JAMWiki installation.
  10. Restart the web application server and view any page on the Wiki. You will be redirected to the upgrade page and any required upgrade steps will be automatically performed.

If the upgrade fails see the UPGRADE.txt for instructions to manually upgrade. If the problem persists please report it on Bug Reports and include any relevant information from your log files with the problem report. Note that some users have reported failures after upgrading, but the problem was caused by old JAMWiki files being cached by the application server. This problem is particularly common with Tomcat, and can be resolved by clearing the application server's cache.