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
13 You need the Perl regular expressions package compiled in; this is the
14 default for PHP, so you probably have it. If you don't you'll see an
15 error like "function preg_replace() not defined."
17 PHP must also be compiled with support for the type of database you
18 want to use, i.e. --with-gdbm, --with-db2, --with-db3, --with-msql,
19 --with-pgsql. (With PHP4 MySQL support is always enabled. With PHP5
20 sqlite instead). Consult the PHP installation manual for specific
21 installation and configure options.
22 <http://www.php.net/manual/en/installation.php>
24 Since version 1.3.0 PhpWiki uses the 'DB.php' from PEAR, a database
25 abstraction layer which is part of PHP. PhpWiki version 1.3.3 and later
26 includes the necessary PEAR libraries and will use it if your system
27 PEAR library can not be found. For more information about PEAR
28 see <http://pear.php.net/>.
30 You'd need to set allow_call_time_pass_reference = On in php.ini
32 php_value allow_call_time_pass_reference 1
35 QUICK START INSTRUCTIONS
37 Copy 'config/config-dist.ini' to 'config/config.ini' and edit the
38 settings in 'config/config.ini' to your liking.
40 By default PhpWiki is configured to use a dba database. If there
41 is no dba on your system, you will see an error like this the first
42 time you try to use PhpWiki:
44 "Fatal error: Call to undefined function: dba_open() in
45 phpwiki/lib/DbaDatabase.php on line 32"
47 To correct this you will have to check the available dba handlers
48 (default: db3 for Windows, otherwise gdbm), install the dba extension
49 or preferably an sql-compatible database such as MySQL or PostgreSQL
50 and make the necessary configuration changes to 'lib/config/config.ini'.
55 Below are the instructions for the "out of the box" installation,
56 which uses DB files. If you are using a relational database like
57 MySQL, see the INSTALL file for your database in the 'doc/' directory
58 under the root of your PhpWiki installation.
63 Untar / gzip this file into the directory where you want it to
66 bash$ gzip -d phpwiki-X.XX.tar.gz
67 bash$ tar -xvf phpwiki-X.XX.tar
69 In the config subdirectory copy 'config-dist.ini' to 'config.ini' and
70 edit the settings in 'config.ini' to your liking.
75 The first time you run this Wiki it will load a set of basic pages
76 from the 'pgsrc/' directory. These should be enough to get your Wiki
79 PhpWiki will create some DBA files in '/tmp'. They contain the pages
80 of the live site, archived pages, and some additional information.
82 If you don't want the DBA files to live in '/tmp' you must make sure
83 the web server can read/write to your chosen location. It's probably
84 a bad idea to leave it in '/tmp', so change it in 'config/config.ini'.
86 WARNING: on many systems, files in '/tmp' are subject to periodic
87 removal. We very strongly advise you to move the files to
90 For example, create a subdirectory called 'pages' in the 'phpwiki'
91 directory which was made when you untarred PhpWiki. Move the DBA files
92 there. The files should already have proper rights and owners, as they
93 were created by the web server. If not, change the permissions
94 accordingly so your web server can read / write the DBA files. Note
95 that you must be root to move files created by the web server.
97 Next you must ensure that the web server can access the 'pages'
98 directory and can create new files in it. For example, if your web
99 server runs as user 'nobody', give the web server access like this:
101 bash$ chown nobody:youraccount pages
102 bash$ chmod 755 pages
104 This is necessary so that the server can also create / set the
105 database lock file (PHP has a built in locking mechanism for DBA file
106 access). Or if you're really lazy and don't worry much about
109 bash$ chmod 777 pages
111 Note: This is insecure. The proper way is to let the directory be
112 owned by the web servers GUID and give it read and write access.
115 2. ALLOWING EMBEDDED HTML
117 PhpWiki ships with this feature disabled by default. According to
118 CERT, malicious users can embed HTML in your pages that allow pure
121 <http://www.cert.org/advisories/CA-2000-02.html>
123 Set the ENABLE_RAW_HTML to true in 'lib/plugin/RawHtml.php' to allow
124 embedded HTML, but you should NEVER do this if your Wiki is publicly
127 define('ENABLE_RAW_HTML', true);
132 Installing PHP is beyond the scope of this document :-) You should
133 visit <http://www.php.net/> if you don't have PHP. Note that you
134 should have the web server configured to allow index.php as the root
135 document of a directory.
140 <http://sourceforge.net/tracker/?func=add&group_id=6121&atid=306121>
145 <http://sourceforge.net/tracker/?func=add&group_id=6121&atid=106121>
149 For support from the PhpWiki team and user community post to:
150 <phpwiki-talk@lists.sourceforge.net>
152 You can join this list at:
153 <http://lists.sourceforge.net/lists/listinfo/phpwiki-talk>
157 $Id: INSTALL,v 1.23 2004-05-09 00:57:31 rurban Exp $