diff options
| -rw-r--r-- | phpBB/docs/AUTHORS | 4 | ||||
| -rw-r--r-- | phpBB/docs/CHANGELOG.html | 215 | ||||
| -rw-r--r-- | phpBB/docs/FAQ.html | 380 | ||||
| -rw-r--r-- | phpBB/docs/INSTALL.html | 519 | ||||
| -rw-r--r-- | phpBB/docs/README.html | 432 | ||||
| -rw-r--r-- | phpBB/docs/coding-guidelines.html | 89 |
6 files changed, 1584 insertions, 55 deletions
diff --git a/phpBB/docs/AUTHORS b/phpBB/docs/AUTHORS index 24072f19b6..a9f7a89f1f 100644 --- a/phpBB/docs/AUTHORS +++ b/phpBB/docs/AUTHORS @@ -14,13 +14,13 @@ phpBB Project Manager : theFinn (James Atkinson) phpBB Lead Developers : Acyd Burn (Meik Sievertsen) psoTFX (Paul S. Owen) [2001 - 09/2005] -phpBB Developers : Ashe (Ludovic Arnaud) - [10/2002 - 11/2003, 06/2006 - ] - DavidMJ (David M.) +phpBB Developers : DavidMJ (David M.) GrahamJE (Graham Eames) naderman (Nils Adermann) subBlue (Tom Beddard) BartVB (Bart van Bragt) - [11/2000 - 03/2006] + Ashe (Ludovic Arnaud) - [10/2002 - 11/2003, 06/2006 - 10/2006] Original subSilver by subBlue Design, Tom Beddard, (c) 2001 phpBB Group diff --git a/phpBB/docs/CHANGELOG.html b/phpBB/docs/CHANGELOG.html new file mode 100644 index 0000000000..28e8cd63db --- /dev/null +++ b/phpBB/docs/CHANGELOG.html @@ -0,0 +1,215 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<title>phpBB 3.0.x Changelog</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> +<meta http-equiv="Content-Style-Type" content="text/css" /> +<meta name="resource-type" content="document" /> +<meta name="description" lang="en" content="phpBB 3.0.x Changelog" /> +<meta name="keywords" lang="en" content="" /> +<meta name="author" content="phpBB Group" /> +<meta name="copyright" content="phpBB Group" /> +<meta name="MSSmartTagsPreventParsing" content="true" /> + +<style type="text/css"> +<!-- + +/* The original "subSilver" theme for phpBB2 Created by subBlue design :: http://www.subBlue.com */ +body { + background-color: white; + font-family: Verdana, Arial, Helvetica, sans-serif; + margin: 0; + border: 0; + padding: 0; +} + +img { + border: 0; +} + +p { + font-size: 8pt; +} + +hr { + height: 0; + border: solid #D1D7DC 0; + border-top-width: 1px; +} + +#title, h1 { + font: bold 18pt 'Trebuchet MS', Verdana, sans-serif; + text-decoration: none; + line-height: 120%; +} + +h2 { + font: bold 12pt Arial, Helvetica, sans-serif; + text-decoration: none; + line-height: 120%; +} + +h3 { + font: bold 10pt Arial, Helvetica, sans-serif; + text-decoration: none; + line-height: 120%; +} + +.paragraph { + margin-left: 20px; +} + +/* Structure */ +#logo { + background: #fff url(header_bg.jpg) repeat-x top right; + height: 60px; +} + +#title { + color: #12749b; + float: right; + margin: 10px 10px 0; +} + +#main { + margin-left: 25px; + margin-right: 25px; +} + +.good { + color: green; +} + +.bad { + color: red; +} + +#footer { + margin-left: 75px; + font-size: 70%; + color: #006600; +} + +code { + color: #006600; + font-weight: normal; + font-family: 'Courier New', monospace; + border-color: #D1D7DC; + border-width: 1px; + border-style: solid; + background-color: #FAFAFA; +} + +.indent p { + padding-left: 20px; + font-size: 90%; +} + +/* Anchors */ +a { + font-size: 70%; +} + +a:link, a:active, a:visited { + color: #006699; + text-decoration: none; +} + +a:hover { + color: #DD6900; + text-decoration: underline; +} + +a.nav { + color: #006699; + text-decoration: none; +} + +a.nav:hover { + text-decoration: underline; +} + +p a { + font-size: 100%; +} + +.menu { + font-size: 80%; +} + +.menu li a { + font-size: 100%; +} + +.comment { + color: green; +} + +//--> +</style> + +</head> + +<body> + +<div id="logo"> + <div id="title">phpBB 3.0.x Changelog</div> + <img src="header_left.jpg" alt="phpBB Logo" /> +</div> + +<a name="top"></a><div id="main"> + +<!-- BEGIN DOCUMENT --> + +<p>This is a non-exhaustive (but still near complete) changelog for phpBB 3.0.x including release candidate versions. Our thanks to all those people who've contributed bug reports and code fixes.</p> + +<h1>Changelog</h1> + +<ol class="menu"> + <li><a href="#changelog">Changelog</a> + <ol type="i"> + <li><a href="#v30rc1">Changes since RC-1</a></li> + </ol> + </li> + <li><a href="#disclaimer">Copyright and disclaimer</a></li> +</ol> + +<hr /> + +<a name="changelog"></a><h1>1. Changelog</h1> + + <a name="v30rc1"></a><b>1.i. Changes since 3.0.RC1</b> + <br /><br /> + <div class="paragraph"> + + <ul class="menu"> + <li> </li> + </ul> + + </div> + <a href="#top">Top</a> + <br /><br /> + + <hr /> + +<a name="disclaimer"></a><h1>2. Copyright and disclaimer</h1> + + <div class="paragraph"> + + <p>This application is opensource software released under the <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) 2007 <a href="http://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> + +</div> +<a href="#top">Top</a> + +<!-- END DOCUMENT --> + +</div> + +<br /><br /> + +<div id="footer">Note that a full list of fixed bugs can be found at the bug tracker (<a href="README.html#bugs">see section on bug reporting</a>)<br /><br /></div> + +</body> +</html> diff --git a/phpBB/docs/FAQ.html b/phpBB/docs/FAQ.html new file mode 100644 index 0000000000..6a010dc5ec --- /dev/null +++ b/phpBB/docs/FAQ.html @@ -0,0 +1,380 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<title>phpBB 3.0.x FAQ</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> +<meta http-equiv="Content-Style-Type" content="text/css" /> +<meta name="resource-type" content="document" /> +<meta name="description" lang="en" content="phpBB 3.0.x frequently asked questions" /> +<meta name="keywords" lang="en" content="" /> +<meta name="author" content="phpBB Group" /> +<meta name="copyright" content="phpBB Group" /> +<meta name="MSSmartTagsPreventParsing" content="true" /> + +<style type="text/css"> +<!-- + +/* The original "subSilver" theme for phpBB2 Created by subBlue design :: http://www.subBlue.com */ +body { + background-color: white; + font-family: Verdana, Arial, Helvetica, sans-serif; + margin: 0; + border: 0; + padding: 0; +} + +img { + border: 0; +} + +p { + font-size: 8pt; +} + +hr { + height: 0; + border: solid #D1D7DC 0; + border-top-width: 1px; +} + +#title, h1 { + font: bold 18pt 'Trebuchet MS', Verdana, sans-serif; + text-decoration: none; + line-height: 120%; +} + +h2 { + font: bold 12pt Arial, Helvetica, sans-serif; + text-decoration: none; + line-height: 120%; +} + +h3 { + font: bold 10pt Arial, Helvetica, sans-serif; + text-decoration: none; + line-height: 120%; +} + +.paragraph { + margin-left: 20px; +} + +/* Structure */ +#logo { + background: #fff url(header_bg.jpg) repeat-x top right; + height: 60px; +} + +#title { + color: #12749b; + float: right; + margin: 10px 10px 0; +} + +#main { + margin-left: 25px; + margin-right: 25px; +} + +.good { + color: green; +} + +.bad { + color: red; +} + +#footer { + margin-left: 75px; + font-size: 70%; + color: #006600; +} + +code { + color: #006600; + font-weight: normal; + font-family: 'Courier New', monospace; + border-color: #D1D7DC; + border-width: 1px; + border-style: solid; + background-color: #FAFAFA; +} + +.indent p { + padding-left: 20px; + font-size: 90%; +} + +/* Anchors */ +a { + font-size: 70%; +} + +a:link, a:active, a:visited { + color: #006699; + text-decoration: none; +} + +a:hover { + color: #DD6900; + text-decoration: underline; +} + +a.nav { + color: #006699; + text-decoration: none; +} + +a.nav:hover { + text-decoration: underline; +} + +p a { + font-size: 100%; +} + +.menu { + font-size: 80%; +} + +.menu li a { + font-size: 100%; +} + +.comment { + color: green; +} + +//--> +</style> + +</head> + +<body> + +<div id="logo"> + <div id="title">phpBB 3.0.x FAQ</div> + <img src="header_left.jpg" alt="phpBB Logo" /> +</div> + +<a name="top"></a><div id="main"> + +<!-- BEGIN DOCUMENT --> + +<p>This is a very basic Frequently Asked Questions (FAQ) page which attempts to answer some of the more commonly asked questions. It is by no means exhaustive and should be used in combination with the 'built-in' User FAQ within phpBB3, the community forums and our IRC channel (see <a href="README.html">README</a> for details).</p> + +<h1>FAQ</h1> + +<!-- add entry about common UTF8 problems (for example wrong uploading, editing) --> +<ul class="menu"> + <li><a href="#install">I cannot install this it is too difficult! Will you do it?</a></li> + <li><a href="#legal">I am having problems with the admin at a certain board, help!</a></li> + <li><a href="#legal">A board has ripped off my graphics/software/etc., stop them!</a></li> + <li><a href="#legal">A board is dealing in warez/porn/etc., you need to prevent them doing this!</a></li> + <li><a href="#legal">I want to sue you because i think you host an illegal board!</a></li> + <li><a href="#viewonline">According to viewonline a user is doing/reading something they should not be able to!</a></li> + <li><a href="#mail">I keep getting Mail sending errors when I (or my users) post/send PM's/etc.!</a></li> + <li><a href="#mail_language">My users are complaining that emails are not in their selected language!</a></li> + <li><a href="#aol_browser">My AOL based users keep getting logged out!</a></li> + <li><a href="#avatars">No matter what I set the uploadable avatars to I cannot upload one from my computer!</a></li> + <li><a href="#gallery_avatars">I just cannot get gallery avatars to appear!</a></li> + <li><a href="#permissions">How do I use/set permissions?</a></li> + <li><a href="#login_issues">I (or my users) cannot stay logged in to the forum!</a></li> + <li><a href="#logout_issues">My users are complaining about being logged out too quickly!</a></li> + <li><a href="#not_answered">My question isn't answered here!</a></li> + <li><a href="#disclaimer">Copyright and disclaimer</a></li> +</ul> + +<hr /> + +<a name="install"></a><h3>I cannot install this it is too difficult! Will you do it?</h3> + +<div class="paragraph"> + +<p>Simple answer, no we will not. We are not being difficult when we say this we are actually trying to help you. phpBB has a reputation for being easy to install, that reputation is we believe well deserved. It is a simple process of unarchiving a single file, uploading the resulting directory/files to their intended location and entering some data in a web based form. The sequence of events, what to type where, etc. is covered in detail in the accompanying <a href="INSTALL.html">INSTALL.html</a> documentation. If you cannot install phpBB3 the chances are you will be unable to administer or update it.</p> + +<p>There are people, companies (unrelated to your hosting provider), etc. that will install your forum, either for free or for a payment. We do not recommend you make use of these offers. Unless the service is provided by your hosting company you will have to divulge passwords and other sensitive details. If you did not know how to use an ATM would you give a passer-by your bank card and PIN and ask them to show you what to do? No, probably not! The same applies to your hosting account details!</p> + +<p>We think a better solution is for you to carefully read the enclosed documentation, read through our knowledge base at <a href="http://www.phpbb.com/">www.phpbb.com</a> and if necessary ask for help on any thing you get stuck on. However, the decision is yours but please note we may not offer support if we believe you have had the board installed by a third party. In such cases you should direct your questions to that company or person/s.</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="legal"></a> +<h3>I am having problems with the admin at a certain board, help!</h3> +<h3>A board has ripped off my graphics/software/etc., stop them!</h3> +<h3>A board is dealing in warez/porn/etc., you need to prevent them doing this!</h3> +<h3>I want to sue you because i think you host an illegal board!</h3> + +<div class="paragraph"> + +<p>We provide the software, we have absolutely nothing to do with any board that runs it (beyond phpbb.com of course!) and we also do not host any site. The GPL grants the user an unlimited right of use subject to their adherence of that licence. Therefore we cannot prevent, dictate, control or otherwise limit the use of phpBB software. So please do not contact us for such matters.</p> + +<p>If you have a problem with a given board please take it up with them, not us. We are not and cannot be held legally responsible for any third party use of this software (much like Microsoft et al cannot be held responsible for the use of Windows in illegal activities, etc.). Additionally we do <strong>not</strong> track the use of phpBB software in any way. So please do not ask us for details on a "given" board we will not be able to help you. If any law firms or lawyers out there send us writs, cease and desist orders, etc. for third party website use of this software we reserve the right to charge for time wasted dealing with such issues...</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="viewonline"></a><h3>According to viewonline a user is doing/reading something they should not be able to!</h3> + +<div class="paragraph"> + +<p>No, they probably are not. phpBB uses sessions to keep track of users as they move between pages. The session information tells us who this user is. Therefore in order to determine what a user can do on a page we first need the session details. Once this data is available we can check whether the user is permitted to do whatever it is they are trying to do. This can result in it appearing as if a user is reading a topic in a forum they should not be able to access. Or perhaps viewing private messages when they are only guests, etc. In practice the user is not doing these things, they are viewing a "You are not permitted to do this" type message. The session data has simply been updated before we were able to determine what the user could or could not do.</p> + +<p>Of course this only applies where permissions have been set correctly!</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="mail"></a><h3>I keep getting Mail sending errors when I (or my users) post/send PM's/etc.!</h3> + +<div class="paragraph"> + +<p>This error will occur if phpBB cannot send mail. phpBB can send email two ways; using the PHP <code>mail()</code> function or directly via SMTP. Some hosting providers limit the <code>mail()</code> function to prevent its use in spamming, others may rename it or limit its functionality. If the <code>mail()</code> function got renamed, you are able to enter the correct name within the administration control panel. In either case you may need to make use of SMTP. This requires that you have access to such a facility, e.g. your hosting provider may provide one (perhaps requiring specific written authorisation), etc. Please see <a href="http://www.phpbb.com/">www.phpbb.com</a> for additional help on this matter.</p> + +<p>If you do require SMTP services please do not ask (on our forums or elsewhere) for someone to provide you with one. Open relays are now things of the past thanks to the unthinking spammers out there. Therefore you are unlikely to find someone willing to offer you (free) services.</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="mail_language"></a><h3>My users are complaining that emails are not in their selected language!</h3> + +<div class="paragraph"> + +<p>You must have deleted a language pack or the language pack is incomplete. phpBB will try to send emails in the users selected language. If it cannot find a suitable email template it will switch to the boards default language.</p> + +<!-- additional entry about encoded emails --> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="aol_browser"></a><h3>My AOL based users keep getting logged out!</h3> + +<div class="paragraph"> + +<p>phpBB uses sessions to keep track of users as they browse the board. These sessions use a combination of a unique session id, the users IP and if specified the users browser and/or the users x-forwarded-for header to identify each user. We make use of all of this as an extra safe-guard to help prevent sessions being hijacked (by discovering the unique session id).</p> + +<p>Unfortunately this only works when the users IP is constant as they browse the board. For most users this will be the case. However certain providers route their users via a cluster of proxys. In some cases, particularly the AOL browser, this results in different IPs being forwarded as the user moves between pages. We take account of this by not checking the entire IP by default but only the first "three quads" (<samp>A.B.C</samp>). Again in most cases this will be fine. However again AOL uses IPs which can vary so much that checking only the first two quads results in a fairly static IP being available for session validation.</p> + +<p>If you are experiencing problems related to this you can set the Session IP validation parameter found in <code>Admin->General->Server Configuration->Security Settings</code> to <samp>A.B</samp>. Please note that reducing the IP validation length does potentially increase the risk of sessions being hijacked (this is something for you to consider, phpBB Group takes no responsibility should anything happen!). We suggest to at least additionally enable the browser validation.</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="avatars"></a><h3>No matter what I set the uploadable avatars to I cannot upload one from my computer!</h3> + +<div class="paragraph"> + +<p>There are two possibilities here, the first is you have not created the directory you specified as the storage location for avatars, ie. as specified in the <code>Admin -> General -> Board Configuration -> Avatar settings</code> section. If the directory does not exist uploadeable avatars are automatically disabled. You should create the required directory (ensuring it has global write access or other appropriate permissions to allow the webserver to write files to it).</p> + +<p>The second possibility is that your provider has disabled file_upload support. You should contact your provider and ask them if this is the case. There is not a lot you can do, there are still three other avatar settings left to choose from including uploading via an URL which will work fine.</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="gallery_avatars"></a><h3>I just cannot get gallery avatars to appear!</h3> + +<div class="paragraph"> + +<p>phpBB categorises gallery avatars and it does this by reading through folders contained in the location you specified as being the gallery path. For example, if you set the gallery path to <samp>images/avatars/gallery</samp> phpBB will expect to find a series of folders within that path, eg. <samp>images/avatars/gallery/moviestars</samp>, <samp>images/avatars/gallery/cartoons</samp>, <samp>images/avatars/gallery/misc</samp>, etc. Placing images directly in <samp>images/avatars/gallery/</samp> will result in nothing being listed in your gallery.</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="permissions"></a><h3>How do I use/set permissions?</h3> + +<div class="paragraph"> + +<p>Please read our documentation about <a href="#">permissions</a>.</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="login_issues"></a><h3>I (or my users) cannot stay logged in to the forum!</h3> + +<div class="paragraph"> + +<p>If you (or your users) are, after attempting a login, being returned to the index (or other page) without appearing to be logged in the most likely problem is incorrect cookie settings. phpBB uses cookies to store a session id and a small amount of user data. For this data to be stored correctly the cookie domain, name, path and secure settings must be correct. You can check this in <code>Admin->General->Server Configuration->Cookie Settings</code>. Typically the cookie domain can be left blank and the cookie path set to <samp>/</samp> (a single forward slash). Do <strong>not</strong> set the cookie as being secure unless your board is running over a secure sockets layer connection, ie. https://</p> + +<p>If you still have problems try setting the cookie domain to your full domain name, eg. <samp>www.mysystem.tld</samp>, <samp>www.something.mydomain.tld</samp>. You <strong>must</strong> ensure the domain name contains at least two dots or browsers will be unlikely to recognise the cookie, eg. <samp>.mydomain.com</samp>, <samp>mydomain.com</samp>. Do <strong>not</strong> add http:// or anything else to the domain name!</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="logout_issues"></a><h3>My users are complaining about being logged out too quickly!</h3> + +<div class="paragraph"> + +<p>You can increase the default length of sessions (ie. how long before a users session is considered 'dead') in <code>Admin->General->Server Configuration->Load Settings</code>. Set it to whatever value your users feel comfortable with, remember that security issues may affect your decision (ie. having too long a session may allow non-users to abuse your board should a user forget to logout or otherwise leave a current session on a public workstation).</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="not_answered"></a><h3>My question isn't answered here!</h3> + +<div class="paragraph"> + +<p>Please read our <a href="#">extensive user documentation</a> first, it may just explain what you want to know.</p> + +<p>Feel free to search our community forum for the information you require. <strong>PLEASE DO NOT</strong> post your question without having first used search, chances are someone has already asked and answered your question. You can find our board here:</p> + +<p><a href="http://www.phpbb.com">www.phpbb.com</a></p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="disclaimer"></a><h3>Copyright and disclaimer</h3> + +<div class="paragraph"> + + <p>This application is opensource software released under the <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) 2007 <a href="http://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> + +</div> +<a href="#top">Top</a> + +<!-- END DOCUMENT --> + +</div> + +<div id="footer"> <br /><br /></div> + +</body> +</html> diff --git a/phpBB/docs/INSTALL.html b/phpBB/docs/INSTALL.html new file mode 100644 index 0000000000..a1a38497e7 --- /dev/null +++ b/phpBB/docs/INSTALL.html @@ -0,0 +1,519 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<title>phpBB 3.0.x Install</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> +<meta http-equiv="Content-Style-Type" content="text/css" /> +<meta name="resource-type" content="document" /> +<meta name="description" lang="en" content="phpBB 3.0.x Installation, updating and conversion informations" /> +<meta name="keywords" lang="en" content="" /> +<meta name="author" content="phpBB Group" /> +<meta name="copyright" content="phpBB Group" /> +<meta name="MSSmartTagsPreventParsing" content="true" /> + +<style type="text/css"> +<!-- + +/* The original "subSilver" theme for phpBB2 Created by subBlue design :: http://www.subBlue.com */ +body { + background-color: white; + font-family: Verdana, Arial, Helvetica, sans-serif; + margin: 0; + border: 0; + padding: 0; +} + +img { + border: 0; +} + +p { + font-size: 8pt; +} + +hr { + height: 0; + border: solid #D1D7DC 0; + border-top-width: 1px; +} + +#title, h1 { + font: bold 18pt 'Trebuchet MS', Verdana, sans-serif; + text-decoration: none; + line-height: 120%; +} + +h2 { + font: bold 12pt Arial, Helvetica, sans-serif; + text-decoration: none; + line-height: 120%; +} + +h3 { + font: bold 10pt Arial, Helvetica, sans-serif; + text-decoration: none; + line-height: 120%; +} + +.paragraph { + margin-left: 20px; +} + +/* Structure */ +#logo { + background: #fff url(header_bg.jpg) repeat-x top right; + height: 60px; +} + +#title { + color: #12749b; + float: right; + margin: 10px 10px 0; +} + +#main { + margin-left: 25px; + margin-right: 25px; +} + +.good { + color: green; +} + +.bad { + color: red; +} + +#footer { + margin-left: 75px; + font-size: 70%; + color: #006600; +} + +code { + color: #006600; + font-weight: normal; + font-family: 'Courier New', monospace; + border-color: #D1D7DC; + border-width: 1px; + border-style: solid; + background-color: #FAFAFA; +} + +.indent p { + padding-left: 20px; + font-size: 90%; +} + +/* Anchors */ +a { + font-size: 70%; +} + +a:link, a:active, a:visited { + color: #006699; + text-decoration: none; +} + +a:hover { + color: #DD6900; + text-decoration: underline; +} + +a.nav { + color: #006699; + text-decoration: none; +} + +a.nav:hover { + text-decoration: underline; +} + +p a { + font-size: 100%; +} + +.menu { + font-size: 80%; +} + +.menu li a { + font-size: 100%; +} + +.comment { + color: green; +} + +//--> +</style> + +</head> + +<body> + +<div id="logo"> + <div id="title">phpBB 3.0.x Install</div> + <img src="header_left.jpg" alt="phpBB Logo" /> +</div> + +<a name="top"></a><div id="main"> + +<!-- BEGIN DOCUMENT --> + +<p><strong>Please read this document completely before proceeding with installation, updating or converting.</strong></p> + +<p>Please note these instructions are not fully comprehensive, a more thorough userguide will be available on the phpBB website in the near future. However, this document will walk you through the basics on installing, updating and converting the forum software.</p> + +<p>A basic overview of running phpBB3 can be found in the accompanying <a href="README.html">README</a> documentation. Please ensure you read that document in addition to this! For more detailed information on using phpBB3 you should read <a href="http://www.phpbb.com/support/documentation/">the documentation</a> available online.</p> + +<h1>Install</h1> + +<ol class="menu"> + <li><a href="#quickinstall">Quick install</a></li> + <li><a href="#require">Requirements</a></li> + <li><a href="#install">New installation</a></li> + <li><a href="#update">Updating from stable releases of phpBB 3.0.x</a> + <ol type="i"> + <li><a href="#update_full">Full package</a></li> + <li><a href="#update_files">Changed files only</a></li> + <li><a href="#update_patch">Patch file</a></li> + <li><a href="#update_auto">Automatic update package</a></li> + <li><a href="#update_all">All package types</a></li> + </ol> + </li> + <li><a href="#convert">Conversion from phpBB 2.0.x to phpBB 3.0.x</a> + <ol type="i"> + <li><a href="#prereq">Requirements before converting</a></li> + <li><a href="#conversion">Converting</a></li> + <li><a href="#postreq">Things to do after conversion</a></li> + </ol> + </li> + <li><a href="#postinstall">Important (security related) post-Install tasks for all installation methods</a> + <ol type="i"> + <li><a href="#avatars">Uploadable avatars</a></li> + </ol> + </li> + <li><a href="#disclaimer">Disclaimer</a></li> +</ol> + +<hr /> + +<a name="quickinstall"></a><h1>1. Quick install</h1> + +<div class="paragraph"> + <p>If you have basic knowledge of using FTP and are sure your hosting service or server will run phpBB3 you can use these steps to quickly get started. For a more detailed explanation you should skip this and go to <a href="#require">section 2</a> below.</p> + + <ol class="menu"> + <li>Decompress the phpBB3 archive to a local directory on your system.</li> + <li>Upload all the files contained in this archive (retaining the directory structure) to a web accessible directory on your server or hosting account.</li> + <li>Change the permissions on config.php to be writeable by all (666 or -rw-rw-rw- within your FTP Client)</li> + <li>Change the permissions on the following directories to be writeable by all (777 or -rwxrwxrwx within your FTP Client):<br /> + <code>store/</code>, <code>cache/</code>, <code>files/</code> and <code>images/avatars/upload/</code>.</li> + <li>Using your web browser visit the location you placed phpBB3 with the addition of install/index.php or pointing directly to install/, e.g. http://www.mydomain.com/phpBB2/install/, http://www.mydomain.com/forum/install/ etc.</li> + <li>Click the <em>INSTALL</em> tab, follow the steps and fill out all the requested information.</li> + <li>Change the permissions on config.php to be writeable only by yourself (644 or -rw-r--r-- within your FTP Client)</li> + <li>phpBB3 should now be available, please <strong>MAKE SURE</strong> you read at least <a href="#postinstall">Section 6</a> below for important, security related post-installation instructions.</li> + </ol> + + <p>If you experienced problems or do not know how to proceed with any of the steps above please read the rest of this document.</p> +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="require"></a><h1>2. Requirements</h1> + +<div class="paragraph"> + <p>phpBB3 has a few requirements which must be met before you are able to install and use it.</p> + + <ul class="menu"> + <li>A webserver or web hosting account running on any major Operating System with support for PHP</li> + <li>A SQL database system, <strong>one of</strong>: + <ul> + <li>MySQL 3.23 or above (MySQLi supported)</li> + <li>PostgreSQL 7.3+</li> + <li>SQLite 2.8.2+</li> + <li>Firebird 2.0</li> + <li>MS SQL Server 2000 or above (directly or via ODBC)</li> + <li>Oracle</li> + </ul> + </li> + <li><strong>PHP 4.3.3</strong> or above with support for the database you intend to use.</li> + <li>These optional presence of the following modules within PHP will provide access to additional features, but they are not required. + <ul> + <li>zlib Compression support</li> + <li>Remote FTP support</li> + <li>XML support</li> + <li>Imagemagick support</li> + <li>GD Support</li> + </ul> + </li> + </ul> + + <p>If your server or hosting account does not meet the requirements above we are afraid phpBB3 is not for you.</p> +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="install"></a><h1>3. New installation</h1> + +<div class="paragraph"> + + <p>Installation of phpBB3 will vary according to your server and database. If you have <em>shell access</em> to your account (via telnet or ssh for example) you may want to upload the entire phpBB3 archive (in binary mode!) to a directory on your host and unarchive it there.</p> + + <p>If you do not have shell access or do not wish to use it you will need to decompress the phpBB3 archive to a local directory on your system using your favourite compression program, e.g. winzip, rar, zip, etc. From there you must FTP <strong>ALL</strong> the files it contains (being sure to retain the directory structure and filenames) to your host. Please ensure that the cases of filenames are retained, do <strong>NOT</strong> force filenames to all lower or upper case doing so will cause errors later.</p> + + <p>All .php, .inc, .sql, .cfg, .html and .txt files should be uploaded in <strong>ASCII</strong> mode, while all graphics should be uploaded in <strong>BINARY</strong> mode. If you are unfamiliar with what this means please refer to your FTP client documentation. In most cases this is all handled transparantly by your ftp client but if you encounter problems later you should be sure the files where uploaded correctly as described here.</p> + + <p>phpBB3 comes supplied with english as its standard language. However a number of seperate packs for different languages are available. If you are not a native english speaker you may wish to install one or more of these packages before continuing. The installation process below will allow you to select a default language from those available (you can of course change this default at a later stage). For more details of language packs, where to obtain them and how to install them please see the <a href="README.html#i18n">README</a>.</p> + + <p>Once all the files have been uploaded to your site you should point your browser at this location with the addition of <code>install/</code>. For example if your domain name is <em>www.mydomain.tld</em> and you placed phpBB3 in a directory /phpBB3 off your web root you would enter <em>http://www.mydomain.tld/phpBB3/install/</em> or (alternatively) <em>http://www.mydomain.tld/phpBB3/install/index.php</em> into your browser. When you have done this you should see the phpBB3 Installation screen appear.</p> + + <h3>Introduction:</h3> + + <p>The installation screen gives you a short introduction into phpBB. It allows you to read the license phpBB3 is released under (General Public License) and provides information about how you can receive support. To start the installation, use the <em>Install</em> button.</p> + + <h3>Requirements</h3> + + <p>The first page you will see after starting the installation is the Requirements list. phpBB3 checks automatically whether everything that it needs to run properly is installed on your server. You need to have at least the minimum PHP version installed, and at least one database available to continue the installation. Also important, is that all shown folders are available and do have the correct permissions. Please see the description of each section to find out whether they are optional or required for phpBB3 to run. If everything is in order, you can continue the installation with <em>Start Install</em>.</p> + + <h3>Database settings</h3> + + <p>You now have to decide which database to use. See the <a href="#require">Requirements section</a> for information on which databases are supported. If you do not know your database settings, please contact your host and ask for them. You will not be able to continue without them. You need:</p> + + <ul class="menu"> + <li>The Database Type - the database you will be using.</li> + <li>The Database server hostname or DSN - the address of the database server.</li> + <li>The Database server port - the port of the database server (most of the time this is not needed).</li> + <li>The Database name - the name of the database on the server.</li> + <li>The Database username and Database password - the login data to access the database.</li> + </ul> + + <div class="indent"> + <p><strong>Note:</strong> if you are installing using SQLite, you should enter the full path to your database file in the DSN field and leave the username and password fields blank. For security reasons, you should make sure that the database file is not stored in a location accessible from the web.</p> + </div> + + <p>You don't need to change the Prefix for tables in database setting, unless you plan on using multipe phpBB installations on one database. In this case you can use a different prefix for each installation to make it work.</p> + + <p>After you entered your details, you can continue with the Proceed to next step button. Now phpBB3 will check whether the data you entered will lead to a successful database connection and whether tables with the same prefix already exist.</p> + + <p>A <em>Could not connect to the database</em> error means that you didn't enter the database data correctly and it is not possible for phpBB to connect. Make sure that everything you entered is in order and try again. Again, if you are unsure about your database settings, please contact your host.</p> + + <p>If you installed another version of phpBB before on the same database with the same prefix, phpBB will inform you and you just need to enter a different database prefix.</p> + + <p>If you see the Successful Connection message, you can continue to the next step.</p> + + <h3>Administrator details</h3> + + <p>Now you have to create your administration user. This user will have full administration access and he will be the first user on your forum. All fields on this page are required. You can also set the default language of your forum on this page. In a vanilla phpBB3 installation we only include English [GB]. You can download further languages from <a href="http://www.phpbb.com/">www.phpbb.com</a>, and add them before installing or later.</p> + + <h3>Configuration file</h3> + + <p>In this step, phpBB will try to write the configuration file automatically. The forum needs the configuration to run properly. It contains all database settings, so without it, phpBB will not be able to access the database.</p> + + <p>Usually writing the configuration file automatically works fine. But in some cases it can fail due to wrong file permissions, for instance. In this case, you need to upload the file manually. phpBB asks you to download the config.php file and tells you what to do with it. Please read the instructions carefully. After you have uploaded the file, use <em>Done</em> to get to the last step. If <em>Done</em> returns you to the same page as before, and does not return a success message, you did not upload the file correctly.</p> + + <h3>Advanced settings</h3> + + <p>The Advanced settings allow you to set some parameters of the board configuration. They are optional, and you can always change them later. So if you are not sure what these settings mean, proceed to the final step and finish the installation.</p> + + <p>If the installation was successful, you can now use the Login button to visit the Administration Control Panel. Congratulations, you have installed phpBB3 successfully. But there is still work ahead!</p> + + <p>If you are unable to get phpBB3 installed even after reading this guide, please look at the support section to find out where you can ask for further assistance.</p> + + <p>At this point if you are upgrading from phpBB 2.0.x, you should refer to the <a href="#convert">conversion steps</a> for further information. If not, you should remove the install directory from your server as you will only be able to access the Administration Control Panel whilst it is present.</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="update"></a><h1>4. Updating from stable releases of phpBB 3.0.x</h1> + +<p>If you are currently using a stable release of phpBB3 updating to this version is straightforward. You would have downloaded one of four packages and your choice determines what you need to do. <strong>Please Note</strong>: That before updating we heavily recommend you do a <em>full backup of your database and existing phpBB3 files</em>! If you are unsure how to achieve this please ask your hosting provider for advice.</p> + +<p><strong>Please make sure you update your phpBB3 source files too, even if you run the <code>database_update.php</code> file.</strong></p> + +<a name="update_full"></a><b>4.i. Full package</b> +<br /><br /> +<div class="paragraph"> + + <p>The full package is normally meant for new installations, but if you want to replace all source files this package comes in handy.</p> + + <p>First you should make a copy of your existing <em>config.php</em> file, keep it in a safe place! Next delete all the existing phpBB3 files, you may want to leave your <code>files/</code> and <code>images/</code> directory in place. You can leave alternative styles in-place too. With this complete you can upload the new phpBB3 files (see <a href="#install">New installation</a> for details if necessary). Once complete copy back your saved <em>config.php</em>, replacing the new one. Another method is to just <strong>replace</strong> the existing files with the files from the full package - though make sure you do <strong>not</strong> overwrite your config.php file.</p> + + <p>You should now run <code>install/database_update.php</code> which, depending on your previous version, will make a number of database changes. You may receive <em>FAILURES</em> during this procedure, they should not be a cause for concern unless you see an actual <em>ERROR</em>, in which case the script will stop (in this case you should seek help via our forums or bug tracker).</p> + + <p>Once the install/database_update.php has completed you may proceed to the Administration Control Panel and check remove the install directory as advised.</p> +</div> +<a href="#top">Top</a> +<br /><br /> + +<a name="update_files"></a><b>4.ii. Changed files only</b> +<br /><br /> +<div class="paragraph"> + + <p>This package contains a number of archives, each contains the files changed from a given release to the latest version. You should select the appropriate archive for your current version, e.g. if you currently have <samp>3.0.0</samp> you should select the phpBB-3.0.0_to_3.0.1.zip/tar.gz file.</p> + + <p>The directory structure has been preserved enabling you (if you wish) to simply upload the contents of the archive to the appropriate location on your server, i.e. simply overwrite the existing files with the new versions. Do not forget that if you have installed any Mods these files will overwrite the originals possibly destroying them in the process. You will need to re-add Mods to any affected file before uploading.</p> + + <p>As for the other update procedures you should run <b>install/database_update.php</b> after you have finished updating the files. This will update your database schema and increment the version number.</p> +</div> +<a href="#top">Top</a> +<br /><br /> + +<a name="update_patch"></a><b>4.iii. Patch file</b> +<br /><br /> + +<div class="paragraph"> + + <p>The patch file is probably the best solution for those with many Mods or other changes who do not want to re-add them back to all the changed files. To use this you will need command line access to a standard UNIX type <strong>patch</strong> application. If you do not have access to such an application but still want to use this update approach we recommend the <a href="update_auto">Automatic update package</a> explained below.</p> + + <p>A number of patch files are provided to allow you to update from previous stable releases. Select the correct patch, e.g. if your current version is 3.0.0 you need the phpBB-3.0.0_to_3.0.1.patch file. Place the correct patch in the parent directory containing the phpBB3 core files (i.e. index.php, viewforum.php, etc.). With this done you should run the following command: <strong>patch -cl -d [PHPBB DIRECTORY] -p1 < [PATCH NAME]</strong> (where PHPBB DIRECTORY is the directory name your phpBB Installation resides in, for example phpBB3, and where PATCH NAME is the relevant filename of the selected patch file). This should complete quickly, hopefully without any HUNK FAILED comments.</p> + + <p>If you do get failures you should look at using the <a href="#update_files">Changed files only</a> package to replace the files which failed to patch, please note that you will need to manually re-add any Mods to these particular files. Alternatively if you know how you can examine the .rej files to determine what failed where and make manual adjustments to the relevant source.</p> + + <p>You should of course delete the patch file (or files) after use. As for the other update procedures you should run <code>install/database_update.php</code> after you have finished updating the files. This will update your database schema and data (if appropriate) and increment the version number.</p> +</div> +<a href="#top">Top</a> +<br /><br /> + +<a name="update_auto"></a><b>4.iv. Automatic update package</b> +<br /><br /> + +<div class="paragraph"> + + <p>The automatic update package is holding - contrary to the others - only the update informations for updating the last released version to the latest available version. These package is meant for use with the automatic update tool.</p> + + <p>To perform the update, either follow the instructions from the <code>Administration Control Panel -> System</code> Tab - this should point out that you are running an outdated version and will guide you through the update - or following the instructions listed below.</p> + + <ul class="menu"> + <li>Go to the <a href="http://www.phpbb.com/downloads/">downloads page</a> and download the latest update package listed there.</li> + <li>Upload the archives contents to your phpBB installation - only the install folder is required. Upload the whole install folder, retaining the file structure.</li> + <li>After the install folder is present, phpBB3 will go offline automatically.</li> + <li>Point your browser to the install directory, for example <samp>http://www.example.com/phpBB3/install/</samp></li> + <li>Choose the "Update" Tab and follow the instructions</li> + </ul> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<a name="update_all"></a><b>4.v. All package types</b> +<br /><br /> + +<div class="paragraph"> + + <p>If you have non-English language packs installed you may want to see if a new version has been made available. A number of missing strings may have been added which, though not essential, may be beneficial to users. Please note that at this time not all language packs have been updated so you should be prepared to periodically check for updates.</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="convert"></a><h1>5. Conversion from phpBB 2.0.x to phpBB 3.0.x</h1> + +<p>This paragraph explains the steps necessary to convert your existing phpBB2 installation to phpBB3.</p> + +<a name="prereq"></a><b>5.i. Requirements before converting</b> +<br /><br /> + +<div class="paragraph"> + <p>Before converting we heavily recommend you do a <em>full backup of your database and files</em>! If you are unsure how to achieve this please ask your hosting provider for advice. In order to convert, you need to have a new phpBB3 installation within the same database (but with a different prefix) as your old 2.0.x installation. You basically need to follow the basic instructions given for <a href="#install">New installations</a>. Please <strong>do not</strong> overwrite any old files - install phpBB3 at a different location.</p> + + <p>Once you made a backup of everything and also have a brand new phpBB3 installation, you can now begin the conversion.</p> +</div> +<a href="#top">Top</a> +<br /><br /> + +<a name="conversion"></a><b>5.ii. Converting</b> +<br /><br /> + +<div class="paragraph"> + + <p>To begin the conversion visit the install folder of your phpBB3 installation (the same as you have done for installing). Now you will see a new tab <em>Convert</em>. Click this tab.</p> + + <p>As with install the conversion is automated. Your previous 2.0.x database tables will not be touched as well as the original 2.0.x files remaining untouched. The conversion is actually only filling your phpBB3 database tables and copying additional data over to your phpBB3 installation. This has the benefit that if something goes wrong you are able to either re-run the conversion or continue a conversion, while your old board is still accessible. We really recommend you disable your old installation while converting, else you may have inconsistent data after the conversion.</p> + + <p>Please note that this conversion process may take quite some time and depending on your hosting provider this may result in it failing (due to web server or other timeout issues). If this is the case you should ask your provider if they are willing to allow the convert script to temporarily exceed their limits (be nice and they will probably be quite helpful).</p> + + <p>Once completed your board should be immediately available. If you encountered errors you should report the problems to our bug tracker or seek help via our forums (see <a href="README.html">README</a> for details).</p> +</div> +<a href="#top">Top</a> +<br /><br /> + +<a name="postreq"></a><b>5.iii. Things to do after conversion</b> +<br /><br /> + +<div class="paragraph"> + + <p>After successful conversion there may be a few items you need to do - apart from checking if the installation is accessible and everything displayed correctly.</p> + + <p>The first thing you may want to do is going to the administration control panel and checking every configuration item within the general tab. Thereafter you may want to adjust the forum descriptions/names if you entered HTML there. You also may want to access the other administrative sections, e.g. adjusting permissions, smilies, icons, ranks, etc.</p> + + <p>Within the conversion the search index has not been created or transferred. This means after conversion you are not able to find any matches if you want to search for something. We recommend you rebuild your search index within <code>Admin -> Maintenance -> Database -> Search Index</code>.</p> + + <p>Once you are pleased with your new installation you may want to give it the name of your old installation, changing the directory name. With phpBB3 this is possible without any problems - but you may still want to check your cookie settings within the administration panel, if the cookie path need to be adjusted prior to renaming.</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="postinstall"></a><h1>6. Important (security related) post-Install tasks for all installation methods</h1> + +<div class="paragraph"> + + <p>Once you have succssfully installed phpBB3 you <strong>MUST</strong> ensure you remove the entire install/ directory. Leaving the install directory in place is a <em>very serious potential security issue</em> which may lead to deletion or alteration of files, etc. Please note that until this directory is not removed phpBB3 will not operate and a warning message will be displayed. Beyond this <strong>essential</strong> deletion you may also wish to delete the docs/ directories if you wish.</p> + + <p>With these directories deleted you should proceed to the administration panel. Depending on how the installation completed you may have been directed there automatically. If not, login as the administrator you specified during install/conversion and click the <strong>Administration Panel</strong> link at the bottom of any page. Ensure that details specified in <code>Admin -> General</code> are correct!</p> +</div> +<a href="#top">Top</a> +<br /><br /> + +<a name="avatars"></a><b>6.i. Uploadable avatars</b> +<br /><br /> +<div class="paragraph"> + + <p>phpBB3 supports several methods for allowing users to select their own <em>avatar</em> (an avatar is a small image generally unique to a user and displayed just below their username in posts).</p> + + <p>Two of these options allow users to upload an avatar from their machine or a remote location (via a URL). If you wish to enable this function you should first ensure the correct paths for uploadeable avatars is set in <code>Admin -> General -> Board Configuration -> Avatar settings</code>. By default this is <em>images/avatars/uploads</em> but you can set it to whatever you like, just ensure the configuration setting is updated. You must also ensure this directory can be written to by the webserver. Usually this means you have to alter its permissions to allow anyone to read and write to. Exactly how you should do this depends on your ftp client or server operating system.</p> + + <p>On UNIX systems for example you set the directory to a+rwx (or ugo+rwx or even 777). This can be done from a command line on your server using chmod or via your FTP client (using the Change Permissions, chmod or other Permissions dialoge box, see your FTP clients documentation for help). Most FTP clients list permissions in the form of User (Read, Write, Execute), Group (Read, Write, Execute) and Other (Read, Write, Execute). You need to tick all of these boxes to set correct permissions.</p> + + <p>On Windows system you need to ensure the directory is not write-protected and that it has global write permissions (see your servers documentation or contact your hosting provider if you are unsure on how to achieve this).</p> + + <p>Please be aware that setting a directories permissions to global write access is a potential security issue. While it is unlikely that anything nasty will occur (such as all the avatars being deleted) there are always people out there to cause trouble. Therefore you should monitor this directory and if possible make regular backups.</p> +</div> + +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="disclaimer"></a><h1>7. Copyright and disclaimer</h1> + + <div class="paragraph"> + + <p>This application is opensource software released under the <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) 2007 <a href="http://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> + +</div> +<a href="#top">Top</a> + +<!-- END DOCUMENT --> + +</div> + +<div id="footer"> <br /><br /></div> + +</body> +</html> diff --git a/phpBB/docs/README.html b/phpBB/docs/README.html new file mode 100644 index 0000000000..ac455be387 --- /dev/null +++ b/phpBB/docs/README.html @@ -0,0 +1,432 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<title>phpBB 3.0.x Readme</title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> +<meta http-equiv="Content-Style-Type" content="text/css" /> +<meta name="resource-type" content="document" /> +<meta name="description" lang="en" content="phpBB 3.0.x Readme" /> +<meta name="keywords" lang="en" content="" /> +<meta name="author" content="phpBB Group" /> +<meta name="copyright" content="phpBB Group" /> +<meta name="MSSmartTagsPreventParsing" content="true" /> + +<style type="text/css"> +<!-- + +/* The original "subSilver" theme for phpBB2 Created by subBlue design :: http://www.subBlue.com */ +body { + background-color: white; + font-family: Verdana, Arial, Helvetica, sans-serif; + margin: 0; + border: 0; + padding: 0; +} + +img { + border: 0; +} + +p { + font-size: 8pt; +} + +hr { + height: 0; + border: solid #D1D7DC 0; + border-top-width: 1px; +} + +#title, h1 { + font: bold 18pt 'Trebuchet MS', Verdana, sans-serif; + text-decoration: none; + line-height: 120%; +} + +h2 { + font: bold 12pt Arial, Helvetica, sans-serif; + text-decoration: none; + line-height: 120%; +} + +h3 { + font: bold 10pt Arial, Helvetica, sans-serif; + text-decoration: none; + line-height: 120%; +} + +.paragraph { + margin-left: 20px; +} + +/* Structure */ +#logo { + background: #fff url(header_bg.jpg) repeat-x top right; + height: 60px; +} + +#title { + color: #12749b; + float: right; + margin: 10px 10px 0; +} + +#main { + margin-left: 25px; + margin-right: 25px; +} + +.good { + color: green; +} + +.bad { + color: red; +} + +#footer { + margin-left: 75px; + font-size: 70%; + color: #006600; +} + +code { + color: #006600; + font-weight: normal; + font-family: 'Courier New', monospace; + border-color: #D1D7DC; + border-width: 1px; + border-style: solid; + background-color: #FAFAFA; +} + +.indent p { + padding-left: 20px; + font-size: 90%; +} + +/* Anchors */ +a { + font-size: 70%; +} + +a:link, a:active, a:visited { + color: #006699; + text-decoration: none; +} + +a:hover { + color: #DD6900; + text-decoration: underline; +} + +a.nav { + color: #006699; + text-decoration: none; +} + +a.nav:hover { + text-decoration: underline; +} + +p a { + font-size: 100%; +} + +.menu { + font-size: 80%; +} + +.menu li a { + font-size: 100%; +} + +.comment { + color: green; +} + +//--> +</style> + +</head> + +<body> + +<div id="logo"> + <div id="title">phpBB 3.0.x Readme</div> + <img src="header_left.jpg" alt="phpBB Logo" /> +</div> + +<a name="top"></a><div id="main"> + +<!-- BEGIN DOCUMENT --> + +<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> + +<h1>Readme</h1> + +<ol class="menu"> + <li><a href="#install">Installing phpBB3</a></li> + <li><a href="#run">Running phpBB3</a> + <ol type="i"> + <li><a href="#i18n">Internationalisation (i18n)</a></li> + <li><a href="#styles">Styles</a></li> + <li><a href="#mods">Mods</a></li> + </ol> + </li> + <li><a href="#help">Getting help with phpBB3</a> + <ol type="i"> + <li><a href="#userguide">Userguide</a></li> + <li><a href="#website">Community Forums</a></li> + <li><a href="#irc">Internet Relay Chat</a></li> + </ol> + </li> + <li><a href="#status">Status of this version</a></li> + <li><a href="#bugs">Reporting Bugs</a> + <ol type="i"> + <li><a href="#securitybugs">Security related bugs</a></li> + </ol> + </li> + <li><a href="#curbugs">Overview of current bug list</a></li> + <li><a href="#php">PHP compatibility issues</a></li> + <li><a href="#disclaimer">Disclaimer</a></li> +</ol> + +<hr /> + +<a name="install"></a><h1>1. Installing phpBB3</h1> + +<div class="paragraph"> + + <p>Installation and update/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> + + <p>Users of phpBB3 Beta versions cannot directly update or convert.</p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="run"></a><h1>2. Running phpBB3</h1> + + <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> + + <a name="i18n"></a><b>2.i. Internationalisation (i18n)</b> + <br /><br /> + <div class="paragraph"> + + <p>A number of language packs and style localisations are available. You can find them on our official download page:</p> + + <p><a href="http://www.phpbb.com/downloads/">http://www.phpbb.com/downloads/</a></p> + + <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> + + <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 image packs you should unarchive the file/s into the styles/subSilver/imageset directory, again you must retain the directory structure. Once installed the languages will become immediately available.</p> + + <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> + + </div> + <a href="#top">Top</a> + <br /><br /> + + <a name="styles"></a><b>2.ii. Styles</b> + <br /><br /> + <div class="paragraph"> + + <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> + + <p><a href="http://www.phpbb.com/styles/">http://www.phpbb.com/styles/</a></p> + + <p><strong>Please note</strong> that 3rd party styles downloaded for versions of phpBB2 will <strong>not</strong> work in phpBB3.</p> + + <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> + + </div> + <a href="#top">Top</a> + <br /><br /> + + <a name="mods"></a><b>2.iii. Mods</b> + <br /><br /> + <div class="paragraph"> + + <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> + + <p><a href="http://www.phpbb.com/mods">http://www.phpbb.com/mods</a></p> + + <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> + + <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> + + </div> + <a href="#top">Top</a> + <br /><br /> + +<hr /> + +<a name="help"></a><h1>3. Getting help with phpBB3</h1> + + <p>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 <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> + + <a name="userguide"></a><b>3.i. phpBB3 Userguide</b> + <br /><br /> + <div class="paragraph"> + + <p>A comprehensive userguide is now available online and can be accessed from the following location:</p> + + <p><a href="http://www.phpbb.com/support/documentation/">http://www.phpbb.com/support/documentation/</a></p> + + <p>This covers everything from installation through setting permissions and managing users.</p> + + </div> + <a href="#top">Top</a> + <br /><br /> + + <a name="website"></a><b>3.ii. Community Forums</b> + <br /><br /> + + <div class="paragraph"> + + <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> + + <p><a href="http://www.phpbb.com/">http://www.phpbb.com/</a></p> + + <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> + + </div> + <a href="#top">Top</a> + <br /><br /> + + <a name="irc"></a><b>3.iii Internet Relay Chat</b> + <br /><br /> + <div class="paragraph"> + + <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> + + </div> + <a href="#top">Top</a> + <br /><br /> + +<hr /> + +<a name="status"></a><h1>4. Status of this version</h1> + +<div class="paragraph"> + <p>This is the third stable release of phpBB. The 3.0.x line is essentially feature frozen, point releases will see only bugs and such like fixed, though feature alterations and minor feature additions may be done. 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> + + <p>For those interested in the development of phpBB should keep an eye on the community forums to see how things are progressing:</p> + + <p><a href="http://area51.phpbb.com/">http://area51.phpbb.com/phpBB/</a></p> + + <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> +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="bugs"></a><h1>5. Reporting Bugs</h1> + +<div class="paragraph"> + <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> + + <p><a href="http://www.phpbb.com/bugs/">http://www.phpbb.com/bugs/</a></p> + + <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> + + <ul class="menu"> + <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> + <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> + <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> + <li>If no existing bug exists then please feel free to add it</li> + </ul> + + <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> + + <ul class="menu"> + <li>Your server type/version, eg. Apache 1.3.28, IIS 4, Sambar, etc.</li> + <li>PHP version and mode of operation, eg. PHP 5.1.1 as a module, PHP 4.4.4 running as CGI, etc.</li> + <li>DB type/version, eg. MySQL 4.0.1, PostgreSQL 7.3.2, MSSQL Server 2000 SP1, etc.</li> + </ul> + + <p>The relevant database type/version is listed within the administration control panel</p> + + <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> + + <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> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<a name="securitybugs"></a><b>5.i. Security related bugs</b> +<br /><br /> +<div class="paragraph"> + <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> + + <p><a href="http://www.phpbb.com/security/">http://www.phpbb.com/security/</a></p> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="curbugs"></a><h1>6. Overview of current bug list</h1> + +<div class="paragraph"> + <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/upgrade.</p> + + <ul class="menu"> + <li>By default cannot post very large messages with MSSQL (this can be configured within MSSQL)</li> + <li>Conversions may fail to complete on large boards under some hosts</li> + </ul> + +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="php"></a><h1>7. PHP compatibility issues</h1> + +<div class="paragraph"> + <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> + + <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> + + <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> +</div> +<a href="#top">Top</a> +<br /><br /> + +<a name="phpsec"></a><b>7.i. Notice on PHP security issues</b> + +<br /><br /> +<div class="paragraph"> +<p>Currently there are no known issues regarding PHP security.</p> +</div> +<a href="#top">Top</a> +<br /><br /> + +<hr /> + +<a name="disclaimer"></a><h1>8. Copyright and disclaimer</h1> + + <div class="paragraph"> + + <p>This application is opensource software released under the <a href="http://www.gnu.org/licenses/gpl.html">GPL</a>. Please see source code and the docs directory for more details. This package and its contents are Copyright (c) 2007 <a href="http://www.phpbb.com/">phpBB Group</a>, All Rights Reserved.</p> + +</div> +<a href="#top">Top</a> + +<!-- END DOCUMENT --> + +</div> + +<div id="footer"> <br /><br /></div> + +</body> +</html> diff --git a/phpBB/docs/coding-guidelines.html b/phpBB/docs/coding-guidelines.html index 69e51a1059..33b2bb6b8d 100644 --- a/phpBB/docs/coding-guidelines.html +++ b/phpBB/docs/coding-guidelines.html @@ -16,17 +16,13 @@ <style type="text/css"> <!-- -/* - The original "subSilver" theme for phpBB2 - Created by subBlue design :: http://www.subBlue.com -*/ - +/* The original "subSilver" theme for phpBB2 Created by subBlue design :: http://www.subBlue.com */ body { - background-color: white; - font-family: Verdana, Arial, Helvetica, sans-serif; - margin: 0px; - border: 0px; - padding: 0px; + background-color: white; + font-family: Verdana, Arial, Helvetica, sans-serif; + margin: 0; + border: 0; + padding: 0; } img { @@ -34,40 +30,38 @@ img { } p { - font-size: 8pt; + font-size: 8pt; } hr { - height: 0px; - border: solid #D1D7DC 0px; + height: 0; + border: solid #D1D7DC 0; border-top-width: 1px; } #title, h1 { font: bold 18pt 'Trebuchet MS', Verdana, sans-serif; - text-decoration: none; - line-height: 120%; + text-decoration: none; + line-height: 120%; } h2 { font: bold 12pt Arial, Helvetica, sans-serif; - text-decoration: none; - line-height: 120%; + text-decoration: none; + line-height: 120%; } h3 { font: bold 10pt Arial, Helvetica, sans-serif; - text-decoration: none; - line-height: 120%; + text-decoration: none; + line-height: 120%; } .paragraph { margin-left: 20px; } -/* - Structure -*/ +/* Structure */ #logo { background: #fff url(header_bg.jpg) repeat-x top right; height: 60px; @@ -98,14 +92,14 @@ h3 { color: #006600; } -code { +code { color: #006600; - font-weight: normal; - font-family: 'Courier New', monospace; - border-color: #D1D7DC; - border-width: 1px; - border-style: solid; - background-color: #FAFAFA; + font-weight: normal; + font-family: 'Courier New', monospace; + border-color: #D1D7DC; + border-width: 1px; + border-style: solid; + background-color: #FAFAFA; } .indent p { @@ -113,30 +107,28 @@ code { font-size: 90%; } -/* - Anchors -*/ +/* Anchors */ a { font-size: 70%; } a:link, a:active, a:visited { color: #006699; - text-decoration: none; + text-decoration: none; } a:hover { - color: #DD6900; - text-decoration: underline; + color: #DD6900; + text-decoration: underline; } a.nav { - color: #006699; - text-decoration: none; + color: #006699; + text-decoration: none; } a.nav:hover { - text-decoration: underline; + text-decoration: underline; } p a { @@ -154,22 +146,9 @@ p a { .comment { color: green; } -//--> -</style> -<!--[if IE]> -<style type="text/css"> -body { - scrollbar-face-color: #DEE3E7; - scrollbar-highlight-color: white; - scrollbar-shadow-color: #DEE3E7; - scrollbar-3dlight-color: #D1D7DC; - scrollbar-arrow-color: #006699; - scrollbar-track-color: #EFEFEF; - scrollbar-darkshadow-color: #98AAB1; -} +//--> </style> -<![endif]--> </head> @@ -177,11 +156,13 @@ body { <div id="logo"> <div id="title">Coding Guidelines</div> - <a href="index.php"><img src="header_left.jpg" alt="phpBB Logo" /></a> + <img src="header_left.jpg" alt="phpBB Logo" /> </div> <a name="top"></a><div id="main"> +<!-- BEGIN DOCUMENT --> + <p>These are the phpBB Coding Guidelines for Olympus, all attempts should be made to follow it as closely as possible.<br />This document is (c) 2006 phpBB Group, copying or redistribution is not allowed without permission.</p> <h1>Coding Guidelines</h1> @@ -1554,6 +1535,8 @@ div </div> <a href="#top">Top</a> +<!-- END DOCUMENT --> + </div> <div id="footer"> $Id$ |