PhpBB3: Difference between revisions

From RavenWiki
Jump to navigationJump to search
Line 10: Line 10:


Since there is currently no way to automatically install modifications supplied in the XML-based phpBB3 "mod file" format (and manual installation would be very fiddly), these modifications are being provided as sets of added and replacement files for specific phpBB3 versions. NB Installing them on any other version would most likely be disastrous, losing significant changes between the versions and quite probably breaking phpBB3 functionality.
Since there is currently no way to automatically install modifications supplied in the XML-based phpBB3 "mod file" format (and manual installation would be very fiddly), these modifications are being provided as sets of added and replacement files for specific phpBB3 versions. NB Installing them on any other version would most likely be disastrous, losing significant changes between the versions and quite probably breaking phpBB3 functionality.
==phpBB3.0.0-raven-0.3==
This is largely just the 0.2 kit updated for use with phpBB 3.0.0, but the location of the Raven server's public key file(s) is now specified through the Admin Control Panel (rather than by editing a file), and various checks are done before enabling Raven authentication. It will now refuse to enable it (with an explanation) if any of the various pre-requisites (such as the PHP OpenSSL extension) are not met, greatly reducing the risk that Raven authentication will be enabled when certain to fail. The README file in the tar and zip file kits has now been split into three files: Changelog (details of what's changed), README (what to expect from these modifications, etc.) and INSTALL (how to install the modifications).
Special care is needed (details in the INSTALL file) if you are upgrading from an earlier version of these modifications (because of the change to how the the Raven public key directory is specified).
Note that the problem mentioned below that affected use of phpBB3RC7 with PHP 5.2.4 and .5 (in general, not specifically Raven authentication) was fixed in the subsequent phpBB 3.0.0 release, and no longer requires special attention.
Downloads:
* [http://raven.cam.ac.uk/project/phpbb/files/phpBB3.0.0-raven-0.3.tar.gz phpBB3.0.0-raven-0.3.tar.gz]
* [http://raven.cam.ac.uk/project/phpbb/files/phpBB3.0.0-raven-0.3.zip phpBB3.0.0-raven-0.3.zip]


==phpBB3rc7-raven-0.2==
==phpBB3rc7-raven-0.2==

Revision as of 13:16, 7 April 2008

Introduction

phpBB is a very popular PHP-based web forum package, which has been extensively updated for version 3.

Although phpBB3 includes an authentication "plug-in" facility, that does not make it trivial to enable use of Raven - it makes too many assumptions about how authentication works.

As the first stage of a larger project, the Computing Service has developed the necessary modifications to allow fully integrated use of Raven with phpBB3. Those modifications are being made available in the hope that they will be of wider use around the University.

While there is no formal guarantee of support for any problems, any problems affecting Computing Service use of the modifications are likely to be addressed, sooner or later.

Since there is currently no way to automatically install modifications supplied in the XML-based phpBB3 "mod file" format (and manual installation would be very fiddly), these modifications are being provided as sets of added and replacement files for specific phpBB3 versions. NB Installing them on any other version would most likely be disastrous, losing significant changes between the versions and quite probably breaking phpBB3 functionality.

phpBB3.0.0-raven-0.3

This is largely just the 0.2 kit updated for use with phpBB 3.0.0, but the location of the Raven server's public key file(s) is now specified through the Admin Control Panel (rather than by editing a file), and various checks are done before enabling Raven authentication. It will now refuse to enable it (with an explanation) if any of the various pre-requisites (such as the PHP OpenSSL extension) are not met, greatly reducing the risk that Raven authentication will be enabled when certain to fail. The README file in the tar and zip file kits has now been split into three files: Changelog (details of what's changed), README (what to expect from these modifications, etc.) and INSTALL (how to install the modifications).

Special care is needed (details in the INSTALL file) if you are upgrading from an earlier version of these modifications (because of the change to how the the Raven public key directory is specified).

Note that the problem mentioned below that affected use of phpBB3RC7 with PHP 5.2.4 and .5 (in general, not specifically Raven authentication) was fixed in the subsequent phpBB 3.0.0 release, and no longer requires special attention.

Downloads:

phpBB3rc7-raven-0.2

This is essentially the first public version of these modifications (identical to version 0.1 except for important corrections to the installation instructions). See the README file in the tar/zip files for details of what facilities the modifications do (or do not) provide, as well as the installation instructions. As supplied, the only supported language is English and the only supported style is the (default) prosilver, though updating other languages and styles to work with these modifications would not be a large amount of work (given the appropriate expertise).

These modifications are specifically for phpBB3rc7 (i.e. Release Candidate 7), and should not be expected to work without modification on later (or earlier) versions.

Downloads:

The tar.gz and zip file contents are identical except for the files within the zip file having Windows newlines (i.e. carriage-return+line-feed) rather than Unix newlines (just line-feed).

WARNING See PHP 5.2.4 and .5 break phpBB3rc7 on Windows if relevant to the system on which you are, or will be, running phpBB3.

Future plans

With no promises about timescales, or exactly what will be included in futures versions, the following may be of interest as a guide to potential short-term developments.

Enhancements to existing facilities

  • "sanity-checking" the environment, to reject attempts to enable Raven authentication when it would be certain to leave phpBB with non-working authentication (e.g. if PHP's OpenSSL support is not available)
  • improvements to error handling

New functionality

  • (optional) ability to use data from the University's "lookup" directory to set corresponding phpBB3 User Profile fields.