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