Index of /speak/docs

phpBB 2.0.6 README

Thank you for downloading phpBB 2, 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 phpBB 2. Please ensure you read this and the accompanying documentation fully before proceeding with the installation.

1. Installing phpBB 2
2. Running phpBB 2
1. Internationalisation (i18n)
2. Styles
3. Mods
3. Getting help with phpBB 2
1. Userguide
2. Community Forums
3. Internet Relay Chat
4. Status of this version
5. Reporting Bugs
1. Security related bugs
6. Overview of current bug list
7. PHP compatibility issues
1. Notice on PHP security issues
8. Disclaimer

1. Installing phpBB 2

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 phpBB 2 should run the update_to_205.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 phpBB 2 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 phpBB 2 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

Once installed phpBB 2.0 is easily managed by both admin and moderator control panels. If you need help or advice with phpBB 2 please see Section 3 below.

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.6 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 phpBB 2.

If you have upgraded from 2.0.0 and make use of non-English language packs you will benefit from downloading updated versions which will become available shortly. These introduce a number of strings which went missing from the first version plus a few updates and additions.

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 phpBB 2 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 phpBB 2 prior to its final (2.0.x) release will not function correctly. You should either remove these styles or (if available) update them to meet changes in 2.0.x.

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, phpBB 2 has a thriving mod (formerly known as hacks) scene. These third party modifications to the standard phpBB 2 extend its capabilities still further and can be found at:

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 phpBB 2

phpBB 2 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 several places you should look.

3.i. phpBB 2 Userguide

A comprehensive userguide is now available online and can be accessed from the following location:

http://www.phpbb.com/guide/phpBB_Users_Guide.html

This covers everything from installation through setting permissions and managing users.

3.ii. Community Forums

phpBB Group maintains a thriving community where a number of people have generously decided to donate their time to help support users. This site can be found at:

http://www.phpbb.com/

If you do seek help via our forums please be sure to do a Search before posting. This may well save both you and us time and allow the developer, moderator and support groups 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.

3.iii Internet Relay Chat

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 second stable release of phpBB 2. The 2.0.x line is essentially feature frozen, point releases will see only bugs and such like fixed. Our next major release will be phpBB 2.2 and work is progressing on this (the unstable development version is 2.1). Please do not post questions asking when 2.2 will be available, no release date has been set. 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/phpBB 2/

Please note that this forum should NOT be used to obtain support for or ask questions about phpBB 2.0.x, the main community forums are the place for this. Any such posts will be locked and go unanswered.

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. In addition please DO NOT use the bug tracker for support requests. Posting such a request will only see you directed to the support forums (while taking time away from working on real bugs).

http://www.phpbb.com/bugs/

While we very much appreciate receiving bug reports (the more reports the more stable phpBB 2 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.

5.i. Security related bugs

If you find a potential security related vulnerability in phpBB 2 please DO NOT post it to the bug tracker, public forums, mailing lists, etc.! Doing so may allow unscrupulous users to take advantage of it before we have time to put a fix in place. All security related bugs should be sent directly to one or more of the developers.

This can be done in one of three ways; email security@phpbb.com this is forwarded to all developers, PM one of the developers (see Developer usergroup list for usernames of all developers) or email them directly (either use their listed email address if available or username@phpbb.com where username is their board username). If emailing or PM'ing developers individually please send the message to several and not just one. If you obtain no response in a reasonable timeframe (a day or two) try the other listed developers.

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.

• First four characters of some posted content disappears - this is an issue with PHP not phpBB
• 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)
• Use of non-latin charsets with MSSQL may result in post data being cropped unexpectedly
• Upgrade may fail to complete on large boards under some hosts
• PHP 3 compatibility issues remain and we recommend you upgrade to PHP4 as soon as possible ( phpBB 2.0.x will be the last version to support PHP 3 )

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 phpBB 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. Versions of PHP used range from 4.0.6 to 4.2.3 without problem. There may be unconfirmed issues with PHP 4.0.1 including patch level releases. If you experience problems with phpBB and have this PHP version installed it is recommended you upgrade it before posting bug reports.

7.i. Notice on 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 new versions of PHP 4 have been released).

Because of this, and to cope with situations where hosts didn't allow such uploads anyway we have implemented various checks in phpBB 2. 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. 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 © 2002 phpBB Group, All Rights Reserved.