From dae99aefaee95f94ee23d1572568b58c003bdf55 Mon Sep 17 00:00:00 2001 From: rurban Date: Fri, 17 Dec 2004 09:28:40 +0000 Subject: [PATCH] doc update git-svn-id: svn://svn.code.sf.net/p/phpwiki/code/trunk@4293 96ab9672-09ca-45d6-a79d-3d69d39ca109 --- INSTALL | 14 ++++++------ README | 26 +++++++++++++-------- UPGRADING | 27 ++++++++++++++++------ doc/INSTALL.mysql | 22 ++++++++++-------- doc/INSTALL.pgsql | 31 +++++++++++-------------- doc/README.phpwiki-cache | 49 +++++++--------------------------------- pgsrc/PluginManager | 22 +++++++++++------- 7 files changed, 90 insertions(+), 101 deletions(-) diff --git a/INSTALL b/INSTALL index 1a680ff93..e4888d49b 100644 --- a/INSTALL +++ b/INSTALL @@ -8,7 +8,10 @@ Due to a security issue found in all versions of PHP (including 3.x and 4.x), all users of PHP are strongly encouraged to either upgrade to at least PHP 4.2.2, or install a patch available for PHP 3.0.18, 4.0.6 and 4.1.0/4.1.1. Visit for downloads and -information. +information. +Larger phpwiki installations (big pages or > 500 pages) +with PHP <= 4.3.9 suffer from a PCRE memory problem and might not +work with the 8MB default PHP memory limit. You need the Perl regular expressions package compiled in; this is the default for PHP, so you probably have it. If you don't you'll see an @@ -83,7 +86,7 @@ If you don't want the DBA files to live in '/tmp' you must make sure the web server can read/write to your chosen location. It's probably a bad idea to leave it in '/tmp', so change it in 'config/config.ini'. -WARNING: on many systems, files in '/tmp' are subject to periodic +WARNING: On many systems, files in '/tmp' are subject to periodic removal. We very strongly advise you to move the files to another directory. @@ -120,13 +123,10 @@ evil to happen: -Set the ENABLE_RAW_HTML to true in 'lib/plugin/RawHtml.php' to allow +Set the ENABLE_RAW_HTML to true in ' config/config.ini' to allow embedded HTML, but you should NEVER do this if your Wiki is publicly accessible! -define('ENABLE_RAW_HTML', true); - - 3. ETC Installing PHP is beyond the scope of this document :-) You should @@ -154,4 +154,4 @@ You can join this list at: FIN -$Id: INSTALL,v 1.23 2004-05-09 00:57:31 rurban Exp $ +$Id: INSTALL,v 1.24 2004-12-17 09:23:41 rurban Exp $ diff --git a/README b/README index 6dad97a41..bb316cfca 100644 --- a/README +++ b/README @@ -1,27 +1,33 @@ -PhpWiki is a web application licensed under the Gnu Public License, which +PhpWiki is a web application licensed under the GNU Public License, which should be included in the same directory as this README. A copy can be found at http://www.gnu.org/copyleft/gpl.txt. -See INSTALL for installation notes. -Read UPGRADE before upgrading from a previous version of PhpWiki. +See ../INSTALL for installation notes. +Read ../UPGRADING before upgrading from a previous version of PhpWiki. + +Additional docs: doc/: INSTALL.mysql for using PhpWiki with MySQL INSTALL.pgsql for using PhpWiki with PostgreSQL -INSTALL.flatfile for using PhpWiki with flatfile databases -INSTALL.mSQL for using PhpWiki with mSQL +INSTALL.oci8 for using PhpWiki with Oracle +INSTALL.sqlite for using PhpWiki with SQLite +INSTALL.flatfile for using PhpWiki with flat files, no database INSTALL.MacOSX for using PhpWiki in MacOSX +README.phpwiki-auth for using authentication +README.phpwiki-cache for using cached plugins content (VisualWiki, ...) README.coding for notes on modifying PhpWiki -DBLIB.txt +README.foaf for notes on the Friend Of A Friend network +THEMES for notes on customizing themes CREDITS HISTORY For a list of current bugs see: -https://sourceforge.net/bugs/?group_id=6121 + https://sourceforge.net/bugs/?group_id=6121 -The out-of-the-box version uses a dbm file in the /tmp directory; you may -wish a more permanent place for yours, but make sure it's read/writable -by your web server! +The fastest and out-of-the-box version uses DATABASE_TYPE=dba, +a dbm file in the /tmp directory; you may wish a more permanent +place for yours, but make sure it's read/writable by your web server! NOTE: Not all database versions are equal. The MySQL and Postgresql implementations have the full set of features; DBM and mSQL are diff --git a/UPGRADING b/UPGRADING index 1d070a90b..aefc6858f 100644 --- a/UPGRADING +++ b/UPGRADING @@ -1,13 +1,26 @@ +To migrate to a new phpwiki installation you have to backup your old pages +(best via a zip dump), configure your new installation, and restore the old +pages in PhpWikiAdministration. Or just upgrade your configuration as +described below. + +UPGRADING since 1.3.10 + +To upgrade default pages, the database and some config settings +add "?action=upgrade" to your HomePage url and press "Enter", which will +do most of the upgrades automatically. +You might need to enter the DBADMIN_USER and DBADMIN_PASSWD in +config/config.ini for SQL databases and default permissions. + UPGRADING from 1.3.9 At first you have to manually create a config/config.ini based on -config-dist.ini and your previous index.php. We don't have a script yet, +config-dist.ini and your previous index.php. We don't have a script, to do that automatically. mysql: ALTER TABLE page CHANGE id id INT NOT NULL AUTO_INCREMENT; NOTE: ?action=upgrade does this also, if your mysql user has the - ALTER permissions. +ALTER permissions or DBADMIN_USER and DBADMIN_PASSWD are set. UPGRADING from 1.3.7 @@ -108,8 +121,8 @@ some of the pages which need fixing are locked.) (at the bottom of the page). This should get you a list of all archived versions of the page. -4c. Browse to the archive 1.3 version of the page (probably version number -1) by clicking on the version number of the desired version. +4c. Browse to the archive 1.3 version of the page (probably version +number 1) by clicking on the version number of the desired version. 4d. Click the "Edit old revision" button (bottom of page). This should get you to the edit form. @@ -120,7 +133,7 @@ as the current contents. We really need to figure out a way to simplify this process, but, for now, that's what you gotta do. -An older note of mine on the same subject can be found at: - http://sourceforge.net/forum/message.php?msg_id=107858 +An older note on the same subject can be found at: + http://sourceforge.net/forum/message.php?msg_id=107858 -$Id: UPGRADING,v 1.8 2004-05-13 13:48:33 rurban Exp $ +$Id: UPGRADING,v 1.9 2004-12-17 09:23:41 rurban Exp $ diff --git a/doc/INSTALL.mysql b/doc/INSTALL.mysql index 28cf60d75..b08e3b39a 100644 --- a/doc/INSTALL.mysql +++ b/doc/INSTALL.mysql @@ -1,8 +1,9 @@ -FIXME: these instructions are slightly broken. - Installing phpwiki with MySQL ----------------------------- +A MySQL configuration is relatively hard to setup and slow, compared +to dba or better SQL databases. + This assumes that you have a working MySQL server and client setup. Installing MySQL is beyond the scope of this document. For more information on MySQL go to http://www.mysql.org/ @@ -50,8 +51,8 @@ For more information on MySQL go to http://www.mysql.org/ schemas/mysql-destroy.sql at the same time, so you don't forget.) -That's it. phpwiki should now work. DATABASE_DIRECTORY, -DATABASE_DBA_HANDLER and DATABASE_TIMEOUT are ignore for mysql. +That's it. Phpwiki should now work. +DATABASE_DIRECTORY and DATABASE_DBA_HANDLER are ignored for mysql. If you run into problems then check that your MySQL-user has the necessary access rights for the phpwiki tables. @@ -68,12 +69,13 @@ Upgrading a MySQL phpwiki If schemas/mysql-initialize.sql has changed for your old phpwiki installation (or changed when compared to the old "mysql.sql" file), you can either create missing tables manually and ALTER the changed -tables manually. Or you can run ?action=upgrade (also from "Upgrade" +tables manually. +Or you can run ?action=upgrade (also from "Upgrade" at PhpWikiAdministration), but then your database user needs the -necessary ALTER and CREATE permissions. You might change these -temporarily in your config.ini. action=upgrade also brings all -changed pgsrc files up-to-date. +necessary ALTER and CREATE permissions. +You might want to set DBADMIN_USER temporarly in your config.ini. +?action=upgrade also brings all changed pgsrc files up-to-date. -/Reini and Arno ahollosi@mail.com +/Reini Urban and Arno ahollosi@mail.com -$Id: INSTALL.mysql,v 1.6 2004-07-25 17:46:44 dfrankow Exp $ +$Id: INSTALL.mysql,v 1.7 2004-12-17 09:28:40 rurban Exp $ diff --git a/doc/INSTALL.pgsql b/doc/INSTALL.pgsql index 95d64a040..2094b7814 100644 --- a/doc/INSTALL.pgsql +++ b/doc/INSTALL.pgsql @@ -1,17 +1,12 @@ -Note: postgresql does work with phpwiki 1.3. +Note: postgresql does work with phpwiki 1.2.x and 1.3.x -FIXME: The pgsql backend has not yet been ported to the new database -scheme. (Though it should not be very hard, and is certainly in -the works.) - -See http://www.sslug.dk/~chlor/phpwiki-pgsql-install.html for notes how -to install it for 1.3.4 (and later) +You might want to see http://www.sslug.dk/~chlor/phpwiki-pgsql-install.html +for notes how to install it for 1.3.4 (and later) ---------- NOTE for the 1.2 release: You may see a few warnings when you first load the pages. They may look like this: - *** Warning: PostgresSQL query failed: ERROR: ExecAppend: Fail to add null value in not null attribute pagename in lib/pgsql.php on line 417 @@ -23,7 +18,6 @@ This is not a problem since PhpWiki is trying to update a table that tracks hits and links. ---------- - Installation instructions for PhpWiki with a Postgresql database Installation of Postgresql will not be discussed here... you can get a @@ -52,24 +46,25 @@ Postgresql to allow 32K per row, but supposedly performance suffers. The 7.x release of Postgresql is supposed to fix this. It's probably a good idea to install PhpWiki as-is first, running it -off the DBM file. This way you can test most of the functionality of -the Wiki. +off DATABASE_TYPE=dba, a single DBM file. This way you can test most +of the functionality of the Wiki. Once that's done and you have the basic stuff done that's listed in the INSTALL, the time comes to move to Postgresql. -Edit lib/config.php and edit $WhichDatabase for Postgresql. The lines -are clearly commented and you should have no problem with this. +Edit config.ini for Postgresql. The lines are clearly commented and +you should have no problem with this. -Next you need to create a database called "wiki". +Next you need to create a new database, like "phpwiki". -bash$ createdb wiki + bash$ createdb phpwiki Now run the script schemas/psql-initialize.sql to create the tables: -bash$ psql wiki -f schemas/psql-initialize.sql + bash$ psql phpwiki -f schemas/psql-initialize.sql -(Newer versions of postgresql will require: psql wiki < schemas/psql-initialize.sql) +Newer versions of postgresql will require: + bash$ pgql phpwiki < schemas/psql-initialize.sql If the schema starts to load but then fails near the end, you might need to change the user name at the top of psql-initialize.sql to @@ -86,4 +81,4 @@ swain@panix.com Report bugs to phpwiki-talk@lists.sourceforge.net -$Id: INSTALL.pgsql,v 1.5 2004-07-25 17:46:44 dfrankow Exp $ +$Id: INSTALL.pgsql,v 1.6 2004-12-17 09:28:40 rurban Exp $ diff --git a/doc/README.phpwiki-cache b/doc/README.phpwiki-cache index 78cf8e19a..14712e6b7 100644 --- a/doc/README.phpwiki-cache +++ b/doc/README.phpwiki-cache @@ -1,56 +1,25 @@ - InstallWikiPluginCached - !!!Requirements I don't know, tested it with the followings: * WikiPluginCached needs -** PhpWiki 1.3.3 -** Pear Cache 1.0 +** PhpWiki >= 1.3.3 +** Pear Cache >= 1.0 ** GD >= 1.6 * TexToPng needs ** TeX 3.14159 ** GNU Ghostscript 6.51 ** LaTex2HTML Version 99.2beta8 (1.43) -** Perl 5.6.1 built for i586-linux +** Perl >= 5.6.1 built for i586-linux * VisualWiki needs ** graphviz 1.8.x (http://www.graphviz.org/) !!!Installation -* EITHER copy the ....tar.gz into your phpwiki directory and use - tar -xvzf wikiplugincached-0.8.tar.gz - OR copy the following files manually: -** imagecache.php into lib/imagecache.php -** WikiPluginCached.php into lib/WikiPluginImageCache.php -** plugincache-config.php into lib/plugincache-config.php -** TexToPng.php into lib/plugin/TexToPng.php -** CacheTest.php into lib/plugin/CacheText.php -** VisualWiki.php into lib/plugin/VisualWiki.php -** RecentChangesCached.php into lib/plugin/RecentChangesCached.php -** Cache.php into lib/pear/Cache.php -** Error.php into lib/pear/Cache/Error.php -** Container.php into lib/pear/Cache/Container.php -** file.php into lib/pear/Cache/Container/file.php -** imgfile.php into lib/pear/Cache/Container/imgfile.php - - -* copy your own index.php config file into getimg.php - and substitute the wiki start up (to be found at the end of the file) - include "lib/main.php"; - by - include "lib/imagecache.php"; - -* modify configuration file plugincache-config.php according to your wishes, %%%especially: -** set 'cache_dir' to a directory accessible by your apache user. -** set database to 'file' -;:There is a hack which allows to let apache determine whether the image needs to be recreated. You have to include -a symbolic link from your wiki dir to your cache dir and make the getimg.php file the 404 ErrorDocument. So whenever Apache -tries to load an image not present in this dir, Apache will call the 404 (=file not found) ErrorDocument which creates the image -on the fly. You have to use 'imgfile' as database entry in plugincache-config.php, though. Furthermore you have to -replace the old value of 'cache_url' which should be '../getimg.php?' by '../path/to/cache'. Remember: This really is a hack because it needs my modified cache-filesystem-interface which is not part of the official pear distribution. - +phpwiki comes with its own copy of PEAR::Cache. +You have to configure the PLUGINCACHED Pear/Cache Settings in config/config.ini +* set PLUGIN_CACHED_CACHE_DIR to a directory accessible by your apache user. !!!Example Calls from Wiki !! TexToPng @@ -79,16 +48,14 @@ Standard call: Help: < ?plugin VisualWiki help="1" ?> - - -!!!Bugs +!!!Known Bugs WikiPluginCached 0.8 * VisualWiki and TexToPng use png image type for communication with the image creating scripts (dot and pstoimg), so they rely on CreateImageFronPNG(...) * RecentChangesCached produces a strange RSS-link for the RSS-image - when it has to store a new html sniplet in the cache immediately + when it has to store a new html snippet in the cache immediately after an edit/save cycle. diff --git a/pgsrc/PluginManager b/pgsrc/PluginManager index 04fd7c526..33bdee547 100644 --- a/pgsrc/PluginManager +++ b/pgsrc/PluginManager @@ -1,9 +1,9 @@ -Date: Thu, 3 Jun 2004 18:53:18 +0200 +Date: Fri, 17 Dec 2004 09:53:18 +0200 Mime-Version: 1.0 (Produced by PhpWiki 1.3.11pre) -X-Rcs-Id: $Id: PluginManager,v 1.7 2004-06-07 18:01:19 rurban Exp $ +X-Rcs-Id: $Id: PluginManager,v 1.8 2004-12-17 09:23:42 rurban Exp $ Content-Type: application/x-phpwiki; pagename=PluginManager; - pgsrc_version="2 $Revision: 1.7 $"; + pgsrc_version="2 $Revision: 1.8 $"; flags=PAGE_LOCKED; markup=2; charset=iso-8859-1 @@ -21,18 +21,24 @@ your wiki's root directory, the folder lib/plugin contains all the PHP files for the plugins. ! External Requirements -Some plugins require external libraries not provided with PhpWiki or PHP, such as +Some plugins require correctly configured PLUGIN_CACHED and external libraries +not provided with PhpWiki or PHP, such as * [PHP with GD support | php-function:ref.image] for the text2png plugin, -* [LaTeX2HTML | ftp://ftp.dante.de/tex-archive/support/latex2html ] for the TexToPngPlugin -* [graphviz | http://graphviz.org/] and a correctly configured lib/plugincache-config.php for the VisualWikiPlugin, +* [LaTeX2HTML | ftp://ftp.dante.de/tex-archive/support/latex2html ] for the TexToPngPlugin and TeX2pngPlugin, +* [graphviz | http://graphviz.org/] for the GraphVizPlugin and VisualWikiPlugin, * [ploticus | http://ploticus.sourceforge.net/] for the PloticusPlugin, * [phpweather | http://phpweather.sf.net] for the PhpWeatherPlugin, * [highlight | http://www.andre-simon.de/] for the SyntaxHighlighterPlugin, * a browser with [