diff --git a/Documentation.txt b/Documentation.txt index 531a33bb7..7f2ca6151 100644 --- a/Documentation.txt +++ b/Documentation.txt @@ -9,8 +9,8 @@ + Version history: [3]ChangeLog + General notes: [4]README + License: [5]LICENSE - * Documentation version: $Id: Documentation.html,v 1.45 2001/08/19 - 20:06:21 swix Exp $ + * Documentation version: $Id: Documentation.html,v 1.53 2001/08/23 + 07:21:03 swix Exp $ ______________________________________________________________________ [6]Top - [7]Requirements - [8]Introduction - [9]Installation - @@ -22,7 +22,7 @@ Requirements * PHP3 or PHP4: phpMyAdmin widely uses the 'str_replace()' php function that was added in PHP 3.0.6, but was buggy up until PHP 3.0.8. Then you should not run this script with PHP3 < 3.0.8. - PHP also needs to be compiled with mysql and PRCE support; + PHP also needs to be compiled with mysql and PCRE support; * MySQL (tested with 3.21.x, 3.22.x and 3.23.x); * a web-browser (doh!). ______________________________________________________________________ @@ -69,8 +69,8 @@ Installation values. 3. It is recommended that you protect the directory in which you installed phpMyAdmin (unless it's on a closed intranet), for - example with HTTP-AUTH (in a .htaccess file). See the FAQ section - for additional information. + example with HTTP-AUTH (in a .htaccess file). See the [30]FAQ + section for additional information. 4. Open the file //index.php3 in your browser. phpMyAdmin should now display a welcome screen and your databases, or a login dialog if using advanced @@ -83,17 +83,23 @@ Installation insert your site values in the new one. ______________________________________________________________________ - [30]Top - [31]Requirements - [32]Introduction - [33]Installation - - [34]Configuration - [35]FAQ - [36]Developers - [37]Credits + [31]Top - [32]Requirements - [33]Introduction - [34]Installation + - [35]Configuration - [36]FAQ - [37]Developers - [38]Credits ______________________________________________________________________ Configuration All configurable data is placed in config.inc.php3. + $cfgPmaAbsoluteUri string + Sets here the complete url (with full path) to your phpMyAdmin + version. E.g. + http://www.your_web.net/path_to_your_phpMyAdmin_directory/. + Don't forget the slash at the end of your url. + $cfgServers array Since version 1.4.2, phpMyAdmin supports the administration of - multiple MySQL-server. Therefore, a $cfgServers-array has been + multiple MySQL servers. Therefore, a $cfgServers-array has been added which contains the login information for the different servers. $cfgServers[1]['host'] contains the hostname of the first server, $cfgServers[2]['host'] the hostname of the second @@ -104,9 +110,18 @@ Configuration The hostname of your n-th MySQL-server. E.g. localhost. $cfgServers[n]['port'] string - The port-number of your n-th MySQL-server. Default is 3300 + The port-number of your n-th MySQL-server. Default is 3306 (leave blank). + $cfgServers[n]['socket'] string + The path to the socket to use. Leave blank for default. + + $cfgServers[n]['connect_type'] string + What type connection to use with the MySQL server. Your options + are 'socket' & 'tcp'. It defaults to 'tcp' as that is nearly + guarenteed to be available on all MySQL servers, while sockets + are not supported on some platforms. + $cfgServers[n]['adv_auth'] boolean Whether basic or advanced authentication should be used for this server. @@ -204,6 +219,13 @@ Configuration Defines whether BLOB fields are protected from edition when browsing a table's content or not. + $cfgAllowUserDropDatabase boolean + Defines whether standard users (non administrator) are allowed + to delete their own database or not. If set as FALSE, the link + "Drop Database" will not be shown, and even a "DROP DATABASE + mydatabase" will be rejected. Quite practical for ISP's with + many customers. + $cfgShowSQL boolean Defines whether sql-queries generated by phpMyAdmin should be displayed or not. @@ -286,8 +308,8 @@ Configuration need to edit this. ______________________________________________________________________ - [38]Top - [39]Requirements - [40]Introduction - [41]Installation - - [42]Configuration - [43]FAQ - [44]Developers - [45]Credits + [39]Top - [40]Requirements - [41]Introduction - [42]Installation + - [43]Configuration - [44]FAQ - [45]Developers - [46]Credits ______________________________________________________________________ FAQ - Frequently Asked Questions @@ -316,7 +338,7 @@ FAQ - Frequently Asked Questions The error message "Warning: MySQL Connection Failed: Can't connect to local MySQL server through socket '/tmp/mysql.sock' (111)...") is displayed. What can I do? - Here is a fix suggested by Brad Ummer in the [46]phpwizard forum: + Here is a fix suggested by Brad Ummer in the [47]phpwizard forum: * First, you need to determine what socket is being used by MySQL. To do this, telnet to your server and go to the MySQL bin directory. In this directory there should be a file named @@ -326,9 +348,9 @@ FAQ - Frequently Asked Questions * Then, you need to tell PHP to use this socket. Assuming you are using PHP 3.0.10 or better, you can specify the socket to use when you open the connection. To do this in - phpMyAdmin, you need to edit the host information in the - config.inc.php file using the format 'host_name:socket_name'. - For example: $cfgServers[n]['host'] = 'localhost:/tmp/mysql.sock'; + phpMyAdmin, you need to complete the socket information in the + config.inc.php3. + For example: $cfgServers[n]['socket'] = '/tmp/mysql.sock'; phpMyAdmin always gives "Access denied" when using advanced authentification. @@ -341,6 +363,14 @@ FAQ - Frequently Asked Questions phpMyAdmin-directory, eg. a .htaccess file. This would interfere with phpMyAdmin's authentification, so remove it. + When using advanced authentification, an user who logged out can not + relogs in with the same nick. + This is related to the authentification mechanism (protocol) used by + phpMyAdmin. We plan to change it as soon as we may find enough free + time to do it, but you can bypass this problem: just close all the + opened browser windows and then go back to phpMyAdmin. You should be + able to logs in again. + I would like to help out with the development of phpMyAdmin. How should I proceed? The following method is preferred for new developers: @@ -355,11 +385,11 @@ FAQ - Frequently Asked Questions [This will create a new sub-directory named phpMyAdmin] * add your stuff * put the modified files (tar'ed and gzip'ed) inside the patch - tracker of the [47]phpMyAdmin SourceForge account. + tracker of the [48]phpMyAdmin SourceForge account. Write access to the CVS tree is granted only to experienced developers who have already contributed something useful to phpMyAdmin. - Also, have a look at the [48]Developers section. + Also, have a look at the [49]Developers section. What's the preferred way of making phpMyAdmin secure against evil access? @@ -439,17 +469,24 @@ FAQ - Frequently Asked Questions 7.0 and you updated your php rpm to php-4.0.4pl1-3.i386.rpm, didn't you? So the problem is that this package has a serious bug that was - corrected ages ago in php (2001-01-28: see [49]php's bug tracking + corrected ages ago in php (2001-01-28: see [50]php's bug tracking system for more details). The problem is that the bugged package is - still available though it was corrected (see [50]redhat's bugzilla for + still available though it was corrected (see [51]redhat's bugzilla for more details). - So please download [51]the fixed package and the problem should go + So please download [52]the fixed package and the problem should go away. And that fixes the \r\n problem with file uploads! + + When I create a table, I click the Index checkbox for 2 fields and + phpMyAdmin generates only one index with those 2 fields. + In phpMyAdmin 2.2.0, this is the way to create a multi-fields index. + If you want two indexes, create the first one when creating the table, + save, then display the table properties and click the Index link to + create the other index. ______________________________________________________________________ - [52]Top - [53]Requirements - [54]Introduction - [55]Installation - - [56]Configuration - [57]FAQ - [58]Developers - [59]Credits + [53]Top - [54]Requirements - [55]Introduction - [56]Installation + - [57]Configuration - [58]FAQ - [59]Developers - [60]Credits ______________________________________________________________________ Developers Information @@ -469,7 +506,7 @@ Developers Information please try to keep your code as simple as possible: beginners are using phpMyAdmin as an example application. By the way, we're currently updating all the scripts so they will - be XHTML1.0 and CSS2 compliant on one hand, they will fit [60]PEAR + be XHTML1.0 and CSS2 compliant on one hand, they will fit [61]PEAR coding standards on the other hand. Please pay attention to this. * Please try to keep up the file-naming conventions. Table-related stuff goes to tbl_*.php3, db-related code to db_*.php3 and so on. @@ -492,7 +529,7 @@ Developers Information * add your stuff * put the modified files (tar'ed and gzip'ed) inside the patch tracker of the phpMyAdmin SourceForge account - ([61]http://sourceforge.net/projects/phpmyadmin/) + ([62]http://sourceforge.net/projects/phpmyadmin/) Write access to the CVS tree is granted only to developers who have already contributed something useful to phpMyAdmin. If you're @@ -500,8 +537,8 @@ Developers Information mailing list. ______________________________________________________________________ - [62]Top - [63]Requirements - [64]Introduction - [65]Installation - - [66]Configuration - [67]FAQ - [68]Developers - [69]Credits + [63]Top - [64]Requirements - [65]Introduction - [66]Installation + - [67]Configuration - [68]FAQ - [69]Developers - [70]Credits ______________________________________________________________________ Credits @@ -527,7 +564,7 @@ CREDITS, in chronological order * multi-language improvements, dynamic language selection * current project maintainer, with Marc and Loic -[lc] - Loïc Chapeaux +[lc] - Loïc Chapeaux * rewrote and optimized javascript, DHTML and DOM stuff * started to rewrite the scripts so they fit the PEAR coding standards and generate XHTML1.0 and CSS2 compliant codes @@ -551,6 +588,7 @@ CREDITS, in chronological order * "insert as new row" feature [pk] - Pete Kelly + * rewrote and fix dump code * bugfixes [sa] - Steve Alberty @@ -569,8 +607,8 @@ Ricardo ?, Sven-Erik Andersen, Alessandro Astarita, Borges Botelho, Olivier Bussier, Michal Cihar, Neil Darlow, Kristof Hamann, Thomas Kläger, Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Bernard M. Piller, Laurent Haas, "Sakamoto", www.securereality.com.au, -Michael Tacelosky, Daniel Villanueva, Vinay, Chee Wai, Jakub Wilk, -Thomas Michael Winningham. +Michael Tacelosky, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, +Chee Wai, Jakub Wilk, Thomas Michael Winningham. Original Credits of Version 2.1.0 @@ -579,33 +617,30 @@ Original Credits of Version 2.1.0 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea to create a web-based interface to MySQL using PHP3. Although I have not used any of his source-code, there are some concepts I've borrowed from - him. phpMyAdmin was created because Peter told me he wasn't going to furthe -r - develop his (great) tool. + him. phpMyAdmin was created because Peter told me he wasn't going to + further develop his (great) tool. Thanks go to - - Amalesh Kempf who contributed the code for - - the check when dropping a table or database. He also suggested that you - should be able to specify the primary key on tbl_create.php3. To version - 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as well as - a bug-report. Plus many smaller improvements. - - Jan Legenhausen : He made many of the changes that were - introduced in 1.3.0 (including quite significant ones like the + - Amalesh Kempf who contributed the + code for the check when dropping a table or database. He also suggested + that you should be able to specify the primary key on tbl_create.php3. To + version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as + well as a bug-report. Plus many smaller improvements. + - Jan Legenhausen : He made many of the changes that + were introduced in 1.3.0 (including quite significant ones like the authentification). For 1.4.1 he enhanced the table-dump feature. Plus bug-fixes and help. - - Marc Delisle made phpMyAdmin langua -ge- - independent by outsourcing the strings to a separate file. He also - contributed the French translation. - - Alexandr Bravo who contributed tbl_select.php3, - a feature to display only some fields from a table. - - Chris Jackson added support for MySQL functions in - tbl_change.php3. He also added the "Query by Example" feature in 2.0. - - Dave Walton added support for multiple servers -and - is a regular contributor for bug-fixes. - - Gabriel Ash contributed the random access features - for 2.0.6. + - Marc Delisle made phpMyAdmin + language-independent by outsourcing the strings to a separate file. He + also contributed the French translation. + - Alexandr Bravo who contributed + tbl_select.php3, a feature to display only some fields from a table. + - Chris Jackson added support for MySQL + functions in tbl_change.php3. He also added the "Query by Example" + feature in 2.0. + - Dave Walton added support for multiple + servers and is a regular contributor for bug-fixes. + - Gabriel Ash contributed the random access + features for 2.0.6. The following people have contributed minor changes, enhancements, bugfixes or support for a new language: Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann, @@ -614,26 +649,25 @@ and G. Wieggers. And thanks to everyone else who sent me email with suggestions, bug-reports - and - or just some feedback. + and or just some feedback. ______________________________________________________________________ - [70]Top - [71]Requirements - [72]Introduction - [73]Installation - - [74]Configuration - [75]FAQ - [76]Developers - [77]Credits + [71]Top - [72]Requirements - [73]Introduction - [74]Installation + - [75]Configuration - [76]FAQ - [77]Developers - [78]Credits ______________________________________________________________________ - [78]Valid XHTML 1.0! [79]Valid CSS! + [79]Valid XHTML 1.0! [80]Valid CSS! References 1. http://www.phpwizard.net/projects/phpMyAdmin/ 2. http://phpmyadmin.sourceforge.net/ - 46. http://www.phpwizard.net/phorum/list.php?f=1 - 47. https://sourceforge.net/projects/phpmyadmin/ - 49. http://www.php.net/bugs.php?id=8966 - 50. http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=24933 - 51. http://people.redhat.com/nalin/test/php-4.0.4pl1-7.i386.rpm - 60. http://pear.php.net/ - 61. http://sourceforge.net/projects/phpmyadmin/ - 78. http://validator.w3.org/check/referer - 79. http://jigsaw.w3.org/css-validator/ + 47. http://www.phpwizard.net/phorum/list.php?f=1 + 48. https://sourceforge.net/projects/phpmyadmin/ + 50. http://www.php.net/bugs.php?id=8966 + 51. http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=24933 + 52. http://people.redhat.com/nalin/test/php-4.0.4pl1-7.i386.rpm + 61. http://pear.php.net/ + 62. http://sourceforge.net/projects/phpmyadmin/ + 79. http://validator.w3.org/check/referer + 80. http://jigsaw.w3.org/css-validator/