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.0

Release Notes[edit]

After four months in development, JAMWiki 0.6.0 (code name "Goin' Back to Georgia") is now available for download. The 0.6.0 release introduces significant new functionality as well as numerous bugfixes, code cleanups, and cosmetic changes. Notable changes made during this release include:

  • A new authentication mechanism that allows site administrators to tightly control access to wiki functionality. Using the Special:Roles interface an admin can limit who has access to upload content, create pages, or perform just about any other wiki task.
  • The project repository has been converted to the Maven project structure through the tireless efforts of mikegr and RegisDecamps.
  • A new tab has been added to user pages to allow viewing of user contributions (RegisDecamps).
  • Upgrades to Spring 2.06, Lucene 2.2, Acegi 1.0.4 and ehcache 1.3.
  • Numerous other changes, bug fixes, cleanups, and generally good things.

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[edit]

New Features[edit]

  • New infrastructure for assigning fine-grained user permissions, including a new Special:Roles administrative interface.
  • User pages now offer a "User Contributions" tab that displays all contributions made by the user (RegisDecamps).
  • Project converted to use Maven (RegisDecamps & mikegr).
  • New Special:ImportTiddly page for importing from TiddlyWiki (mikegr).
  • Update the UI used in the wiki admin pages.
  • Remove ability to automatically upgrade from versions prior to 0.4.0.
  • Remove the unused & deprecated Special:Convert admin page.
  • Updated spam filter patterns.
  • Apostrophes are no longer automatically converted to '. (RegisDecamps).
  • Image resizing uses a smaller resize increment, improving image quality.
  • Upgrade to Spring Framework 2.0.6.
  • Upgrade to Acegi Security 1.0.4.
  • Upgrade to ehcache 1.3.0.
  • Upgrade to Lucene Search 2.2.

Bugfixes[edit]

  • Fix issue on Tomcat 5 & some other application servers that could cause corrupted topic names when editing non-ASCII topics.
  • Fix web.xml issue when using Glassfish application server (amerigo5).
  • Resolve a JNDI database connectivity issue (mnencia).
  • Fix an issue related to the SHA-512 algorithm that broke installations on JDK versions prior to 1.4.2.
  • UNIX systems without X could crash on image resizing. Modify error handling to catch Throwable rather than Exception and log a message explaining how to work around this particular issue. Reported and debugged by Michael Osipov, who also provided a suggested fix.
  • Fix parsing of bold italic ('''''), which produced incorrect HTML in previous releases. Reported by RegisDecamps.
  • Oracle stores empty strings as NULL, which causes breakage with empty topics. Issue should now be resolved.
  • Wiki signatures could generate incorrectly for users without display names.
  • Fix missing apostrophe in SQL used by MS SQL when displaying the Special:Listusers pages. Reported by yesesnono.
  • Fix incorrect constraint in SQL used by MS SQL that prevents recreating topics that have been deleted. Reported by yesesnono.

Translation Updates[edit]

  • Updated Chinese translations (hfl).
  • Added Croatian translations (Marija Susovic).
  • Updated Danish translations (g9adm).
  • Updated Dutch translations (Angel).
  • Updated German translations (axelclk and frareinif).
  • Updated Japanese translations (nattolover).
  • Updated Polish translations (dlpa)

Installation Instructions[edit]

New Installs[edit]

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[edit]

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.