1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml" dir="ltr" lang="en" xml:lang="en">
5
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
6
<meta http-equiv="content-style-type" content="text/css" />
7
<meta http-equiv="content-language" content="en" />
8
<meta http-equiv="imagetoolbar" content="no" />
9
<meta name="resource-type" content="document" />
10
<meta name="distribution" content="global" />
11
<meta name="copyright" content="2007 phpBB Group" />
12
<meta name="keywords" content="" />
13
<meta name="description" content="phpBB 3.0.x Readme" />
14
<title>phpBB3 • Readme</title>
16
<link href="stylesheet.css" rel="stylesheet" type="text/css" media="screen, projection" />
20
<body id="phpbb" class="section-docs">
23
<a id="top" name="top" accesskey="t"></a>
24
<div id="page-header">
25
<div class="headerbar">
26
<div class="inner"><span class="corners-top"><span></span></span>
28
<div id="doc-description">
29
<a href="../index.php" id="logo"><img src="site_logo.gif" alt="" /></a>
30
<h1>phpBB 3.0.x Readme</h1>
31
<p style="display: none;"><a href="#start_here">Skip</a></p>
34
<span class="corners-bottom"><span></span></span></div>
38
<a name="start_here"></a>
42
<!-- BEGIN DOCUMENT -->
44
<p>Thank you for downloading phpBB3. This README will guide through the basics of installation and operation of phpBB3. Please ensure you read this and the accompanying documentation fully <strong>before</strong> proceeding with the installation.</p>
48
<div class="paragraph menu">
49
<div class="inner"><span class="corners-top"><span></span></span>
54
<li><a href="#install">Installing phpBB3</a></li>
55
<li><a href="#run">Running phpBB3</a>
56
<ol style="list-style-type: lower-roman;">
57
<li><a href="#i18n">Internationalisation (i18n)</a></li>
58
<li><a href="#styles">Styles</a></li>
59
<li><a href="#mods">Modifications</a></li>
62
<li><a href="#help">Getting help with phpBB3</a>
63
<ol style="list-style-type: lower-roman;">
64
<li><a href="#docs">Documentation</a></li>
65
<li><a href="#website">Community Forums</a></li>
66
<li><a href="#irc">Internet Relay Chat</a></li>
69
<li><a href="#status">Status of this version</a></li>
70
<li><a href="#bugs">Reporting Bugs</a>
71
<ol style="list-style-type: lower-roman;">
72
<li><a href="#securitybugs">Security related bugs</a></li>
75
<li><a href="#curbugs">Overview of current bug list</a></li>
76
<li><a href="#php">PHP compatibility issues</a></li>
77
<li><a href="#disclaimer">Disclaimer</a></li>
82
<span class="corners-bottom"><span></span></span></div>
87
<a name="install"></a><h2>1. Installing phpBB3</h2>
89
<div class="paragraph">
90
<div class="inner"><span class="corners-top"><span></span></span>
94
<p>Installation, update and conversion instructions can be found in the <a href="INSTALL.html">INSTALL</a> document contained in this distribution. If you are intending to convert from a previous phpBB 2.0.x installation we highly recommend you backup any existing data before proceeding!</p>
96
<p>Users of phpBB3 Beta versions cannot directly update.</p>
98
<p>Please note that we won't support the following installation types:</p>
100
<li>Updates from phpBB3 Beta versions to phpBB3 RC1 and higher</li>
101
<li>Conversions from phpBB 2.0.x to phpBB3 Beta versions</li>
102
<li>phpBB3 Beta installations</li>
105
<p>We give support for the following installation types:</p>
108
<li>Updates from phpBB3 RC1 to the latest version</li>
109
<li>Conversions from phpBB 2.0.x to the latest version</li>
110
<li>New installations of phpBB3 - always only the latest released version</li>
115
<div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
117
<span class="corners-bottom"><span></span></span></div>
122
<a name="run"></a><h2>2. Running phpBB3</h2>
124
<div class="paragraph">
125
<div class="inner"><span class="corners-top"><span></span></span>
127
<div class="content">
129
<p>Once installed phpBB is easily managed by both admin and moderator control panels. If you need help or advice with phpBB please see <a href="#help">Section 3</a> below.</p>
131
<a name="i18n"></a><h3>2.i. Internationalisation (i18n)</h3>
133
<p>A number of language packs and style localisations are available. You can find them on our official download page:</p>
135
<p><a href="http://www.phpbb.com/downloads/">http://www.phpbb.com/downloads/</a></p>
137
<p>This is the <em>official</em> location for all supported 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!</p>
139
<p>Installation of these packages is straightforward, simply download the required language pack and unarchive it into the <samp>languages/</samp> folder. Please ensure you retain the directory structure when doing this! Once uploaded go to the <code>Admin->System->Language Packs</code> and install the now appeared new language pack. To install the style imageset you should download the imageset for your language and unarchive the file/s into the relevant imageset directory (styles/prosilver/imageset or styles/subsilver2/imageset), again you must retain the directory structure. Once installed the imageset will become immediately available.</p>
141
<p>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.</p>
143
<a name="styles"></a><h3>2.ii. Styles</h3>
145
<p>Although phpBB Group are rather proud of the included styles we realise that it may not be to everyones tastes. Therefore phpBB3 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</p>
147
<p><a href="http://www.phpbb.com/styles/">http://www.phpbb.com/styles/</a></p>
149
<p><strong>Please note</strong> that 3rd party styles downloaded for versions of phpBB2 will <strong>not</strong> work in phpBB3.</p>
151
<p>Once you have downloaded a style the usual next step is to unarchive (or upload the unarchived contents of) the package into your <samp>styles/</samp> directory. You then need to visit <code>Administration -> Styles</code>, you should see the new style available, click install and it will become available for all your users.</p>
153
<p><strong>Please note</strong> that if you create your own style or modify existing ones, please remember to enable the "Recompile stale style components" setting within the <code>Admin->General->Load Settings</code> screen. This setting allows the cache to detect changes made to the style and automatically refresh it. If this setting is disabled, you will not see your changes taking effect.</p>
155
<a name="mods"></a><h3>2.iii. Modifications</h3>
157
<p>Although not officially supported by phpBB Group, phpBB has a thriving modification scene. These third party modifications to the standard phpBB extend its capabilities still further and can be found at:</p>
159
<p><a href="http://www.phpbb.com/mods/">http://www.phpbb.com/mods/</a></p>
161
<p><strong>Please remember</strong> that any bugs or other issues that occur after you have added any modification should <strong>NOT</strong> be reported to the bug tracker (see below). First remove the modification and see if the problem is resolved.</p>
163
<p>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.</p>
167
<div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
169
<span class="corners-bottom"><span></span></span></div>
174
<a name="help"></a><h2>3. Getting help with phpBB3</h2>
176
<div class="paragraph">
177
<div class="inner"><span class="corners-top"><span></span></span>
179
<div class="content">
181
<p>phpBB3 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 <a href="FAQ.html">FAQ</a> which covers a few basic getting started questions. If you need additional help there are several places you should look.</p>
183
<a name="docs"></a><h3>3.i. phpBB3 Documentation</h3>
185
<p>A comprehensive documentation is now available online and can be accessed from the following location:</p>
187
<p><a href="http://www.phpbb.com/support/documentation/3.0/">http://www.phpbb.com/support/documentation/3.0/</a></p>
189
<p>This covers everything from installation through setting permissions and managing users.</p>
191
<a name="website"></a><h3>3.ii. Community Forums</h3>
193
<p>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:</p>
195
<p><a href="http://www.phpbb.com/">http://www.phpbb.com/</a></p>
197
<p>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.</p>
199
<a name="irc"></a><h3>3.iii Internet Relay Chat</h3>
201
<p>Another place you may find help is our IRC channel. This operates on the Freenode IRC network, <em>irc.freenode.net</em> and the channel is <em>#phpbb</em> 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.</p>
205
<div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
207
<span class="corners-bottom"><span></span></span></div>
212
<a name="status"></a><h2>4. Status of this version</h2>
214
<div class="paragraph">
215
<div class="inner"><span class="corners-top"><span></span></span>
217
<div class="content">
219
<p>This is the third stable release of phpBB. The 3.0.x line is essentially feature frozen, with only point releases seeing fixes for bugs and security issues, though feature alterations and minor feature additions may be done if deemed absolutely required. Our next major release will be phpBB 3.2 and the planning phase has begun (the unstable development version is 3.1). Please do not post questions asking when 3.2 will be available, no release date has been set.</p>
221
<p>For those interested in the development of phpBB should keep an eye on the community forums to see how things are progressing:</p>
223
<p><a href="http://area51.phpbb.com/phpBB/">http://area51.phpbb.com/phpBB/</a></p>
225
<p>Please note that this forum should <strong>NOT</strong> be used to obtain support for or ask questions about phpBB 2.0.x or phpBB 3.0.x, the main community forums are the place for this. Any such posts will be locked and go unanswered.</p>
229
<div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
231
<span class="corners-bottom"><span></span></span></div>
236
<a name="bugs"></a><h2>5. Reporting Bugs</h2>
238
<div class="paragraph">
239
<div class="inner"><span class="corners-top"><span></span></span>
241
<div class="content">
243
<p>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 <strong>DO NOT</strong> post bug reports to our forums, they will be locked. In addition please <strong>DO NOT</strong> 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).</p>
245
<p><a href="http://www.phpbb.com/bugs/">http://www.phpbb.com/bugs/</a></p>
247
<p>While we very much appreciate receiving bug reports (the more reports the more stable phpBB will be) we ask you carry out a few steps before adding new entries:</p>
250
<li>Firstly determine if your bug is reproduceable, how to determine this depends on the bug in question. Only if the bug is reproduceable it is likely to be a problem with phpBB3 (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<br /><br /></li>
251
<li>Next please read or search through the existing bug reports to see if <em>your</em> 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).<br /><br /></li>
252
<li>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 <strong>DO NOT</strong> 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 phpBB3<br /><br /></li>
253
<li>If no existing bug exists then please feel free to add it</li>
256
<p>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:</p>
259
<li>Your server type/version, e.g. Apache 1.3.28, IIS 4, Sambar, etc.</li>
260
<li>PHP version and mode of operation, e.g. PHP 5.1.1 as a module, PHP 4.4.4 running as CGI, etc.</li>
261
<li>DB type/version, e.g. MySQL 4.0.1, PostgreSQL 7.3.2, MSSQL Server 2000 SP1, etc.</li>
264
<p>The relevant database type/version is listed within the administration control panel</p>
266
<p>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 <strong>VERY SURE</strong> works (and is consistent with our <a href="coding-guidelines.html">coding guidelines</a>) 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.</p>
268
<p>Once a bug has been submitted you will be emailed any follow up comments added to it. <strong>Please</strong> if you are requested to supply additional information, do so! It is 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.</p>
270
<a name="securitybugs"></a><h3>5.i. Security related bugs</h3>
272
<p>If you find a potential security related vulnerability in phpBB please <strong>DO NOT</strong> post it to the bug tracker, public forums, 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 to our security tracker:</p>
274
<p><a href="http://www.phpbb.com/security/">http://www.phpbb.com/security/</a></p>
278
<div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
280
<span class="corners-bottom"><span></span></span></div>
285
<a name="curbugs"></a><h2>6. Overview of current bug list</h2>
287
<div class="paragraph">
288
<div class="inner"><span class="corners-top"><span></span></span>
290
<div class="content">
292
<p>This list is not complete 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, updating and/or conversions.</p>
295
<li>Conversions may fail to complete on large boards under some hosts</li>
296
<li>Updates may fail to complete on large update sets under some hosts</li>
297
<li>Smilies placed directly after bbcode tags will not get parsed. Smilies always need to be separated by spaces.</li>
302
<div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
304
<span class="corners-bottom"><span></span></span></div>
309
<a name="php"></a><h2>7. PHP compatibility issues</h2>
311
<div class="paragraph">
312
<div class="inner"><span class="corners-top"><span></span></span>
314
<div class="content">
316
<p>phpBB is no longer supported on PHP3 due to several compatibility issues and we recommend that you upgrade to the latest stable release of PHP5 to run phpBB. The minimum version required is PHP 4.3.3.</p>
318
<p>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 phpBB3. If you are running a developmental version of PHP please check any bugs you find on a system running a stable release before submitting.</p>
320
<p>This board has been developed and tested under Linux and Windows (amongst others) running Apache using MySQL 3.23, 4.x, 5.x, MSSQL Server 2000, PostgreSQL 7.x, Oracle 8, SQLite and Firebird. Versions of PHP used range from 4.3.3 to 6.0.0-dev without problem. </p>
322
<a name="phpsec"></a><h3>7.i. Notice on PHP security issues</h3>
324
<p>Currently there are no known issues regarding PHP security.</p>
328
<div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
330
<span class="corners-bottom"><span></span></span></div>
335
<a name="disclaimer"></a><h2>8. Copyright and disclaimer</h2>
337
<div class="paragraph">
338
<div class="inner"><span class="corners-top"><span></span></span>
340
<div class="content">
342
<p>This application is opensource software released under the <a href="http://opensource.org/licenses/gpl-license.php">GPL</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) 2000, 2002, 2005, 2007 <a href="http://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p>
346
<div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
348
<span class="corners-bottom"><span></span></span></div>
351
<!-- END DOCUMENT -->
353
<div id="page-footer">
354
<div class="version"> </div>
359
<a id="bottom" name="bottom" accesskey="z"></a>
added
removed
www/php/phpBB3/docs/README.html
