| phpBB 2.0.0 README
Thank you for downloading phpBB 2.0.0, the long awaited re-write of the popular phpBB 1.x online community forum. This README will guide through the basics of installation and operation of phpBB2. Please ensure you read this and the accompanying documentation fully before proceeding with the installation. Installing phpBB 2.0.0 Running phpBB 2.0.0 Internationalisation (i18n) Styles Mods Getting help with phpBB2 Status of this version Reporting Bugs Overview of current bug list PHP compatibility issues Notice on recent PHP security issues Changelog overview Changes since RC-4 Changes since RC-3 Changes since RC-2 Changes since RC-1 Changes since RC-1 (pre) Disclaimer ## 1. Installing phpBB 2.0.0 Installation and upgrade instructions can be found in the INSTALL document contained in this distribution. If you are intending to upgrade from a previous phpBB 1.4.x installation we highly recommend you backup any existing data before proceeding! Please note that users of Release Candidate (RC) versions of phpBB2 should run the update_to_FINAL.php script BEFORE attempting to access your board. Failing to do so may result in errors and unexpected behaviour! While these won't do any damage they will prevent you using your board. If you are using RC-1 (pre) you may find some other DB changes have occured and should examine the schemas to see if your installation requires any modifications (note that most of these have already been discussed on the phpBB2 forums and are handled by the update script). If you are uncomfortable doing any of this we recommend you re-install (you may backup your existing data if you wish, re-install phpBB2 and then insert your backup). Users of phpBB 2.0 Beta-1 cannot directly upgrade to phpBB 2.0 RC-2, 3 or 4, sorry. ## 2. Running phpBB 2.0.0 Once installed phpBB 2.0 is easily managed by both admin and moderator control panels. A full userguide will be available shortly. Till that time please examine the FAQ or visit our forums (noted below) where you will more than likely find the answer to any question/s you have using the search facility, if not feel free to ask. ### 2.i. Internationalisation, i18n A number of language packs and subSilver localisations are now available. You can find them on our official download page: http://www.phpbb.com/downloads.php This is the Official location for all support language sets. If you download a package from a 3rd party site you do so with the understanding that we cannot offer support. So please, do not ask for help in these cases! Installation of these packages is straightforward, simply download the required language pack and unarchive it into the languages/ folder. Please ensure you retain the directory structure when doing this! To install the subSilver image packs you should unarchive the file/s into the templates/subSilver/images directory, again you must retain the directory structure. Once installed the languages will become immediately available. If your language is not available please visit our forums where you will find a topic listing translations currently available or in preparation. This topic also gives you information should you wish to volunteer to translate a language not currently listed Please note that users who have upgraded to 2.0.0 from versions prior to RC-3 should will need to download new versions of the language/subSilver image packs. Any package downloaded prior to the availability of RC-3 will not function correctly with this version of phpBB2. ### 2.ii. Styles Although phpBB Group are rather proud of the subSilver style (which has influenced many of our competitors boards updated designs!) we realise that it may not be to everyones tastes. Therefore phpBB2 allows styles to be switched with relative ease. Firstly you need to locate and download a style you like. We maintain such a site at http://www.phpbb.com/styles/ Please note that 3rd party styles downloaded for versions of phpBB2 prior to its final (2.0.0) release will not function correctly. You should either remove these styles or (if available) update them to meet changes in 2.0.0. Once you have downloaded a style the usual next step is to unarchive (or upload the unarchived contents of) the package into your templates/ directory. You then need to visit Administration -> Styles -> Add, you should see the new style available, click add and it will become available for all your users. ### 2.iii. Mods Although not officially supported by phpBB Group, phpBB2 has a thriving mod (formerly known as hacks) scene. These third party modifications to the standard phpBB2 extend its capabilities still further. Included with this package (in the contrib/ folder) are a number of the more popular mods. You may like to take advantage of some of the extra facilities these offer (do make sure you read the README within that folder before doing anything!). These are just a few of the mods available, many more can be found on our mods site: http://www.phpbb.com/mods Please remember that any bugs or other issues that occur after you have added any modification should NOT be reported to the bug tracker (see below). First remove the modification and see if the problem is resolved. Also remember that any modifications which modify the database in any way may render upgrading your forum to future versions more difficult unless we state otherwise. With all this said many users have and continue to utilise many of the mods already available with great success ## 3. Getting help with phpBB2 phpBB2 can seem a little daunting to new users in places, particularly with regard the permission system. The first thing you should do is check the FAQ which covers a few basic getting started questions. If you need additional help there are two places you can go to ask. We have a thriving and typically friendly community of users who have a range of experience levels. You can find this community at our main site: http://www.phpbb.com/ Please read the forum rules, FAQ and make use of Search before asking questions, etc. it will save you and us a lot of time. If you do seek help via our forums please be sure to do a Search before posting. This may save both you and us time and allow developers and moderators to spend more time responding to people with unknown issues and problems. Please also remember that phpBB is an entirely volunteer effort, no one receives any compensation for the time they give, this includes moderators as well as developers. So please be respectful and mindful when awaiting responses. Another place you may find help is our IRC channel. This operates on the Openprojects IRC network, irc.openprojects.net and the channel is #phpbb and can be accessed by any good IRC client such as mIRC, XChat, etc. Again, please do not abuse this service and be respectful of other users. ## 4. Status of this version This is the first release of phpBB2 to be declared stable taking the version number 2.0.0. The 2.0.0 line is feature frozen, point releases will see only bugs and such like fixed. Our next major release will be phpBB 2.2 and work has already started on this (the unstable development version is 2.1). Please feel free to suggest new features for phpBB 2.2, we already have a number of improvements in mind and these can be viewed using our task tracker: http://sourceforge.net/pm/task.php?group_project_id=13524&group_id=7885 We do not guarantee that all these will appear in 2.2 but we will do our best! If your idea does not appear on this list please visit our feature request list: http://sourceforge.net/tracker/?atid=357885&group_id=7885 Before submitting your idea please ensure you have read through the entries in that list. If your idea is similar to an existing one please feel free to add a comment to it. Please do not submit duplicate suggestions! For some suggestions we may ask for your feedback via our forums. For those interested in the development of phpBB 2.2 you should keep an eye on the community forums (particularly the Feature Discussion forum) where you may be able to influence the direction we take with certain new features. Finally you may like to visit our development forum to see how things are progressing: http://area51.phpbb.com/phpBB2/ Please note that these forums should not be used to obtain support or otherwise ask questions on phpBB 2.0.0, the main community forums are the place for this. ## 5. Reporting Bugs The phpBB Group uses a bug tracking system to store, list and manage all reported bugs, it can be found at the location listed below. Please DO NOT post bug reports to our forums, they will be locked. http://www.phpbb.com/bugs/ While we very much appreciate receiving bug reports (the more reports the more stable phpBB2 will be) we ask you carry out a few steps before adding new entries: Firstly determine if your bug is reproduceable, how to determine this depends on the bug in question. Only if the bug is reproduceable is it likely to be a problem with phpBB 2.0 (or in some way connected). If something cannot be reproduced it may turn out to have been your hosting provider working on something, a user doing something silly, etc. Bug reports for non-reproduceable events can slow down our attempts to fix real, reproduceable issues Next please read or search through the existing bug reports (remember to check open AND closed reports!) to see if your bug (or one very similar to it) is already listed. If it is please add to that existing bug rather than creating a new duplicate entry (all this does is slow us down). Check the forums (use search!) to see if people have discussed anything that sounds similar to what you are seeing. However, as noted above please DO NOT post your particular bug to the forum unless it's non-reproduceable or you are sure it's related to something you have done rather phpBB 2.0 If no existing bug exists then please feel free to add it If you do post a new bug (i.e. one that isn't already listed in the bug tracker) firstly make sure you have logged in (your username and password are the same as for the community forums) then please include the following details: Your server type/version, eg. Apache 1.2.22, IIS 4, Sambar, etc. PHP version and mode of operation, eg. PHP 4.1.1 as a module, PHP 4.0.1 running as CGI, etc. DB type/version, eg. MySQL 3.23.32, PostgreSQL 7.1.2, MSSQL Server 2000 SP1, etc. Please also be as detailed as you can in your report, if possible list the steps required to duplicate the problem. If you have a fix which you are VERY SURE works (and is consistent with our coding guidelines) and does not introduce further problems or incompatibilities please let us know. However only include it in the bug report if you really must, if we need it we'll ask you for it. Once a bug has been submitted you will be emailed any follow up comments added to it. Please if you are requested to supply additional information, do so! It is extremely frustrating for us to receive bug reports, ask for additional information but get nothing. In these cases we have a policy of closing the bug, which may leave a very real problem in place. Obviously we would rather not have this situation arise. ## 6. Overview of current bug list This list is not complete (see above link for full list) but does represent those bugs which may effect users on a wider scale. Other bugs listed in the tracker have typically been shown to be limited to certain setups or methods of installation/upgrade. Cannot post very large messages when using PostgreSQL 7.0.x (limitation of Postgresql 7.0.x) By default cannot post very large messages with MSSQL (this can be configured within MSSQL) Possible issues with gzip (note that these may be PHP related and not phpBB problems) Search may not work correctly with non-latin & multibyte charsets (somewhat a limitation of PHP3/4) Netscape may act strangely on some systems (proving hard to reproduce consistently) Upgrade may fail to complete on large boards under some hosts ## 7. PHP compatibility issues Please remember that running any application on a developmental version of PHP can lead to strange/unexpected results which may appear to be bugs in the application (which may not be true). Therefore we recommend you upgrade to the newest stable version of PHP before running phpBB2 (the most recent stable release of PHP is 4.1.2). If you are running a developmental version of PHP please check any bugs you find on a system running a stable release before submitting. This board has been developed and tested under Linux and Windows (amongst others) running IIS and Apache using MySQL 3.23 and 4.0.0, MSSQL Server 2000, MS Access 2000 and XP and PostgreSQL 7.x. ### 7.i. Notice on recent PHP security issues At the end of February 2002 a major security issue was found with PHP 3 and 4 which has resulted in many hosting providers disabling file uploads (although patches fixing the security issues are available and a new version of PHP 4 has been released). Because of this, and to cope with situations where hosts didn't allow such uploads anyway we have implemented various checks in phpBB2. These checks prevent you from enabling or making use of functions which will not operate correctly on PHP as installed on your server. At this time this includes locally uploaded avatars and DB restore. Third party mods may also be effected but these are outside our control, you should contact the mod writer for more information. ## 8. Changelog overview This is a non-exhaustive overview of the changes made from preceeding versions of phpBB2. It should not be relied upon to determine specific changes which may need to be made to any non-standard (previous) installs of phpBB2! ### 8.i. Changes since RC-4 Fixed improper report of general error when posting messages containing errors Fixed post text being doubled up if it contained one or more < without closing > Fixed pruning errors due to search function name change Hopefully fixed various issues which led to incorrect reply and excess page counts Fixed groupcp not displaying all email buttons to group moderator or admin Fixed failure to display error notice when uploading oversized avatars Hopefully corrected problem with viewonline displaying too few/many users online Partially addressed issue with activation URLs >76 chars Fixed additional search facilities failing to work or working incorrectly Fixed search syntax highlighting Addressed various webservers handling of page redirects Fixed word censor not replacing first or last words Fixed avatar height and width check for locally uploaded images Hopefully fixed cache control header Added check for PM box size limit of 0 to prevent div0 error Fixed failure to fully delete PMs in outbox Fixed display problem with polls Fixed problem with guest username not being displayed for topic results in search Fixed problem with quotes in various profile fields Fixed schema problem with user_timezone Fixed page display issue with MS Access Fixed user level issue when altering user from user to admin and vice versa Fixed incorrect parseing of some email templates Reduced size of MS Access primer Fixed various remaining usergroup display issues ### 8.ii. Changes since RC-3 Addressed serious security issue with included files Fixed non-use of database table prefix name during upgrade Split functions and profile into separate modules Fixed (hopefully) remaining issues with colourisation of moderator usernames Updated install to include entry of additional, required, information Fixed (hopefully) AOL incompatibilities Fixed non-display of moderators in index/viewforum Fixed group control panel 'no groups exist' problems Fix HTTP_X_FORWARDED_FOR spoofing possibility Fix ignoring of private range IP's in HTTP_X_FORWARDED_FOR Enable multiple wildcard email banning, eg. *name*@somewhere.tld Fix problems with posts being truncated if containing < and > characters Prevent URL, BBCode and most smiley parseing in [code][/code] Fix problems with use of certain reserved chars in word censor list Fix default search useage to be as described (was doing AND by default) Fix various avatar issues with profile, gallery and viewtopic Enable safe mode support for uploading avatars Fix broken modcp IP view issue Fix potential session_id re-write vulnerability Finish localisation of days and months (AM/PM are not and will not be localised in 2.0) Remove link to external subSilver stylesheet from default subSilver templates Handle TRANSACTIONS correctly in MySQL 3.x (by returning correct responses) Fix checkbox resetting problem while previewing posts Fix a login redirect issue Remove some additional unused fields during upgrade Fix (hopefully) remaining ICQ overlay issue with view profile in subSilver ### 8.iii. Changes since RC-2 Fixed infamous install parse error Major update of posting and related search functions (fixing various issues and increasing speed) Fixed display of author and last poster names when both are different guest users Fixed upgrade stall issues (hopefully!) and improved output Fixed highlighting code for viewtopic and search Reduced size of several files and functions Moved localised images to sub-directories Improved user feedback of disallowed usernames Fixed various MSSQL bugs Fixed installation of MSSQL/MSSQL-ODBC Fixed security issue with upgrade.php Finished implemention of various additional features Fixed various user, group and forum permissions problems Fixed issues with BBCode [ and ] (hopefully!) Fixed autologin problems with MS IIS Hopefully fixed problems with URIs in emails on some server configs Fixed 'blank' profile and DB utilities problems on submit Fixed incorrect language being used in email subjects Fixed issues with incorrect private message new/unread counts Fixed various PostgreSQL related errors Automatically forward users to login screen in more situations AEnabled (coloured) online indication of moderators and admins Enabled maximum online user count Altered online user count to ignore duplicate IPs (will now underestimate rather than overestimate) Enabled viewing of users browsing each forum Fixed (hopefully) display of overlayed ICQ icon in Netscape using subSilver Fixed display of guest usernames for last post and author Hidden usergroups are now completely hidden from view ### 8.iv. Changes since RC-1 Fixed numerous PostgreSQL related issues Significant updates and additions to the upgrade script Various (missed) hard coded language strings fixed Fixed viewforum error when no forum id specified Fixed old constant name useage in search system Fixed display of moved posts when viewing unanswered posts Fixed failure of search for user and keyword when displaying as posts Fixed PM popup notification Fixed view more emoticon session page problem Fixed view profile email links Fixed display of websites in profile Fixed backup database failure Fixed MS Access schema error when posting topics Fixed problem with hypenated/dotted DB names in MySQL 3.23.6+ Various other fixes and updates ### 8.v. Changes since RC-1 (pre) Upgrade script completed for initial fully functional release Sessions code updated Mark read code updated and hopefully fixed Significant changes to properly deal with \' for non-MySQL boards mssql, msaccess and mssql-odbc DB classes re-written Avatar issues addressed and fixed Search (INSERT) bug using MySQL fixed Search highlighting issues addressed Search own/other users posts fixed BBCode fixes for magic URIs and other issues Template updates for subSilver User and group permissions problems fixed Forum management problems (deletion of forum causing category not to display) fixed Pagination problem with groupcp fixed Backslash issues with posting and profile fixed Backslash issues with emails fixed preg_quote problems fixed User management updated with full avatar control and missing fields Private messaging box limits fixed Private messaging ?folder= strangeness fixed Forum pruning code updated to cope with search system Emoticon system in posting updated BBCode FAQ link added to posting form Language file updates to address concerns of translators Various other bug fixes and updates Note that a full list of fixed bugs can be found at the bug tracker (see section on bug reporting above) ## 9. Copyright and disclaimer This application is opensource software released under the GPL. Please see source code and the Docs directory for more details. This package and its contents are Copyright © 2001/2002 phpBB Group, All Rights Reserved.