3 PhpWiki requires a web server with PHP version 4.0.4pl1 or greater and a
5 (PhpWiki uses the array_search() function which is present only in PHP
6 version 4.0.4pl1 / 4.0.5 or greater.)
8 Latest tests showed, that it requires at least 4.0.6 --rurban
10 Due to a security issue found in all versions of PHP (including 3.x
11 and 4.x), all users of PHP are strongly encouraged to either upgrade
12 to PHP 4.2.2, or install a patch available for PHP 3.0.18, 4.0.6 and
13 4.1.0/4.1.1. Visit <http://www.php.net> for downloads and information.
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."
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>
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/>.
32 You'd need to set allow_call_time_pass_reference = On in php.ini
34 php_value allow_call_time_pass_reference 1
36 QUICK START INSTRUCTIONS
38 Copy 'config/config-dist.ini' to 'config/config.ini' and edit the
39 settings in 'config/config.ini' to your liking.
41 By default PhpWiki is configured to use a dba database. If there
42 is no dba on your system, you will see an error like this the first
43 time you try to use PhpWiki:
45 "Fatal error: Call to undefined function: dba_open() in
46 phpwiki/lib/DbaDatabase.php on line 32"
48 To correct this you will have to check the available dba handlers
49 (default: db3 for Windows, otherwise gdbm), install the dba extension
50 or preferably an sql-compatible database such as MySQL or PostgreSQL
51 and make the necessary configuration changes to 'lib/config/config.ini'.
56 Below are the instructions for the "out of the box" installation,
57 which uses DB files. If you are using a relational database like
58 MySQL, see the INSTALL file for your database in the 'doc/' directory
59 under the root of your PhpWiki installation.
64 Untar / gzip this file into the directory where you want it to
67 bash$ gzip -d phpwiki-X.XX.tar.gz
68 bash$ tar -xvf phpwiki-X.XX.tar
70 In the config subdirectory copy 'config-dist.ini' to 'config.ini' and
71 edit the settings in 'config.ini' to your liking.
76 The first time you run this Wiki it will load a set of basic pages
77 from the 'pgsrc/' directory. These should be enough to get your Wiki
80 PhpWiki will create some DBA files in '/tmp'. They contain the pages
81 of the live site, archived pages, and some additional information.
83 If you don't want the DBA files to live in '/tmp' you must make sure
84 the web server can read/write to your chosen location. It's probably
85 a bad idea to leave it in '/tmp', so change it in 'config/config.ini'.
87 WARNING: on many systems, files in '/tmp' are subject to periodic
88 removal. We very strongly advise you to move the files to
91 For example, create a subdirectory called 'pages' in the 'phpwiki'
92 directory which was made when you untarred PhpWiki. Move the DBA files
93 there. The files should already have proper rights and owners, as they
94 were created by the web server. If not, change the permissions
95 accordingly so your web server can read / write the DBA files. Note
96 that you must be root to move files created by the web server.
98 Next you must ensure that the web server can access the 'pages'
99 directory and can create new files in it. For example, if your web
100 server runs as user 'nobody', give the web server access like this:
102 bash$ chown nobody:youraccount pages
103 bash$ chmod 755 pages
105 This is necessary so that the server can also create / set the
106 database lock file (PHP has a built in locking mechanism for DBA file
107 access). Or if you're really lazy and don't worry much about
110 bash$ chmod 777 pages
112 Note: This is insecure. The proper way is to let the directory be
113 owned by the web servers GUID and give it read and write access.
116 2. ALLOWING EMBEDDED HTML
118 PhpWiki ships with this feature disabled by default. According to
119 CERT, malicious users can embed HTML in your pages that allow pure
122 <http://www.cert.org/advisories/CA-2000-02.html>
124 Set the ENABLE_RAW_HTML to true in 'lib/plugin/RawHtml.php' to allow
125 embedded HTML, but you should NEVER do this if your Wiki is publicly
128 define('ENABLE_RAW_HTML', true);
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.
141 <http://sourceforge.net/tracker/?func=add&group_id=6121&atid=306121>
146 <http://sourceforge.net/tracker/?func=add&group_id=6121&atid=106121>
150 For support from the PhpWiki team and user community post to:
151 <phpwiki-talk@lists.sourceforge.net>
153 You can join this list at:
154 <http://lists.sourceforge.net/lists/listinfo/phpwiki-talk>
158 $Id: INSTALL,v 1.21 2004-05-01 16:04:56 rurban Exp $