[ Index ]

PHP Cross Reference of phpBB-3.1.10-deutsch

title

Body

[close]

/docs/ -> README.html (source)

   1  <!DOCTYPE html>
   2  <html dir="ltr" lang="en">
   3  <head>
   4  <meta charset="utf-8">
   5  <meta http-equiv="X-UA-Compatible" content="IE=edge">
   6  <meta name="keywords" content="" />
   7  <meta name="description" content="phpBB 3.1.x Readme" />
   8  <title>phpBB &bull; Readme</title>
   9  
  10  <link href="assets/css/stylesheet.css" rel="stylesheet" type="text/css" media="screen" />
  11  
  12  </head>
  13  
  14  <body id="phpbb" class="section-docs">
  15  
  16  <div id="wrap">
  17      <a id="top" name="top" accesskey="t"></a>
  18      <div id="page-header">
  19          <div class="headerbar">
  20              <div class="inner">
  21  
  22              <div id="doc-description">
  23                  <a href="../index.php" id="logo"><img src="assets/images/site_logo.gif" alt="" /></a>
  24                  <h1>phpBB 3.1.x Readme</h1>
  25                  <p style="display: none;"><a href="#start_here">Skip</a></p>
  26              </div>
  27  
  28              </div>
  29          </div>
  30      </div>
  31  
  32      <a name="start_here"></a>
  33  
  34      <div id="page-body">
  35  
  36  <!-- BEGIN DOCUMENT -->
  37  
  38      <p class="paragraph main-description">
  39          Thank you for downloading phpBB. This README will guide you through the basics of installation
  40          and operation of phpBB. Please ensure you read this and the accompanying documentation fully
  41          <strong>before</strong> proceeding with the installation.
  42      </p>
  43  
  44      <h1>Readme</h1>
  45  
  46      <div class="paragraph menu">
  47          <div class="inner">
  48  
  49          <div class="content">
  50  
  51              <ol>
  52                  <li><a href="#install">Installing phpBB</a></li>
  53                  <li><a href="#run">Running phpBB</a>
  54                  <ol style="list-style-type: lower-roman;">
  55                      <li><a href="#i18n">Languages (Internationalisation - i18n)</a></li>
  56                      <li><a href="#styles">Styles</a></li>
  57                      <li><a href="#extensions">Extensions</a></li>
  58                  </ol>
  59                  </li>
  60                  <li><a href="#help">Getting help with phpBB</a>
  61                  <ol style="list-style-type: lower-roman;">
  62                      <li><a href="#docs">Documentation</a></li>
  63                      <li><a href="#kb">Knowledge Base</a></li>
  64                      <li><a href="#website">Community Forums</a></li>
  65                      <li><a href="#irc">Internet Relay Chat (IRC)</a></li>
  66                  </ol>
  67                  </li>
  68                  <li><a href="#status">Status of this version</a></li>
  69                  <li><a href="#bugs">Reporting bugs</a>
  70                  <ol style="list-style-type: lower-roman;">
  71                      <li><a href="#securitybugs">Security related bugs</a></li>
  72                  </ol>
  73                  </li>
  74                  <li><a href="#curbugs">Overview of current bug list</a></li>
  75                  <li><a href="#php">PHP compatibility issues</a></li>
  76                  <li><a href="#disclaimer">Disclaimer</a></li>
  77              </ol>
  78  
  79          </div>
  80  
  81          </div>
  82      </div>
  83  
  84      <hr />
  85  
  86      <a name="install"></a><h2>1. Installing phpBB</h2>
  87  
  88      <div class="paragraph">
  89          <div class="inner">
  90  
  91          <div class="content">
  92      <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 or 3.0.x installation we highly recommend that you backup any existing data before proceeding!</p>
  93  
  94      <p>Users of phpBB 3.0 and 3.1 Beta versions cannot directly update.</p>
  95  
  96      <p>Please note that we don't support the following installation types:</p>
  97      <ul>
  98          <li>Updates from phpBB 3.0 Beta versions to phpBB 3.0 RC1 and higher</li>
  99          <li>Updates from phpBB 3.1 Beta versions to phpBB 3.1 RC1 and higher</li>
 100          <li>Conversions from phpBB 2.0.x to phpBB 3.0 or 3.1 Beta versions</li>
 101          <li>phpBB 3.0 or 3.1 Beta installations</li>
 102      </ul>
 103  
 104      <p>We give support for the following installation types:</p>
 105  
 106      <ul>
 107          <li>Updates from phpBB 3.0 RC1 and 3.1 RC1 to the latest version</li>
 108          <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>
 109          <li>Conversions from phpBB 2.0.x to the latest version</li>
 110          <li>New installations of phpBB 3.0.x - only the latest released version</li>
 111          <li>New installations of phpBB 3.1.x - only the latest released version</li>
 112      </ul>
 113  
 114          </div>
 115  
 116          <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 117  
 118          </div>
 119      </div>
 120  
 121      <hr />
 122  
 123      <a name="run"></a><h2>2. Running phpBB</h2>
 124  
 125      <div class="paragraph">
 126          <div class="inner">
 127  
 128          <div class="content">
 129  
 130      <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>
 131  
 132      <a name="i18n"></a><h3>2.i. Languages (Internationalisation - i18n)</h3>
 133  
 134      <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>
 135  
 136      <p>For more information about language packs, please see: <a href="https://www.phpbb.com/languages/">https://www.phpbb.com/languages/</a></p>
 137  
 138      <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>
 139  
 140      <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>Customise tab -&gt; Language management -&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>
 141  
 142      <p>If your language is not available, please visit our <a href="https://www.phpbb.com/community/viewforum.php?f=491">[3.1.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>
 143  
 144      <a name="styles"></a><h3>2.ii. Styles</h3>
 145  
 146      <p>Although we are rather proud of the included styles, we realise that they may not be to everyone's taste. Therefore, phpBB 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>
 147  
 148      <p>For more information about styles, please see: <a href="https://www.phpbb.com/styles/">https://www.phpbb.com/styles/</a></p>
 149  
 150      <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>
 151  
 152      <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; Customise tab -&gt; Style management -&gt; Install Styles</code> where you should see the new style available. Click &quot;Install style&quot; to install the style.</p>
 153  
 154      <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 purge the board cache by clicking the <code>Run now</code> button next to the <code>Purge the cache</code> option in the index page of the Administration Control Panel. You may also need to reload the page you have changed in your web browser to overcome browser caching. If the cache is not purged, you will not see your changes taking effect.</p>
 155  
 156      <a name="extensions"></a><h3>2.iii. Extensions</h3>
 157  
 158      <p>We are proud to have a thriving extensions community. These third party extensions to the standard phpBB software, extend its capabilities still further. You can browse through many of the extensions in the <a href="https://www.phpbb.com/customise/db/extensions-36">Extensions</a> section of our <a href="https://www.phpbb.com/customise/db/">Customisation Database</a>.</p>
 159  
 160      <p>For more information about extensions, please see: <a href="https://www.phpbb.com/extensions">https://www.phpbb.com/extensions</a></p>
 161  
 162      <p><strong>Please remember</strong> that any bugs or other issues that occur after you have added any extension should <strong>NOT</strong> be reported to the bug tracker (see below). First disable the extension and see if the problem is resolved. Any support for an extension should only be sought in the &quot;Discussion/Support&quot; forum for that extension.</p>
 163  
 164      <p>Also remember that any extensions which modify the database in any way, may render upgrading your forum to future versions more difficult.</p>
 165  
 166          </div>
 167  
 168          <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 169  
 170          </div>
 171      </div>
 172  
 173      <hr />
 174  
 175  <a name="help"></a><h2>3. Getting help with phpBB</h2>
 176  
 177      <div class="paragraph">
 178          <div class="inner">
 179  
 180          <div class="content">
 181  
 182      <p>phpBB 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>
 183  
 184      <a name="docs"></a><h3>3.i. phpBB Documentation</h3>
 185  
 186      <p>Comprehensive documentation is now available on the phpBB website:</p>
 187  
 188      <p><a href="https://www.phpbb.com/support/docs/en/3.1/ug/">https://www.phpbb.com/support/docs/en/3.1/ug/</a></p>
 189  
 190      <p>This covers everything from installation to setting permissions and managing users.</p>
 191  
 192      <a name="kb"></a><h3>3.ii. Knowledge Base</h3>
 193  
 194      <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>
 195  
 196      <p><a href="https://www.phpbb.com/kb/">https://www.phpbb.com/kb/</a></p>
 197  
 198      <a name="website"></a><h3>3.iii. Community Forums</h3>
 199  
 200      <p>The phpBB project 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>
 201  
 202      <p><a href="https://www.phpbb.com/community/">https://www.phpbb.com/community/</a></p>
 203  
 204      <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>
 205  
 206      <a name="irc"></a><h3>3.iv Internet Relay Chat</h3>
 207  
 208      <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>
 209  
 210      <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>
 211  
 212          </div>
 213  
 214          <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 215  
 216          </div>
 217      </div>
 218  
 219      <hr />
 220  
 221  <a name="status"></a><h2>4. Status of this version</h2>
 222  
 223      <div class="paragraph">
 224          <div class="inner">
 225  
 226          <div class="content">
 227  
 228      <p>This is a stable release of phpBB. The 3.1.x line is feature frozen, with point releases principally including fixes for bugs and security issues. Feature alterations and minor feature additions may be done if deemed absolutely required. The next major release will be phpBB 3.2 which is currently under development. Please do not post questions asking when 3.2 will be available, no release date has been set.</p>
 229  
 230      <p>Those interested in the development of phpBB should keep an eye on the development forums to see how things are progressing:</p>
 231  
 232      <p><a href="http://area51.phpbb.com/phpBB/">http://area51.phpbb.com/phpBB/</a></p>
 233  
 234      <p>Please note that the development forums should <strong>NOT</strong> be used to seek support for phpBB, the main community forums are the place for this.</p>
 235  
 236          </div>
 237  
 238          <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 239  
 240          </div>
 241      </div>
 242  
 243      <hr />
 244  
 245  <a name="bugs"></a><h2>5. Reporting Bugs</h2>
 246  
 247      <div class="paragraph">
 248          <div class="inner">
 249  
 250          <div class="content">
 251  
 252      <p>The phpBB developers use 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>
 253  
 254      <p><a href="http://tracker.phpbb.com/browse/PHPBB3">http://tracker.phpbb.com/browse/PHPBB3</a></p>
 255  
 256      <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>
 257  
 258      <ul>
 259          <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 phpBB (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>
 260          <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>
 261          <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 phpBB<br /><br /></li>
 262          <li>If no existing bug exists then please feel free to add it</li>
 263      </ul>
 264  
 265      <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>
 266  
 267      <ul>
 268          <li>Your server type/version, e.g. Apache 2.2.3, IIS 7, Sambar, etc.</li>
 269          <li>PHP version and mode of operation, e.g. PHP 5.3.3 as a module, PHP 5.4.0 running as CGI, etc.</li>
 270          <li>DB type/version, e.g. MySQL 5.0.77, PostgreSQL 9.0.6, MSSQL Server 2000 SP1, etc.</li>
 271      </ul>
 272  
 273      <p>The relevant database type/version is listed within the administration control panel.</p>
 274  
 275      <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/phpbb">on GitHub</a>.</p>
 276  
 277      <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.1.x the coding guidelines may be found here: <a href="http://area51.phpbb.com/docs/31x/coding-guidelines.html">http://area51.phpbb.com/docs/31x/coding-guidelines.html</a></p>
 278  
 279      <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>
 280  
 281  <a name="securitybugs"></a><h3>5.i. Security related bugs</h3>
 282  
 283      <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>
 284  
 285      <p><a href="https://www.phpbb.com/security/">https://www.phpbb.com/security/</a></p>
 286  
 287          </div>
 288  
 289          <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 290  
 291          </div>
 292      </div>
 293  
 294      <hr />
 295  
 296  <a name="curbugs"></a><h2>6. Overview of current bug list</h2>
 297  
 298      <div class="paragraph">
 299          <div class="inner">
 300  
 301          <div class="content">
 302  
 303      <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>
 304  
 305      <ul>
 306          <li>Conversions may fail to complete on large boards under some hosts.</li>
 307          <li>Updates may fail to complete on large update sets under some hosts.</li>
 308          <li>Smilies placed directly after bbcode tags will not get parsed. Smilies always need to be separated by spaces.</li>
 309      </ul>
 310  
 311          </div>
 312  
 313          <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 314  
 315          </div>
 316      </div>
 317  
 318      <hr />
 319  
 320  <a name="php"></a><h2>7. PHP compatibility issues</h2>
 321  
 322      <div class="paragraph">
 323          <div class="inner">
 324  
 325          <div class="content">
 326  
 327      <p>phpBB 3.1.x takes advantage of new features added in PHP 5.3. We recommend that you upgrade to the latest stable release of PHP5 to run phpBB. The minimum version required is PHP 5.3.3 and the maximum supported version is any version prior to PHP 7.0.</p>
 328  
 329      <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 phpBB. 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>
 330  
 331      <p>This board has been developed and tested under Linux and Windows (amongst others) running Apache using MySQL 3.23, 4.x, 5.x, MariaDB 5.x, MSSQL Server 2000, PostgreSQL 8.x, Oracle 8, SQLite 2 and SQLite 3. Versions of PHP used range from 5.3.x to 5.4.x without problem.</p>
 332  
 333  <a name="phpsec"></a><h3>7.i. Notice on PHP security issues</h3>
 334  
 335  <p>Currently there are no known issues regarding PHP security.</p>
 336  
 337          </div>
 338  
 339          <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 340  
 341          </div>
 342      </div>
 343  
 344      <hr />
 345  
 346  <a name="disclaimer"></a><h2>8. Copyright and disclaimer</h2>
 347  
 348      <div class="paragraph">
 349          <div class="inner">
 350  
 351          <div class="content">
 352  
 353      <p>phpBB is free software, released under the terms of the <a href="http://opensource.org/licenses/gpl-2.0.php">GNU General Public License, version 2 (GPL-2.0)</a>. Copyright © <a href="https://www.phpbb.com">phpBB Limited</a>. For full copyright and license information, please see the docs/CREDITS.txt file.</p>
 354  
 355          </div>
 356  
 357          <div class="back2top"><a href="#wrap" class="top">Back to Top</a></div>
 358  
 359          </div>
 360      </div>
 361  
 362  <!-- END DOCUMENT -->
 363  
 364      <div id="page-footer">
 365          <div class="version">&nbsp;</div>
 366      </div>
 367  </div></div>
 368  
 369  <div>
 370      <a id="bottom" accesskey="z"></a>
 371  </div>
 372  
 373  </body>
 374  </html>


Generated: Sun Feb 19 19:52:41 2017 Cross-referenced by PHPXref 0.7.1