~yooozy/mountada/main

« back to all changes in this revision

Viewing changes to docs/README.html

  • Committer: Abdelaziz Yakout
  • Date: 2013-11-14 14:51:03 UTC
  • Revision ID: abdelaziz.yakout@gmail.com-20131114145103-rlwgensa9151gttc
ignored files and added

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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">
 
3
<head>
 
4
 
 
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="phpBB Group" />
 
12
<meta name="keywords" content="" />
 
13
<meta name="description" content="phpBB 3.0.x Readme" />
 
14
<title>phpBB3 &bull; Readme</title>
 
15
 
 
16
<link href="stylesheet.css" rel="stylesheet" type="text/css" media="screen, projection" />
 
17
 
 
18
</head>
 
19
 
 
20
<body id="phpbb" class="section-docs">
 
21
 
 
22
<div id="wrap">
 
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>
 
27
 
 
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>
 
32
                        </div>
 
33
 
 
34
                        <span class="corners-bottom"><span></span></span></div>
 
35
                </div>
 
36
        </div>
 
37
 
 
38
        <a name="start_here"></a>
 
39
 
 
40
        <div id="page-body">
 
41
 
 
42
<!-- BEGIN DOCUMENT -->
 
43
 
 
44
        <p>Thank you for downloading phpBB3. This README will guide you 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>
 
45
 
 
46
        <h1>Readme</h1>
 
47
 
 
48
        <div class="paragraph menu">
 
49
                <div class="inner"><span class="corners-top"><span></span></span>
 
50
 
 
51
                <div class="content">
 
52
 
 
53
                        <ol>
 
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">Languages (Internationalisation - i18n)</a></li>
 
58
                                        <li><a href="#styles">Styles</a></li>
 
59
                                        <li><a href="#mods">Modifications</a></li>
 
60
                                </ol>
 
61
                                </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="#kb">Knowledge Base</a></li>
 
66
                                        <li><a href="#website">Community Forums</a></li>
 
67
                                        <li><a href="#irc">Internet Relay Chat (IRC)</a></li>
 
68
                                </ol>
 
69
                                </li>
 
70
                                <li><a href="#status">Status of this version</a></li>
 
71
                                <li><a href="#bugs">Reporting bugs</a>
 
72
                                <ol style="list-style-type: lower-roman;">
 
73
                                        <li><a href="#securitybugs">Security related bugs</a></li>
 
74
                                </ol>
 
75
                                </li>
 
76
                                <li><a href="#curbugs">Overview of current bug list</a></li>
 
77
                                <li><a href="#php">PHP compatibility issues</a></li>
 
78
                                <li><a href="#disclaimer">Disclaimer</a></li>
 
79
                        </ol>
 
80
 
 
81
                </div>
 
82
 
 
83
                <span class="corners-bottom"><span></span></span></div>
 
84
        </div>
 
85
 
 
86
        <hr />
 
87
 
 
88
        <a name="install"></a><h2>1. Installing phpBB3</h2>
 
89
 
 
90
        <div class="paragraph">
 
91
                <div class="inner"><span class="corners-top"><span></span></span>
 
92
 
 
93
                <div class="content">
 
94
 
 
95
        <p>Installation, update and conversion instructions can be found in the <a href="INSTALL.html">INSTALL</a> document in this directory. If you are intending on converting from a phpBB 2.0.x installation we highly recommend that you backup any existing data before proceeding!</p>
 
96
 
 
97
        <p>Users of phpBB3 Beta versions cannot directly update.</p>
 
98
 
 
99
        <p>Please note that we don't support the following installation types:</p>
 
100
        <ul>
 
101
                <li>Updates from phpBB3 Beta versions to phpBB3 RC1 and higher</li>
 
102
                <li>Conversions from phpBB 2.0.x to phpBB3 Beta versions</li>
 
103
                <li>phpBB3 Beta installations</li>
 
104
        </ul>
 
105
 
 
106
        <p>We give support for the following installation types:</p>
 
107
 
 
108
        <ul>
 
109
                <li>Updates from phpBB3 RC1 to the latest version</li>
 
110
                <li>Note: if using the <em>Automatic Update Package</em>, updates are supported from phpBB 3.0.2 onward. To update a pre-3.0.2 installation, first update to 3.0.2 and then update to the current version.</li>
 
111
                <li>Conversions from phpBB 2.0.x to the latest version</li>
 
112
                <li>New installations of phpBB3 - only the latest released version</li>
 
113
        </ul>
 
114
 
 
115
                </div>
 
116
 
 
117
                <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 
118
 
 
119
                <span class="corners-bottom"><span></span></span></div>
 
120
        </div>
 
121
 
 
122
        <hr />
 
123
 
 
124
        <a name="run"></a><h2>2. Running phpBB3</h2>
 
125
 
 
126
        <div class="paragraph">
 
127
                <div class="inner"><span class="corners-top"><span></span></span>
 
128
 
 
129
                <div class="content">
 
130
 
 
131
        <p>Once installed, phpBB is easily managed via the Administration and Moderator Control Panels. If you need help or advice with phpBB, please see <a href="#help">Section 3</a> below.</p>
 
132
 
 
133
        <a name="i18n"></a><h3>2.i. Languages (Internationalisation - i18n)</h3>
 
134
 
 
135
        <p>A number of language packs with included style localisations are available. You can find them listed in the <a href="https://www.phpbb.com/languages/">Language Packs</a> pages of our downloads section or from the <a href="https://www.phpbb.com/customise/db/language_packs-25/">Language Packs</a> section of the <a href="https://www.phpbb.com/customise/db/">Customisation Database</a>.</p>
 
136
 
 
137
        <p>For more information about language packs, please see: <a href="https://www.phpbb.com/languages/">https://www.phpbb.com/languages/</a></p>
 
138
 
 
139
        <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. Please do not ask for support if you download a language pack from a 3rd party site.</p>
 
140
 
 
141
        <p>Installation of these packages is straightforward: simply download the required language pack, uncompress (unzip) it and via FTP transfer the included <code>language</code> and <code>styles</code> folders to the root of your board installation. The language can then be installed via the Administration Control Panel of your board: <code>System tab -&gt; General Tasks -&gt; Language packs</code>. A more detailed description of the process is in the Knowledge Base article, <a href="https://www.phpbb.com/kb/article/how-to-install-a-language-pack/">How to Install a Language Pack</a>.</p>
 
142
 
 
143
        <p>If your language is not available, please visit our <a href="https://www.phpbb.com/community/viewforum.php?f=66">[3.0.x] Translations</a> forum where you will find topics on translations in progress. Should you wish to volunteer to translate a language not currently available or assist in maintaining an existing language pack, you can <a href="https://www.phpbb.com/languages/apply.php">Apply to become a translator</a>.</p>
 
144
 
 
145
        <a name="styles"></a><h3>2.ii. Styles</h3>
 
146
 
 
147
        <p>Although the phpBB Group is rather proud of the included styles, we realise that they may not be to everyone's taste. Therefore, phpBB3 allows styles to be switched with relative ease. First, you need to locate and download a style you like. You can find them listed in the <a href="https://www.phpbb.com/customise/db/styles-2/">Styles</a> section of our <a href="https://www.phpbb.com/customise/db/">Customisation Database</a>.</p>
 
148
 
 
149
        <p>For more information about styles, please see: <a href="https://www.phpbb.com/styles/">https://www.phpbb.com/styles/</a></p>
 
150
 
 
151
        <p><strong>Please note</strong> that 3rd party styles downloaded for versions of phpBB2 will <strong>not</strong> work in phpBB3. It is also important to ensure that the style is updated to match the current version of the phpBB software you are using.</p>
 
152
 
 
153
        <p>Once you have downloaded a style, the usual next step is to unarchive (or upload the unarchived contents of) the package into your <code>styles/</code> directory. You then need to visit <code>Administration Control Panel -&gt; Styles tab</code> where you should see the new style available. Click &quot;Install&quot; to install the style.</p>
 
154
 
 
155
        <p><strong>Please note</strong> that to improve efficiency, the software caches certain data. For this reason, if you create your own style or modify existing ones, please remember to &quot;Refresh&quot; the appropriate style components <code>Administration Control Panel -&gt; Styles tab -&gt; Style Components</code> screen. You may also need to reload the page you have changed in your web browser to overcome browser caching. If the changed components are not refreshed you will not see your changes taking effect.</p>
 
156
 
 
157
        <a name="mods"></a><h3>2.iii. Modifications</h3>
 
158
 
 
159
        <p>Although not officially supported by the phpBB Group, phpBB has a thriving modification scene. These third party modifications to the standard phpBB software, known as <strong>MODs</strong>, extend its capabilities still further. You can browse through many of the MODs in the <a href="https://www.phpbb.com/customise/db/modifications-1/">Modifications</a> section of our <a href="https://www.phpbb.com/customise/db/">Customisation Database</a>.</p>
 
160
 
 
161
        <p>For more information about MODs, please see: <a href="https://www.phpbb.com/mods/">https://www.phpbb.com/mods/</a></p>
 
162
 
 
163
        <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 MOD and see if the problem is resolved. Any support for a MOD should only be sought in the &quot;Discussion/Support&quot; forum for that MOD.</p>
 
164
 
 
165
        <p>Also remember that any modifications, particularly those which modify the database in any way, may render upgrading your forum to future versions more difficult. With all this said, many users have and continue to utilise many of the MODs already available with great success.</p>
 
166
 
 
167
                </div>
 
168
 
 
169
                <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 
170
 
 
171
                <span class="corners-bottom"><span></span></span></div>
 
172
        </div>
 
173
 
 
174
        <hr />
 
175
 
 
176
<a name="help"></a><h2>3. Getting help with phpBB3</h2>
 
177
 
 
178
        <div class="paragraph">
 
179
                <div class="inner"><span class="corners-top"><span></span></span>
 
180
 
 
181
                <div class="content">
 
182
 
 
183
        <p>phpBB3 can sometimes seem a little daunting to new users, particularly with regards to 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 can find it.</p>
 
184
 
 
185
        <a name="docs"></a><h3>3.i. phpBB3 Documentation</h3>
 
186
 
 
187
        <p>Comprehensive documentation is now available on the phpBB website:</p>
 
188
 
 
189
        <p><a href="https://www.phpbb.com/support/documentation/3.0/">https://www.phpbb.com/support/documentation/3.0/</a></p>
 
190
 
 
191
        <p>This covers everything from installation to setting permissions and managing users.</p>
 
192
 
 
193
        <a name="kb"></a><h3>3.ii. Knowledge Base</h3>
 
194
 
 
195
        <p>The Knowledge Base consists of a number of detailed articles on some common issues phpBB users may encounter while using the product. The Knowledge Base can be found at:</p>
 
196
 
 
197
        <p><a href="https://www.phpbb.com/kb/">https://www.phpbb.com/kb/</a></p>
 
198
 
 
199
        <a name="website"></a><h3>3.iii. Community Forums</h3>
 
200
 
 
201
        <p>The 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>
 
202
 
 
203
        <p><a href="https://www.phpbb.com/community/">https://www.phpbb.com/community/</a></p>
 
204
 
 
205
        <p>If you do seek help via our forums please be sure to do a search before posting; if someone has experienced the issue before, then you may find that your question has already been answered. Please remember that phpBB is entirely staffed by volunteers, no one receives any compensation for the time they give, including moderators as well as developers; please be respectful and mindful when awaiting responses and receiving support.</p>
 
206
 
 
207
        <a name="irc"></a><h3>3.iv Internet Relay Chat</h3>
 
208
 
 
209
        <p>Another place you may find help is our IRC channel. This operates on the Freenode IRC network, <a href="irc://irc.freenode.net">irc.freenode.net</a> and the channel is <em>#phpbb</em> and can be accessed by any decent IRC client such as mIRC, XChat, etc. Again, please do not abuse this service and be respectful of other users.</p>
 
210
 
 
211
        <p>There are other IRC channels available, please see <a href="https://www.phpbb.com/support/irc/">https://www.phpbb.com/support/irc/</a> for the complete list.</p>
 
212
 
 
213
                </div>
 
214
 
 
215
                <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 
216
 
 
217
                <span class="corners-bottom"><span></span></span></div>
 
218
        </div>
 
219
 
 
220
        <hr />
 
221
 
 
222
<a name="status"></a><h2>4. Status of this version</h2>
 
223
 
 
224
        <div class="paragraph">
 
225
                <div class="inner"><span class="corners-top"><span></span></span>
 
226
 
 
227
                <div class="content">
 
228
 
 
229
        <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.1. Please do not post questions asking when 3.1 will be available, no release date has been set.</p>
 
230
 
 
231
        <p>Those interested in the development of phpBB should keep an eye on the development forums to see how things are progressing:</p>
 
232
 
 
233
        <p><a href="http://area51.phpbb.com/phpBB/">http://area51.phpbb.com/phpBB/</a></p>
 
234
 
 
235
        <p>Please note that the development forums should <strong>NOT</strong> be used to seek 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>
 
236
 
 
237
                </div>
 
238
 
 
239
                <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 
240
 
 
241
                <span class="corners-bottom"><span></span></span></div>
 
242
        </div>
 
243
 
 
244
        <hr />
 
245
 
 
246
<a name="bugs"></a><h2>5. Reporting Bugs</h2>
 
247
 
 
248
        <div class="paragraph">
 
249
                <div class="inner"><span class="corners-top"><span></span></span>
 
250
 
 
251
                <div class="content">
 
252
 
 
253
        <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. 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>
 
254
 
 
255
        <p><a href="http://tracker.phpbb.com/browse/PHPBB3">http://tracker.phpbb.com/browse/PHPBB3</a></p>
 
256
 
 
257
        <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>
 
258
 
 
259
        <ul>
 
260
                <li>First, 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 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>
 
261
                <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>
 
262
                <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&rsquo;s related to something you have done rather than phpBB3<br /><br /></li>
 
263
                <li>If no existing bug exists then please feel free to add it</li>
 
264
        </ul>
 
265
 
 
266
        <p>If you do post a new bug (i.e. one that isn't already listed in the bug tracker) first make sure that you have logged in (your username and password are the same as for the community forums) then please include the following details:</p>
 
267
 
 
268
        <ul>
 
269
                <li>Your server type/version, e.g. Apache 1.3.28, IIS 4, Sambar, etc.</li>
 
270
                <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>
 
271
                <li>DB type/version, e.g. MySQL 4.0.1, PostgreSQL 7.3.2, MSSQL Server 2000 SP1, etc.</li>
 
272
        </ul>
 
273
 
 
274
        <p>The relevant database type/version is listed within the administration control panel.</p>
 
275
 
 
276
        <p>Please be as detailed as you can in your report, and if possible, list the steps required to duplicate the problem. If you have a patch that fixes the issue, please attach it to the ticket or submit a pull request to our repository <a href="https://github.com/phpbb/phpbb3">on GitHub</a>.</p>
 
277
 
 
278
        <p>If you create a patch, it is very much appreciated (but not required) if you follow the phpBB coding guidelines. Please note that the coding guidelines are somewhat different between different versions of phpBB. For phpBB 3.0.x the coding guidelines may be found here: <a href="http://area51.phpbb.com/docs/30x/coding-guidelines.html">http://area51.phpbb.com/docs/30x/coding-guidelines.html</a></p>
 
279
 
 
280
        <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>
 
281
 
 
282
<a name="securitybugs"></a><h3>5.i. Security related bugs</h3>
 
283
 
 
284
        <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>
 
285
 
 
286
        <p><a href="https://www.phpbb.com/security/">https://www.phpbb.com/security/</a></p>
 
287
 
 
288
                </div>
 
289
 
 
290
                <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 
291
 
 
292
                <span class="corners-bottom"><span></span></span></div>
 
293
        </div>
 
294
 
 
295
        <hr />
 
296
 
 
297
<a name="curbugs"></a><h2>6. Overview of current bug list</h2>
 
298
 
 
299
        <div class="paragraph">
 
300
                <div class="inner"><span class="corners-top"><span></span></span>
 
301
 
 
302
                <div class="content">
 
303
 
 
304
        <p>This list is not complete but does represent those bugs which may affect 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>
 
305
 
 
306
        <ul>
 
307
                <li>Conversions may fail to complete on large boards under some hosts.</li>
 
308
                <li>Updates may fail to complete on large update sets under some hosts.</li>
 
309
                <li>Smilies placed directly after bbcode tags will not get parsed. Smilies always need to be separated by spaces.</li>
 
310
        </ul>
 
311
 
 
312
                </div>
 
313
 
 
314
                <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 
315
 
 
316
                <span class="corners-bottom"><span></span></span></div>
 
317
        </div>
 
318
 
 
319
        <hr />
 
320
 
 
321
<a name="php"></a><h2>7. PHP compatibility issues</h2>
 
322
 
 
323
        <div class="paragraph">
 
324
                <div class="inner"><span class="corners-top"><span></span></span>
 
325
 
 
326
                <div class="content">
 
327
 
 
328
        <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. The minimum version that will be required for phpBB 3.1 is PHP 5.3.3.</p>
 
329
 
 
330
        <p>Please remember that running any application on a development (unstable, e.g. a beta release) version of PHP can lead to strange/unexpected results which may appear to be bugs in the application. Therefore, we recommend you upgrade to the newest stable version of PHP before running phpBB3. If you are running a development version of PHP please check any bugs you find on a system running a stable release before submitting.</p>
 
331
 
 
332
        <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 2 and Firebird. Versions of PHP used range from 4.3.3 to 5.4.x without problem. </p>
 
333
 
 
334
<a name="phpsec"></a><h3>7.i. Notice on PHP security issues</h3>
 
335
 
 
336
<p>Currently there are no known issues regarding PHP security.</p>
 
337
 
 
338
                </div>
 
339
 
 
340
                <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 
341
 
 
342
                <span class="corners-bottom"><span></span></span></div>
 
343
        </div>
 
344
 
 
345
        <hr />
 
346
 
 
347
<a name="disclaimer"></a><h2>8. Copyright and disclaimer</h2>
 
348
 
 
349
        <div class="paragraph">
 
350
                <div class="inner"><span class="corners-top"><span></span></span>
 
351
 
 
352
                <div class="content">
 
353
 
 
354
        <p>This application is opensource software released under the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License v2</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright &copy; <a href="https://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p>
 
355
 
 
356
                </div>
 
357
 
 
358
                <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 
359
 
 
360
                <span class="corners-bottom"><span></span></span></div>
 
361
        </div>
 
362
 
 
363
<!-- END DOCUMENT -->
 
364
 
 
365
        <div id="page-footer">
 
366
                <div class="version">&nbsp;</div>
 
367
        </div>
 
368
</div></div>
 
369
 
 
370
<div>
 
371
        <a id="bottom" name="bottom" accesskey="z"></a>
 
372
</div>
 
373
 
 
374
</body>
 
375
</html>