INSTALL

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