3 PhpWiki requires a web server with at least PHP version 4.0.6.
4 PhpWiki was tested 4.0.4pl1 and 4.0.5 also, but several bugs in these
5 releases make them unstable for production sites.
7 Due to a security issue found in all versions of PHP (including 3.x
8 and 4.x), all users of PHP are strongly encouraged to either upgrade
9 to at least PHP 4.2.2, or install a patch available for PHP 3.0.18,
10 4.0.6 and 4.1.0/4.1.1. Visit <http://www.php.net> for downloads and
12 Larger phpwiki installations (big pages or > 500 pages)
13 with PHP <= 4.3.9 suffer from a PCRE memory problem and might not
14 work with the 8MB default PHP memory limit.
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."
20 PHP must also be compiled with support for the type of database you
21 want to use, i.e. --with-gdbm, --with-db2, --with-db3, --with-msql,
22 --with-pgsql. (With PHP4 MySQL support is always enabled. With PHP5
23 sqlite instead). Consult the PHP installation manual for specific
24 installation and configure options.
25 <http://www.php.net/manual/en/installation.php>
27 Since version 1.3.0 PhpWiki uses the 'DB.php' from PEAR, a database
28 abstraction layer which is part of PHP. PhpWiki version 1.3.3 and later
29 includes the necessary PEAR libraries and will use it if your system
30 PEAR library can not be found. For more information about PEAR
31 see <http://pear.php.net/>.
34 QUICK START INSTRUCTIONS
36 Copy 'config/config-dist.ini' to 'config/config.ini' and edit the
37 settings in 'config/config.ini' to your liking.
39 By default PhpWiki is configured to use a dba database. If there
40 is no dba on your system, you will see an error like this the first
41 time you try to use PhpWiki:
43 "Fatal error: Call to undefined function: dba_open() in
44 phpwiki/lib/DbaDatabase.php on line 32"
46 To correct this you will have to check the available dba handlers
47 (default: db3 for Windows, otherwise gdbm), install the dba extension
48 or preferably an sql-compatible database such as MySQL or PostgreSQL
49 and make the necessary configuration changes to 'lib/config/config.ini'.
54 Below are the instructions for the "out of the box" installation,
55 which uses DB files. If you are using a relational database like
56 MySQL, see the INSTALL file for your database in the 'doc/' directory
57 under the root of your PhpWiki installation.
62 Untar / gzip this file into the directory where you want it to
65 bash$ gzip -d phpwiki-X.XX.tar.gz
66 bash$ tar -xvf phpwiki-X.XX.tar
68 In the config subdirectory copy 'config-dist.ini' to 'config.ini' and
69 edit the settings in 'config.ini' to your liking.
74 The first time you run this Wiki it will load a set of basic pages
75 from the 'pgsrc/' directory. These should be enough to get your Wiki
78 PhpWiki will create some DBA files in '/tmp'. They contain the pages
79 of the live site, archived pages, and some additional information.
81 If you don't want the DBA files to live in '/tmp' you must make sure
82 the web server can read/write to your chosen location. It's probably
83 a bad idea to leave it in '/tmp', so change it in 'config/config.ini'.
85 WARNING: On many systems, files in '/tmp' are subject to periodic
86 removal. We very strongly advise you to move the files to
89 For example, create a subdirectory called 'pages' in the 'phpwiki'
90 directory which was made when you untarred PhpWiki. Move the DBA files
91 there. The files should already have proper rights and owners, as they
92 were created by the web server. If not, change the permissions
93 accordingly so your web server can read / write the DBA files. Note
94 that you must be root to move files created by the web server.
96 Next you must ensure that the web server can access the 'pages'
97 directory and can create new files in it. For example, if your web
98 server runs as user 'nobody', give the web server access like this:
100 bash$ chown nobody:youraccount pages
101 bash$ chmod 755 pages
103 This is necessary so that the server can also create / set the
104 database lock file (PHP has a built in locking mechanism for DBA file
105 access). Or if you're really lazy and don't worry much about
108 bash$ chmod 777 pages
110 Note: This is insecure. The proper way is to let the directory be
111 owned by the web servers GUID and give it read and write access.
114 2. ALLOWING EMBEDDED HTML
116 PhpWiki ships with this feature disabled by default. According to
117 CERT, malicious users can embed HTML in your pages that allow pure
120 <http://www.cert.org/advisories/CA-2000-02.html>
122 Set the ENABLE_RAW_HTML to true in ' config/config.ini' to allow
123 embedded HTML, but you should NEVER do this if your Wiki is publicly
128 Installing PHP is beyond the scope of this document :-) You should
129 visit <http://www.php.net/> if you don't have PHP. Note that you
130 should have the web server configured to allow index.php as the root
131 document of a directory.
136 <http://sourceforge.net/tracker/?func=add&group_id=6121&atid=306121>
141 <http://sourceforge.net/tracker/?func=add&group_id=6121&atid=106121>
145 For support from the PhpWiki team and user community post to:
146 <phpwiki-talk@lists.sourceforge.net>
148 You can join this list at:
149 <http://lists.sourceforge.net/lists/listinfo/phpwiki-talk>
153 $Id: INSTALL,v 1.25 2005-04-03 16:52:50 uckelman Exp $