INSTALL

   1 REQUIREMENTS
   2
   3 PhpWiki requires a web server with at least PHP version 4.3.9
   4 (Red Hat Enterprise Linux ES release 4).
   5 PhpWiki was tested with 4.4.7 (centos4), 4.3.9, 4.3.10, 4.4.9, 5.0.3,
   6 5.1.6 (centos5), 5.2.10, 5.2.17, 5.3.2, 5.3.3, 5.3.6, 5.3.8.
   7
   8 All users of PHP are strongly encouraged to upgrade to
   9 PHP 5.3.8 (Current stable) this is the supported version
  10 or if not possible to PHP 5.2.17 (Old stable).
  11
  12 Visit <http://www.php.net> and <http://php.net/downloads.php>
  13 for downloads and information.
  14
  15 You need the Perl regular expressions package compiled in; this is the
  16 default for PHP, so you probably have it. If you don't you'll see an
  17 error like "function preg_replace() not defined."
  18
  19 PHP must also be compiled with support for the type of database you
  20 want to use, i.e. --with-gdbm, --with-db2, --with-db3, --with-msql,
  21 --with-pgsql. (With PHP4 MySQL support is always enabled. With PHP5
  22 sqlite instead). Consult the PHP installation manual for specific
  23 installation and configure options.
  24 <http://www.php.net/manual/en/installation.php>
  25
  26 Since version 1.3.0 PhpWiki uses the 'DB.php' from PEAR, a database
  27 abstraction layer which is part of PHP. PhpWiki version 1.3.3 and later
  28 includes the necessary PEAR libraries and will use it if your system
  29 PEAR library can not be found. For more information about PEAR
  30 see <http://pear.php.net/>.
  31 PhpWiki version 1.3.7 and later includes the ADODB libraries and will
  32 use it for DATABASE_TYPE=ADODB. ADODB has more features, can use yet
  33 unsupported backends out of the box, and this is where SQL development
  34 happens. ADODB improvements are then backported to the stable PEAR
  35 backend (which often suffers from bad upstream PEAR libraries) and to
  36 PDO for php5.
  37
  38
  39 QUICK START INSTRUCTIONS
  40
  41 Copy 'config/config-dist.ini' to 'config/config.ini' and edit the
  42 settings in 'config/config.ini' to your liking.
  43
  44 By default PhpWiki is configured to use a dba database. If there
  45 is no dba on your system, you will see an error like this the first
  46 time you try to use PhpWiki:
  47
  48     "Fatal error: Call to undefined function: dba_open() in
  49      phpwiki/lib/DbaDatabase.php on line 32"
  50
  51 To correct this you will have to check the available dba handlers
  52 (default: db3 for Windows, otherwise gdbm), install the dba extension
  53 or preferably an sql-compatible database such as MySQL or PostgreSQL
  54 and make the necessary configuration changes to 'lib/config/config.ini'.
  55
  56
  57 INSTRUCTIONS
  58
  59 Below are the instructions for the "out of the box" installation,
  60 which uses DB files. If you are using a relational database like
  61 MySQL, see the INSTALL file for your database in the 'doc/' directory
  62 under the root of your PhpWiki installation.
  63
  64
  65 0. INSTALLATION
  66
  67 Untar / gzip this file into the directory where you want it to
  68 live. That's it.
  69
  70 bash$ gzip -d phpwiki-X.XX.tar.gz
  71 bash$ tar -xvf phpwiki-X.XX.tar
  72
  73 In the config subdirectory copy 'config-dist.ini' to 'config.ini' and
  74 edit the settings in 'config.ini' to your liking.
  75
  76
  77 1. CONFIGURATION
  78
  79 The first time you run this Wiki it will load a set of basic pages
  80 from the 'pgsrc/' directory. These should be enough to get your Wiki
  81 started.
  82
  83 PhpWiki will create some DBA files in '/tmp'. They contain the pages
  84 of the live site, archived pages, and some additional information.
  85
  86 If you don't want the DBA files to live in '/tmp' you must make sure
  87 the web server can read/write to your chosen location.  It's probably
  88 a bad idea to leave it in '/tmp', so change it in 'config/config.ini'.
  89
  90 WARNING: On many systems, files in '/tmp' are subject to periodic
  91          removal. We very strongly advise you to move the files to
  92          another directory.
  93
  94 For example, create a subdirectory called 'pages' in the 'phpwiki'
  95 directory which was made when you untarred PhpWiki. Move the DBA files
  96 there. The files should already have proper rights and owners, as they
  97 were created by the web server. If not, change the permissions
  98 accordingly so your web server can read / write the DBA files. Note
  99 that you must be root to move files created by the web server.
 100
 101 Next you must ensure that the web server can access the 'pages'
 102 directory and can create new files in it. For example, if your web
 103 server runs as user 'nobody', give the web server access like this:
 104
 105 bash$ chown nobody:youraccount pages
 106 bash$ chmod 755 pages
 107
 108 This is necessary so that the server can also create / set the
 109 database lock file (PHP has a built in locking mechanism for DBA file
 110 access).  Or if you're really lazy and don't worry much about
 111 security:
 112
 113 bash$ chmod 777 pages
 114
 115 Note: This is insecure. The proper way is to let the directory be
 116       owned by the web servers GUID and give it read and write access.
 117
 118
 119 2. ALLOWING EMBEDDED HTML
 120
 121 PhpWiki ships with this feature disabled by default. According to
 122 CERT, malicious users can embed HTML in your pages that allow pure
 123 evil to happen:
 124
 125     <http://www.cert.org/advisories/CA-2000-02.html>
 126
 127 Set the ENABLE_RAW_HTML to true in 'config/config.ini' to allow
 128 embedded HTML, but you should NEVER do this if your Wiki is publicly
 129 accessible!
 130
 131 3. ETC
 132
 133 Installing PHP is beyond the scope of this document :-) You should
 134 visit <http://www.php.net/> if you don't have PHP. Note that you
 135 should have the web server configured to allow index.php as the root
 136 document of a directory.
 137
 138 4. PATCHES
 139
 140 Post patches to:
 141     <http://sourceforge.net/tracker/?func=add&group_id=6121&atid=306121>
 142
 143 5. BUGS
 144
 145 Post bugs to:
 146     <http://sourceforge.net/tracker/?func=add&group_id=6121&atid=106121>
 147
 148 6. SUPPORT
 149
 150 For support from the PhpWiki team and user community post to:
 151     <phpwiki-talk@lists.sourceforge.net>
 152
 153 You can join this list at:
 154     <http://lists.sourceforge.net/lists/listinfo/phpwiki-talk>
 155
 156 FIN