INSTALL

   1 REQUIREMENTS
   2
   3 PhpWiki 1.5.0 requires a web server with at least PHP version 5.3.
   4
   5 All users of PHP are strongly encouraged to upgrade to
   6 PHP 5.3.29 or to PHP 5.4 or 5.5.
   7
   8 Visit <http://www.php.net> and <http://php.net/downloads.php>
   9 for downloads and information.
  10
  11 You need the Perl regular expressions package compiled in; this is the
  12 default for PHP, so you probably have it. If you don't you'll see an
  13 error like "function preg_replace() not defined."
  14
  15 PHP must also be compiled with support for the type of database you
  16 want to use, i.e. --with-gdbm, --with-db2, --with-db3, --with-msql,
  17 --with-pgsql.  Consult the PHP installation manual for specific
  18 installation and configure options.
  19 <http://www.php.net/manual/en/installation.php>
  20
  21 Since version 1.3.0 PhpWiki uses the 'DB.php' from PEAR, a database
  22 abstraction layer which is part of PHP. PhpWiki version 1.3.3 and later
  23 includes the necessary PEAR libraries and will use it if your system
  24 PEAR library can not be found. For more information about PEAR
  25 see <http://pear.php.net/>.
  26 PhpWiki version 1.3.7 and later includes the ADODB libraries and will
  27 use it for DATABASE_TYPE=ADODB. ADODB has more features, can use yet
  28 unsupported backends out of the box, and this is where SQL development
  29 happens. ADODB improvements are then backported to the stable PEAR
  30 backend (which often suffers from bad upstream PEAR libraries) and to
  31 PDO for php5.
  32
  33
  34 QUICK START INSTRUCTIONS
  35
  36 Copy 'config/config-dist.ini' to 'config/config.ini' and edit the
  37 settings in 'config/config.ini' to your liking.
  38
  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:
  42
  43     "Fatal error: Call to undefined function: dba_open() in
  44      phpwiki/lib/DbaDatabase.php on line 32"
  45
  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'.
  50
  51
  52 INSTRUCTIONS
  53
  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.
  58
  59
  60 0. INSTALLATION
  61
  62 Unzip this file into the directory where you want it to live. That's it.
  63
  64 bash$ unzip phpwiki-1.5.0.zip
  65
  66 In the config subdirectory copy 'config-dist.ini' to 'config.ini' and
  67 edit the settings in 'config.ini' to your liking.
  68
  69
  70 1. CONFIGURATION
  71
  72 The first time you run this Wiki it will load a set of basic pages
  73 from the 'pgsrc/' directory. These should be enough to get your Wiki
  74 started.
  75
  76 PhpWiki will create some DBA files in '/tmp'. They contain the pages
  77 of the live site, archived pages, and some additional information.
  78
  79 If you don't want the DBA files to live in '/tmp' you must make sure
  80 the web server can read/write to your chosen location.  It's probably
  81 a bad idea to leave it in '/tmp', so change it in 'config/config.ini'.
  82
  83 WARNING: On many systems, files in '/tmp' are subject to periodic
  84          removal. We very strongly advise you to move the files to
  85          another directory.
  86
  87 For example, create a subdirectory called 'pages' in the 'phpwiki'
  88 directory which was made when you untarred PhpWiki. Move the DBA files
  89 there. The files should already have proper rights and owners, as they
  90 were created by the web server. If not, change the permissions
  91 accordingly so your web server can read / write the DBA files. Note
  92 that you must be root to move files created by the web server.
  93
  94 Next you must ensure that the web server can access the 'pages'
  95 directory and can create new files in it. For example, if your web
  96 server runs as user 'nobody', give the web server access like this:
  97
  98 bash$ chown nobody:youraccount pages
  99 bash$ chmod 755 pages
 100
 101 This is necessary so that the server can also create / set the
 102 database lock file (PHP has a built in locking mechanism for DBA file
 103 access).  Or if you're really lazy and don't worry much about
 104 security:
 105
 106 bash$ chmod 777 pages
 107
 108 Note: This is insecure. The proper way is to let the directory be
 109       owned by the web servers GUID and give it read and write access.
 110
 111
 112 2. ALLOWING EMBEDDED HTML
 113
 114 PhpWiki ships with this feature disabled by default. According to
 115 CERT, malicious users can embed HTML in your pages that allow pure
 116 evil to happen:
 117
 118     <http://www.cert.org/advisories/CA-2000-02.html>
 119
 120 Set the ENABLE_RAW_HTML to true in 'config/config.ini' to allow
 121 embedded HTML, but you should NEVER do this if your Wiki is publicly
 122 accessible!
 123
 124 3. ETC
 125
 126 Installing PHP is beyond the scope of this document :-) You should
 127 visit <http://www.php.net/> if you don't have PHP. Note that you
 128 should have the web server configured to allow index.php as the root
 129 document of a directory.
 130
 131 4. PATCHES
 132
 133 Post patches to:
 134     <http://sourceforge.net/tracker/?func=add&group_id=6121&atid=306121>
 135
 136 5. BUGS
 137
 138 Post bugs to:
 139     <http://sourceforge.net/tracker/?func=add&group_id=6121&atid=106121>
 140
 141 6. SUPPORT
 142
 143 For support from the PhpWiki team and user community post to:
 144     <phpwiki-talk@lists.sourceforge.net>
 145
 146 You can join this list at:
 147     <http://lists.sourceforge.net/lists/listinfo/phpwiki-talk>
 148
 149 FIN