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

Release Notes

JAMWiki 0.5.2 is now available for download. This is a minor release that includes some new features as well as bug fixes. Notable changes made during this release include:

  • A whitelist/blacklist feature has been added to allow wiki administrators to prevent potentially malicious file uploads.
  • A parser bug has been fixed that caused parsing of certain topic names to timeout.
  • Japanese translations have been added by nattolover.

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, and to report any problems.

IMPORTANT: JAMWiki is undergoing rapid development, and while the code is reasonably stable bug reports, feedback and contributions are encouraged and can be reported at http://jamwiki.org/.

Installation Instructions

New Installs

See Installation for the complete installation instructions; see the UPGRADE.txt for the complete 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.
  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

In most cases upgrades can be handled using a mostly-automated wizard process. To upgrade using this 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.

Changelog

New Features

  • Add the option to whitelist/blacklist allowed file upload types.
  • Upgrade to commons-io-1.3.1.jar.
  • Upgrade to commons-fileupload-1.2.jar.
  • When displaying a "topic does not exist" message, also include a link to create the topic.
  • Update look & feel - do not underline links, add fieldset tags.
  • Split the main admin page into Special:Admin and Special:Maintenance.
  • Hide the Special:Convert admin page.
  • Add an option to clear the cache from Special:Maintenance.
  • Added automatically generated JUnit tests from junitfactory.com (okohll).

Bugfixes

  • Certain topic names could cause errors resulting in CPU usage of 100%.
  • Fix build error where build would fail if local files directory did not exist.

Translation Updates

  • Updated Chinese translations (hfl).
  • Updated German translations (axelclk).
  • Updated Hungarian translations (bdanee).
  • Added Japanese translations (nattolover).
  • Updated Polish translations (dlpa)