[Sommaire] [Imprimer]

   1  Phorum 5 Installation instructions
   2  ==================================
   3  
   4  Contents:
   5  
   6  1. Requirements
   7  2. Quickstart guide
   8  3. Detailed installation instructions
   9     3.1 Download Phorum
  10     3.2 Unpack the downloaded archive
  11     3.3 Place the Phorum files in your website's document root
  12     3.4 Create a database and a database user
  13     3.5 Configure the database access
  14     3.6 Run the web based installer
  15     3.7 Things to do after installing Phorum
  16  4. Additional issues 
  17     4.1 Additional issues for UNIX (Linux, BSD, Solaris, etc.)
  18         4.1.2 Cache directory
  19     4.2 Additional issues for Windows
  20         4.2.1 Cache directory
  21         4.2.2 Problems sending mail to end-users
  22         4.2.3 Date formatting
  23  5. Support
  24  
  25  
  26  1. Requirements
  27  -------------------------------------------------------------------------------
  28  
  29  
  30     Requirements for running Phorum are:
  31  
  32     * A webserver;
  33     * PHP, version 4 or above;
  34     * A MySQL server, version 4 or above.
  35  
  36     If you do not run your own website, but have hosted your website with
  37     a hosting provider, then please ask your hosting provider if your
  38     account meets these requirements.
  39  
  40  
  41  2. Quickstart guide:
  42  -------------------------------------------------------------------------------
  43  
  44  
  45     This is the quickstart guide for installing Phorum, aimed at people that
  46     are used to working with websites, PHP and databases. If you are having
  47     problems following this guide, then please read chapter 3 instead.
  48  
  49     1. Unpack Phorum into a directory below your website's document root;
  50     2. Create a database and a full-access database user for that database;
  51     3. Edit include/db/config.php.sample, save it as include/db/config.php;
  52     4. Open {phorum url}/admin.php in your web browser and finish the install.
  53  
  54  
  55  3. Detailed installation instructions
  56  -------------------------------------------------------------------------------
  57  
  58  
  59   3.1 Download Phorum
  60   -------------------
  61  
  62     If you haven't already done so, download the latest Phorum distribution
  63     from http://phorum.org/downloads.php
  64     
  65  
  66   3.2 Unpack the downloaded archive
  67   ---------------------------------
  68     
  69     From Windows:
  70     
  71     If you have downloaded the .zip file, you can extract the
  72     files from that archive directly using Windows XP's zipfile support.
  73     If you downloaded the .tar.gz file, you will have to download an
  74     appropriate tool for unpacking, e.g. WinZip (http://www.winzip.com/).
  75     
  76     From UNIX:
  77     
  78     If you have access to a UNIX shell, you can unpack the .tar.gz
  79     archive using the following command:
  80     
  81     shell> tar xvzf phorum-x.y.z.tar.gz
  82     
  83     Or if the tar program on your system does not support the -z flag:
  84     
  85     shell> gunzip phorum-x-y-z.tar.gz
  86     shell> tar xvf phorum-x.y.z.tar
  87  
  88  
  89   3.3 Place the Phorum files in your website's document root
  90   ----------------------------------------------------------
  91  
  92     The document root for a website is the directory in which your site's
  93     web pages are stored. If your website's URL is "http://www.example.com"
  94     and you place the Phorum files in a directory called "forum" inside
  95     your document root, your Phorum installation will be available at the
  96     URL "http://www.example.com/forum". From now on, we will name this
  97     URL simply {phorum url}. So if you see {phorum url}/admin.php, using the
  98     example we mean http://www.example.com/forum/admin.php
  99     
 100     If the webserver is running on the same system as where you have
 101     unpacked the downloaded archive, you can move the unpacked files
 102     to your website's document root.
 103     
 104     If the webserver is running on another system, you will have to upload
 105     the files to your website's document root. In most cases, you will use
 106     FTP for this, but some hosting providers require SCP (secure copy,
 107     which is more secure than FTP). If you do not know how or where to
 108     upload the Phorum files, please contact your hosting provider.
 109     
 110     Security note:
 111     (simply ignore this if it does not make sense to you)
 112     There are software packages that require you to make files writable
 113     for the webserver (using the infamous "chmod 777"). DO NOT DO THIS
 114     FOR ANY OF THE PHORUM FILES. The webserver only needs read access on
 115     the disctribution files, because all dynamic data is stored in the
 116     database. If you run into problems running Phorum, it will never be
 117     because you "forgot" to do "chmod 777" on any the Phorum files.
 118  
 119  
 120   3.4 Create a database and a database user
 121   -----------------------------------------
 122  
 123     Phorum stores all its data in a database. So you now need to create
 124     a database. Officially, only the MySQL database server is supported
 125     by Phorum, so we recommend to use MySQL whenever possible.
 126     
 127     If you have hosted your site with a hosting provider, then ask
 128     your hosting provider to setup the database and a full access
 129     database user for you.
 130     
 131     If you run your own database server, then you will have to create
 132     the database and the user yourself. If you are using a control
 133     panel, like phpmyadmin, then use that control panel to create
 134     them. Else, you can use the mysql prompt to create the database
 135     by issuing commands like:
 136     
 137     mysql> CREATE DATABASE phorum;
 138     mysql> GRANT ALL ON phorum.* TO user@localhost IDENTIFIED BY password;
 139     
 140     Of course, for security reasons you would use your own user and
 141     password instead.
 142     
 143     If you are unsure how to create a database and a database user,
 144     please refer to your system documentation.
 145  
 146  
 147   3.5 Configure the database access
 148   ---------------------------------
 149  
 150     After setting up the database, you'll have to tell Phorum how the
 151     database can be accessed. This configuration is put in the file
 152     include/db/config.php inside your Phorum directory. This file is
 153     not in the distribution. Only a differently named sample file is
 154     included.
 155     
 156     First, copy or rename the file "include/db/config.php.sample" to
 157     "include/db/config.php". Now edit the config.php file to match the
 158     access settings for the database that was created in step 4.
 159     
 160     If you run your website on a remote server, then either edit
 161     the config.php file directly on that server (e.g. through a
 162     UNIX prompt) or upload the file to the correct location after
 163     editing it locally.
 164  
 165  
 166   3.6 Run the web based installer
 167   -------------------------------
 168  
 169     Now all is in place to run Phorum's installer script.
 170     Open {phorum url}/admin.php using your web browser. This is the admin
 171     interface, which will automatically detect that a fresh install has
 172     to be performed.
 173  
 174     Follow the instructions on screen to finish the Phorum installation.
 175  
 176     In case you do not see the installer, but a blank screen instead,
 177     something is wrong. Please check the following:
 178  
 179     - Does the PHP installation include support your database server? If
 180       the PHP installation is lacking support, it will not be able to
 181       connect to the database. If you are running your website with a
 182       hosting provider, then ask your provider;
 183  
 184     - Is there a typo in include/db/config.php? A typo might crash PHP.
 185       If you have access to your server's error logging, then please check
 186       for errors in there. You could ask your provider to look at the error
 187       log, in case you have no direct access to it;
 188  
 189     - Did all files get uploaded and was filename case properly preserved
 190       by your FTP client? There are some FTP clients which upload all files
 191       using lower case only. Check whether the files 
 192       include/admin/PhorumAdminMenu.php and include/admin/PhorumInputForm.php
 193       are uploaded, using exactly these names and not something like
 194       include/admin/phorumadminmenu.php for example.
 195  
 196       
 197   3.7 Things to do after installing Phorum
 198   ----------------------------------------
 199  
 200     Now the installation is complete, test if the forum is working
 201     correctly by opening {phorum url} in your web browser. If you run
 202     into problems, please go to {forum url}/admin.php and click on
 203     "System Sanity Checks" in the menu. This page will perform a couple
 204     of system checks to rule out some basic problems. If problems are
 205     found, please follow the instructions from the sanity checks page
 206     to solve them.
 207     
 208     Login into the admin interface at {phorum url}/admin.php and check
 209     out what settings can be done to customize Phorum to your likings.
 210     
 211     Customize the looks of Phorum to your needs by creating a custom
 212     template. Instructions can be found in docs/creating_templates.txt.
 213     
 214     Read the additional issues for your system (below), docs/faq.txt
 215     and any other files in the docs dir that may help you.
 216  
 217  
 218  4. Additional issues
 219  -------------------------------------------------------------------------------
 220  
 221  
 222   4.1 Additional issues for UNIX (Linux, BSD, Solaris, etc.)
 223   ----------------------------------------------------------
 224  
 225    4.1.2 Cache directory
 226    ---------------------
 227  
 228     In step 5 above (Edit Settings) There is an entry called Cache
 229     Directory. the installer should set that to /tmp if you appear to
 230     be running a *nix system. This will keep compiled PHP versions of
 231     your templates in /tmp. You can change the cache dir if you do not
 232     want to have your files sitting in /tmp on the server or if you see
 233     error messages like:
 234  
 235     Warning:
 236     fopen(/tmp/tpl-default-header-a72fb9dd20915e5953aa9b07d3eb3871.php):
 237     failed to open stream: Permission denied in
 238     /path/to/phorum/include/templates.php on line 184
 239  
 240     If you change the the Cache Directory, the best bet is to set it
 241     to ./cache and make that dir (that is already there in the Phorum dir)
 242     writable by the web server. Most likely this means making it world
 243     writeable (chmod 777). If you do not have access to the shell prompt
 244     of the server and are using only FTP to access the server, please see
 245     your FTP clients help on setting the permissions for a directory.
 246  
 247  
 248   4.2 Additional issues for Windows
 249   ---------------------------------
 250  
 251  
 252    4.2.1 Cache directory
 253    ---------------------
 254  
 255     In step 5 above (Edit Settings) There is an entry called Cache
 256     Directory. The installer should set that to C:\Windows\Temp, if it
 257     can detect you are using Windows. This should work for most modern
 258     Windows versions. If it does not, you will see error messages like:
 259  
 260     Warning:
 261     fopen(c:\windows\temp\tpl-default-header-a72fb9dd209153aa9b07d3eb3871.php):
 262     failed to open stream: Permission denied in
 263     c:\path\to\phorum\include\templates.php on line 184
 264  
 265     You will need to change the Cache Directory. The Phorum team is not
 266     very familiar with Windows as a web server platform. We can only tell
 267     you that it will need to be something that the web server can write to.
 268     Changing the Cache Directory to ./cache has worked for some.
 269  
 270  
 271    4.2.2 Problems sending mail to end-users
 272    ----------------------------------------
 273  
 274     PHP has to be configured correctly on Windows systems to be able to
 275     send out mail. If this is not done, you might get errors and mail
 276     will not arrive. What you need to do is edit the file "php.ini" (this
 277     file holds the configuration for PHP). Find the sections that is called
 278     "[mail function]". In this section, set the parameter "SMTP" to the
 279     hostname or IP-address of the your SMTP server. If you do not know your
 280     SMTP server, please ask your internet access provider. After this,
 281     PHP will know what mailserver to use for sending out mail messages.
 282  
 283     If you have no access to the php.ini file and the system administrator
 284     is not willing to update it for you, you will have to install the
 285     SMTP module for Phorum. You can download this module from the module page:
 286     http://phorum.org/cgi-bin/trac.cgi/wiki/ListOfModules
 287     In the settings for this module, you can specify the SMTP server to use
 288     for sending mail. When using this module, you will completely bypass PHP's
 289     builtin mail system.
 290  
 291  
 292    4.2.3 Date formatting
 293    ---------------------
 294  
 295     Windows does not support the date formatting function strftime() fully.
 296     If your dates are not showing correctly, you have to edit your language
 297     file ({phorum dir}/include/lang/<yourlanguage>.php) and change the
 298     definitions for $PHORUM['long_date'] and $PHORUM['short_date'] in there
 299     to something that will work for your system. We suggest using the
 300     following definitions:
 301  
 302        $PHORUM['long_date']="%B %d, %Y %I:%M%p";
 303        $PHORUM['short_date']="%m/%d/%Y %I:%M%p";
 304  
 305     Go to http://www.php.net/strftime for information on all available
 306     formatting options as well as the formats that Windows does not support.
 307  
 308  
 309  5. Support
 310  -------------------------------------------------------------------------------
 311  
 312     If you have questions about installing Phorum, please visit the website
 313     http://phorum.org/ and ask the development team for help in the
 314     Support forum. Also read the file docs/faq.txt for answers to the most
 315     common questions.
 316  
 317  
 318