INSTALL

   1 REQUIREMENTS
   2
   3 PhpWiki requires PHP version 4.0.? or greater.
   4
   5 Since version 1.3.0 PhpWiki uses the 'DB.php' from PEAR, a database
   6 absraction layer which is part of PHP. PEAR must be installed and
   7 enabled too. If PHP cannot find it's 'DB.php', the first time you try
   8 to use PhpWiki you will see an error like this:
   9
  10     "lib/FileFinder.php:82: Fatal[256]: DB.php: file not found"
  11
  12 To fix this, locate the file 'DB.php' on your system, then uncomment
  13 and modify the "ini_set" line in part zero of 'index.php':
  14
  15     ini_set('include_path', '.:/my/location/of/pear/directory');
  16
  17 For more information about PEAR see <http://pear.php.net/>.
  18
  19
  20 You need the Perl regular expressions package compiled in; this is the
  21 default for PHP, so you probably have it. If you don't you'll see an
  22 error like "function preg_replace() not defined."
  23
  24 Below are the instructions for the "out of the box" installation,
  25 which uses DB files. If you are using a relational database like
  26 MySQL, see the INSTALL file for your database in the 'doc/' directory
  27 under the root of your PhpWiki installation.
  28
  29
  30
  31 0. INSTALLATION
  32
  33 Untar / gzip this file into the directory where you want it to
  34 live. That's it.
  35
  36 bash$ gzip -d phpwiki-X.XX.tar.gz
  37 bash$ tar -xvf phpwiki-X.XX.tar
  38
  39 Look at 'index.php' and edit the settings there to your liking.
  40
  41
  42 1. CONFIGURATION
  43
  44 The first time you run this Wiki it will load a set of basic pages
  45 from the 'pgsrc/' directory. These should be enough to get your Wiki
  46 started.
  47
  48 PhpWiki will create some DBM files in '/tmp'. They contain the pages
  49 of the live site, archived pages, and some additional information.
  50
  51 If you don't want the DBM files to live in '/tmp' you must make sure
  52 the web server can read/write to your chosen location.  It's probably
  53 a bad idea to leave it in '/tmp', so change it in 'index.php'.
  54
  55 WARNING: on many systems, files in '/tmp' are subject to periodic
  56          removal. We very strongly advise you to move the files to
  57          another directory.
  58
  59 For example, create a subdirectory called 'pages' in the 'phpwiki'
  60 directory which was made when you untarred PhpWiki. Move the DBM files
  61 there. The files should already have proper rights and owners, as they
  62 were created by the web server. If not, change the permissions
  63 accordingly so your web server can read / write the DBM files. Note
  64 that you must be root to move files created by the web server.
  65
  66 Next you must ensure that the web server can access the 'pages'
  67 directory and can create new files in it. For example, if your web
  68 server runs as user 'nobody', give the web server access like this:
  69
  70 bash$ chown nobody:youraccount pages
  71 bash$ chmod 755 pages
  72
  73 This is necessary so that the server can also create / set the
  74 database lock file (PHP has a built in locking mechanism for DBM file
  75 access).  Or if you're really lazy and don't worry much about
  76 security:
  77
  78 bash$ chmod 777 pages
  79
  80 Note: This is insecure. The proper way is to let the directory be
  81       owned by the web servers GUID and give it read and write access.
  82
  83
  84
  85 2. ALLOWING EMBEDDED HTML
  86
  87 (This is not working in the 1.3 branch as of this writing.)
  88
  89 PhpWiki ships with this feature disabled by default. According to
  90 CERT, malicious users can embed HTML in your pages that allow pure
  91 evil to happen:
  92
  93     <http://www.cert.org/advisories/CA-2000-02.html>
  94
  95 You can uncomment the "elseif" in 'lib/transform.php' to allow
  96 embedded HTML; but you should NEVER do this if your Wiki is publically
  97 accessible.
  98
  99
 100 3. ETC
 101
 102 Installing PHP is beyond the scope of this document :-) You should
 103 visit <http://www.php.net/> if you don't have PHP. Note that you
 104 should have the web server configured to allow index.php as the root
 105 document of a directory.
 106
 107 4. PATCHES
 108
 109 Post patches to:
 110     <http://sourceforge.net/tracker/?func=add&group_id=6121&atid=306121>
 111
 112 5. BUGS
 113
 114 Post bugs to:
 115     <http://sourceforge.net/tracker/?func=add&group_id=6121&atid=106121>
 116
 117 6. SUPPORT
 118
 119 For support from the PhpWiki team and user community post to:
 120     <phpwiki-talk@lists.sourceforge.net>
 121
 122 You can join this list at:
 123     <http://lists.sourceforge.net/lists/listinfo/phpwiki-talk>
 124
 125 FIN
 126
 127 $Id: INSTALL,v 1.14 2002-01-03 07:59:36 carstenklapp Exp $