bad query in query box
[phpmyadmin/crack.git] / Documentation.txt
blob5b661e628b57fc3b25668f7a49952a054874bf14
2                       phpMyAdmin 2.3.0-rc4 Documentation
3                                        
4      * Sourceforge phpMyAdmin project page   [ http://www.phpmyadmin.net/
5        ]
6      * Local documents:
7           + Version history: ChangeLog
8           + General notes: README
9           + License: LICENSE
10      * Documentation version: $Id: Documentation.html,v 1.301 2002/07/26
11        14:50:47 lem9 Exp $
12    ______________________________________________________________________
13    
14    Top  -  Requirements  -  Introduction  -  Installation  -
15    Configuration  -  FAQ  -  Developers  -  Credits
16    ______________________________________________________________________
17    
18 Requirements
20      * PHP3 or PHP4: phpMyAdmin widely uses the 'str_replace()' php
21        function that was added in PHP 3.0.6, but was buggy up until
22        PHP 3.0.8. Then you should not run this script with PHP3 < 3.0.8.
23        PHP also needs to be compiled with MySQL support;
24      * MySQL (tested with 3.21.x, 3.22.x, 3.23.x and 4.0.x);
25      * a web-browser (doh!).
26    ______________________________________________________________________
27    
28    Top  -  Requirements  -  Introduction  -  Installation  -
29    Configuration  -  FAQ  -  Developers  -  Credits
30    ______________________________________________________________________
31    
32 Introduction
34    phpMyAdmin can manage a whole MySQL-server (needs a super-user) but
35    also a single database. To accomplish the latter you'll need a
36    properly set up MySQL-user who can read/write only the desired
37    database. It's up to you to look up the appropriate part in the MySQL
38    manual. Currently phpMyAdmin can:
39      * create and drop databases
40      * create, copy, drop and alter tables
41      * delete, edit and add fields
42      * execute any SQL-statement, even batch-queries
43      * manage keys on fields
44      * load text files into tables
45      * create (*) and read dumps of tables
46      * export (*) and import data to CSV values
47      * administer multiple servers and single databases
48      * check referential integrity
49      * create complex queries automatically connecting required tables
50      * create PDF graphics of your Database layout
51      * communicate in more than 38 different languages
52        
53    (*)  phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats)
54    dumps and CSV exports if you use PHP4 >= 4.0.4 with Zlib support
55    (--with-zlib) and/or Bzip2 support (--with-bz2).
56    ______________________________________________________________________
57    
58    Top  -  Requirements  -  Introduction  -  Installation  -
59    Configuration  -  FAQ  -  Developers  -  Credits
60    ______________________________________________________________________
61    
62 Installation
64    NOTE: phpMyAdmin does not apply any special security methods to the
65    MySQL database server. It is still the sysadmin's job to grant
66    permissions on the MySQL databases properly.
67    
68    Warning for Mac users: php seems not to like Mac end of lines
69    character ("\r") and Stuffit unstuffs with Mac formats, of course.
70    So you'll have to resave as in Bbedit to unix style ALL phpMyAdmin
71    scripts before uploading them to your server.
72    
73    Documentation warning: when you see in this document a .php3 file
74    extension, please transpose to .php if you are using a kit with files
75    having this extension.
76    
77    Quick Install:
78     1. Use a distribution kit with the files having the extension (.php3
79        or .php) depending on the way your web/PHP server interprets those
80        extensions.
81     2. Untar or unzip the distribution (be sure to unzip the
82        subdirectories): tar xzvf phpMyAdmin_x.x.x.tar.gz in your
83        webserver's document root.
84     3. Open the file config.inc.php3 in your favourite editor and change
85        the values for host, user, password and authentication mode to fit
86        your environment. Also insert the correct value for
87        $cfg['PmaAbsoluteUri']. Have a look at Configuration section for
88        an explanation of all values.
89     4. It is recommended that you protect the directory in which you
90        installed phpMyAdmin (unless it's on a closed intranet, or you
91        wish to use http or cookie authentication), for example with
92        HTTP-AUTH (in a .htaccess file). See the FAQ section for
93        additional information.
94     5. Open the file <www.your-host.com>/<your-install-dir>/index.php3 in
95        your browser. phpMyAdmin should now display a welcome screen and
96        your databases, or a login dialog if using http or cookie
97        authentication mode.
98        
99    Upgrading from an older version:
100      * Please do not copy your older config.inc.php3 over the new one: it
101        may offer new configuration variables, and the new version may
102        depend on these for normal behavior. It is suggested instead to
103        insert your site values in the new one.
104        
105    Using authentication modes:
106      * Http and cookie authentication modes are recommended in a
107        multi-user environment where you want to give users access to
108        their own database and don't want them to play around with others.
109        Nevertheless be aware that MS Internet Explorer seems to be really
110        buggy about cookies, at least till version 6. And php 4.1.1 is
111        also a bit buggy in this area!
112      * Http and cookie authentication modes are more secure: the MySQL
113        password does not need to be set in the phpMyAdmin configuration
114        file. (except for the "controluser" -see the Configuration
115        section-).
116        However, keep in mind that the password travels in plain text,
117        unless you are using the https protocol.
118        In cookie mode, we send the password in a temporary cookie, so
119        most browsers should not store the password in their cookie file.
120      * For 'http' and 'cookie' modes, phpMyAdmin needs a controluser that
121        has only the SELECT privilege on the mysql.user (all columns
122        except "Password"), mysql.db (all columns) & mysql.tables_priv
123        (all columns except "Grantor" & "Timestamp") tables.
124        You must specify the details for the controluser in the
125        config.inc.php3 file under the $cfg['Servers'][$i]['controluser']&
126        $cfg['Servers'][$i]['controlpass'] settings.
127        This example assumes you want to use pma as the controluser and
128        pmapass as the controlpass:
129        
130        GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY
131    'pmapass';
132    GRANT SELECT (Host, User, Select_priv, Insert_priv, Update_priv,
133    Delete_priv, Create_priv, Drop_priv, Reload_priv, Shutdown_priv,
134    Process_priv, File_priv, Grant_priv, References_priv, Index_priv,
135    Alter_priv) ON mysql.user TO 'pma'@'localhost';
136    GRANT SELECT ON mysql.db TO 'pma'@'localhost';
137    GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv) ON
138    mysql.tables_priv TO 'pma'@'localhost';
139    ... and if you want to use the many new relation and bookmark
140    features:
141        GRANT SELECT, INSERT, UPDATE, DELETE ON <pma_db> TO
142    'pma'@'localhost'; (this of course requires you to have a special DB
143    for phpMyAdmin, the contents will be explained later)
144      * Then each of the true users should be granted of a set of
145        privileges on a set of particular databases but shouldn't have any
146        global privileges. For example, to grant the user real_user with
147        all privileges on the database user_base:
148           GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost
149        IDENTIFIED BY 'real_password';
150        What the user may now do is controlled entirely by the MySQL user
151        management system.
152        With http or cookie auth mode, you don't need to fill the
153        user/password fields inside the $cfg['Servers'] array.
154        
155    'http' authentication mode:
156      * Was called 'advanced' in versions before 2.2.3.
157      * Introduced in 1.3.0, it uses Basic HTTP authentication method and
158        allows you to login as any valid MySQL user.
159      * Is only supported with PHP running as an Apache module, not with
160        cgi.
161        
162    'cookie' authentication mode:
163      * You can use this method as a replacement for the http
164        authentication (for example, if you're running IIS).
165      * Obviously, the user must enable cookies in the browser.
166      * With this mode, the use can truly logout of phpMyAdmin and login
167        back with the same username.
168        
169    'config' authentication mode:
170      * This mode is the less secure one because it requires you to fill
171        the $cfg['Servers'][$i]['user'] and
172        $cfg['Servers'][$i]['password'] fields.
173        But you don't need to setup a "controluser" here: using the
174        $cfg['Servers'][$i]['only_db'] might be enough.
175      * In the ISP FAQ section, there is an entry explaining how to
176        protect your configuration file.
177      * For additional security in this mode, you may wish to consider the
178        Host authentication $cfg['Servers'][$i]['AllowDeny']['order'] and
179        $cfg['Servers'][$i]['AllowDeny']['rules'] configuration
180        directives.
181    ______________________________________________________________________
182    
183    Top  -  Requirements  -  Introduction  -  Installation  -
184    Configuration  -  FAQ  -  Developers  -  Credits
185    ______________________________________________________________________
186    
187 Configuration
189    Warning for Mac users: php seems not to like Mac end of lines
190    character ("\r"). So ensure you choose the option that allows to use
191    the *nix end of line character ("\n") in your text editor before
192    registering a script you have modified.
193    
194    All configurable data is placed in config.inc.php3.
195    
196    $cfg['PmaAbsoluteUri'] string
197           Sets here the complete url (with full path) to your phpMyAdmin
198           version. E.g.
199           http://www.your_web.net/path_to_your_phpMyAdmin_directory/.
200           Don't forget the slash at the end of your url. The url must
201           contain characters that are valid for a url, and on some
202           servers, the path is case-sensitive.
203           This setting can be dynamically completed. For example, you can
204           try to use such a kind of code:
205           
206 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
207                        . $_SERVER['HTTP_HOST']
208                        . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SER
209 VER_PORT'] : '')
210                        . substr($_SERVER['PHP_SELF'], 0, strrpos($_SERVER['PHP_
211 SELF'], '/')+1);
213     or
215 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
216                        . $_SERVER['SERVER_NAME']
217                        . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SER
218 VER_PORT'] : '')
219                        . substr($_SERVER['SCRIPT_NAME'], 0, strrpos($_SERVER['S
220 CRIPT_NAME'], '/')+1);
223           Please note that the $_SERVER array doesn't exist in
224           PHP < 4.1.0. Try to replace $_SERVER by $HTTP_SERVER_VARS or
225           $GLOBALS in this case.
226           
227    $cfg['PmaNoRelation_DisableWarning'] boolean
228           Starting with version 2.3.0 phpMyAdmin offers a lot of features
229           to work with master / foreign - tables. These features require
230           the PMA administrator to set up a special database for PMA (see
231           $cfg['Servers'][$i]['pmadb']). Its contents and use will be
232           explained further down.
233           If you tried to set this up and it does not work for you have a
234           look on the "Structure" page of one database where you would
235           like to use it. You will find a link that will analyze why
236           those features have been disabled.
237           If you do not want to use those features set this variable to
238           TRUE to stop this message from appearing.
239           
240    $cfg['Servers'] array
241           Since version 1.4.2, phpMyAdmin supports the administration of
242           multiple MySQL servers. Therefore, a $cfg['Servers']-array has
243           been added which contains the login information for the
244           different servers. The first $cfg['Servers'][$i]['host']
245           contains the hostname of the first server, the second
246           $cfg['Servers'][$i]['host'] the hostname of the second server,
247           etc. If you have only one server to administer, simply leave
248           free the hostname of the other $cfg['Server']-entries.
249           
250    $cfg['Servers'][$i]['host'] string
251           The hostname of your $i-th MySQL-server. E.g. localhost.
252           
253    $cfg['Servers'][$i]['port'] string
254           The port-number of your $i-th MySQL-server. Default is 3306
255           (leave blank).
256           
257    $cfg['Servers'][$i]['socket'] string
258           The path to the socket to use. Leave blank for default.
259           To use the socket feature you must run php 3.0.10 or more.
260           
261    $cfg['Servers'][$i]['connect_type'] string
262           What type connection to use with the MySQL server. Your options
263           are 'socket' & 'tcp'. It defaults to 'tcp' as that is nearly
264           guarenteed to be available on all MySQL servers, while sockets
265           are not supported on some platforms.
266           
267    $cfg['Servers'][$i]['controluser'] string
268           $cfg['Servers'][$i]['controlpass'] string
269           When using http or cookie authentication modes (or 'config'
270           authentication mode since phpMyAdmin 2.2.1), you need to supply
271           the details of a MySQL account that has SELECT privilege on the
272           mysql.user (all columns except "Password"), mysql.db (all
273           columns) & mysql.tables_priv (all columns except "Grantor" &
274           "Timestamp") tables. This account is used to check what
275           databases the user will see at login.
276           Please see the install section on "Using http authentication"
277           for more information.
278           Note that if you try login to phpMyAdmin with this
279           "controluser", you could get some errors, depending the exact
280           privileges you gave to the "controluser". phpMyAdmin does not
281           support a direct login with the "controluser".
282           In versions before 2.2.5, those were called "stduser/stdpass".
283           
284    $cfg['Servers'][$i]['auth_type'] string ['http'|'cookie'|'config']
285           Whether config or cookie or http authentication should be used
286           for this server.
287           
288           + 'config' authentication ($auth_type = 'config') is the plain
289             old way: username and password are stored in config.inc.php3.
290           + 'cookie' authentication mode ($auth_type = 'cookie') as
291             introduced in 2.2.3 allows you to log in as any valid MySQL
292             user with the help of... cookies. Log name and password are
293             stored in cookies during the session and password is deleted
294             when it ends.
295           + 'http' authentication (was called 'advanced' in older
296             versions) ($auth_type = 'http') as introduced in 1.3.0 allows
297             you to log in as any valid MySQL user via HTTP-Auth.
298             
299           Please see the install section on "Using authentication modes"
300           for more information.
301           
302    $cfg['Servers'][$i]['user'] string
303           $cfg['Servers'][$i]['password'] string
304           The user/password-pair which phpMyAdmin will use to connect to
305           this MySQL-server. This user/password pair is not needed when
306           http or cookie authentication is used, and should be empty.
307           
308    $cfg['Servers'][$i]['only_db'] string or array
309           If set to a(an array of) database name(s), only this(these)
310           database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
311           this/these database(s) name(s) may contain MySQL wilcards
312           characters ("_" and "%"): if you want to use literal instances
313           of these characters, escape them (ie use 'my\_db' and not
314           'my_db').
315           This setting is an efficient way to lower the server charge
316           since the latter does not need to send MySQL requests to build
317           the available database list. But it does not replace the
318           privileges rules of the MySQL database server. If set, it just
319           means only these databases will be displayed but not at all
320           other databases can't be used.
321           
322    $cfg['Servers'][$i]['verbose'] string
323           Only useful when using phpMyAdmin with multiple server entries.
324           If set, this string will be displayed instead of the hostname
325           in the pulldown menu on the main page. This can be useful if
326           you want to show only certain databases on your system, for
327           example.
328           
329    $cfg['Servers'][$i]['pmadb'] string
330           Starting with version 2.3.0 phpMyAdmin offers a lot of features
331           to work with master / foreign - tables. To use those as well as
332           the bookmark feature you will need to create a new db.
333           To use this functionality as superuser create a new database:
334           
335           + create a new database for phpmyadmin:
336               CREATE DATABASE phpmyadmin;
337             Note that "controluser" must have SELECT, INSERT and DELETE
338             privileges on this database. Here is a query to set up those
339             privileges (using "phpmyadmin" as the database name, and
340             "pma" as the controluser):
341               GRANT SELECT,INSERT,DELETE ON phpmyadmin.* to
342             'pma'@localhost;
343             do not give any other user rights on this database.
344           + enter the databasename in $cfg['Servers'][$i]['pmadb']
345             
346    $cfg['Servers'][$i]['bookmarktable'] string
347           Since release 2.2.0 phpMyAdmin allows to bookmark queries. This
348           can be useful for queries you often run.
349           To allow the usage of this functionality the superuser has to:
350           
351           + set up a PMA database as described above
352           + within this database create a table following this scheme:
353                  CREATE TABLE `PMA_bookmark` (
354                    id int(11) DEFAULT '0' NOT NULL auto_increment,
355                    dbase varchar(255) NOT NULL,
356                    user varchar(255) NOT NULL,
357                    label varchar(255) NOT NULL,
358                    query text NOT NULL,
359                    PRIMARY KEY (id)
360                  ) TYPE=MyISAM COMMENT='Bookmarks';
361           + enter the tablename in $cfg['Servers'][$i]['bookmarktable']
362             
363           Note that "controluser" must have SELECT, INSERT and DELETE
364           privileges on the bookmark table. Here is a query to set up
365           those privileges (using "pma" as the controluser and phpmyadmin
366           as databasename):
367             GRANT SELECT,INSERT,DELETE ON <phpmyadmin> to
368           'pma'@localhost;
369           
370    $cfg['Servers'][$i]['relation'] string
371           Since release 2.2.4 you can describe, in a special 'relation'
372           table, which field is a key in another table (a foreign key).
373           phpMyAdmin currently uses this to
374           
375           + make clickable, when you browse the master table, the data
376             values that point to the foreign table;
377           + display in an optional tooltip the "display field" when
378             browsing the master table, if you move the mouse to a column
379             containing a foreign key (use also the 'table_info' table);
380           + display links on the table properties page, to check
381             referential integrity (display missing foreign keys) for each
382             described key;
383           + in query-by-example, create automatic joins (see an example
384             in the FAQ, section "Using phpMyAdmin");
385           + enable you to get a PDF schema of your database (also uses
386             the table_coords table).
387             
388           The keys can be numeric or character.
389           To allow the usage of this functionality the superuser has to:
390           
391           + set up a PMA database as described above
392           + within this database create a table following this scheme:
393                  CREATE TABLE `PMA_relation` (
394                    `master_db` varchar(64) NOT NULL default '',
395                    `master_table` varchar(64) NOT NULL default '',
396                    `master_field` varchar(64) NOT NULL default '',
397                    `foreign_db` varchar(64) NOT NULL default '',
398                    `foreign_table` varchar(64) NOT NULL default '',
399                    `foreign_field` varchar(64) NOT NULL default '',
400                    PRIMARY KEY (`master_db`, `master_table`,
401             `master_field`),
402                    KEY foreign_field (foreign_db, foreign_table)
403                  ) TYPE=MyISAM COMMENT='Relation table';
404           + put the relation table name in
405             $cfg['Servers'][$i]['relation']
406           + now as normal user open phpMyAdmin and for each table where
407             you want to use this feature, click "Structure/Relation
408             view/" and choose foreign fields.
409             
410           Please note that in the current (2.3.0) version, master_db must
411           be the same as foreign_db. Those fields have been put in future
412           development of the cross-db relations.
413           
414    $cfg['Servers'][$i]['table_info'] string
415           Since release 2.3.0 you can describe, in a special 'table_info'
416           table, which field is to be displayed as a tooltip when moving
417           the cursor over the corresponding key.
418           This configuration variable will hold the name of this special
419           table. To allow the usage of this functionality the superuser
420           has to:
421           
422           + set up a PMA database as described above
423           + within this database create a table following this scheme:
424                  CREATE TABLE `PMA_table_info` (
425                    `db_name` varchar(64) NOT NULL default '',
426                    `table_name` varchar(64) NOT NULL default '',
427                    `display_field` varchar(64) NOT NULL default '',
428                    PRIMARY KEY (`db_name`, `table_name`)
429                  ) TYPE=MyISAM COMMENT='Table information for
430             phpMyAdmin';
431           + put the table name in $cfg['Servers'][$i]['table_info']
432           + then for each table where you want to use this feature, click
433             "Structure/Relation view/Choose field to display" to choose
434             the field.
435             
436           Usage tip: Display field.
437           
438    $cfg['Servers'][$i]['table_coords'] string
439           $cfg['Servers'][$i]['pdf_pages'] string
440           Since release 2.3.0 you can have phpMyAdmin create PDF pages
441           showing the relations between your tables. To do this it needs
442           two tables "pdf_pages" (storing information about the available
443           pdf pages) and "table_coords" (storing coordinates where each
444           table will be placed on a PDF schema output).
445           You must be using the "relation" feature and have a table of
446           PDF pages (see $cfg['Servers'][$i]['pdf_pages']) to create PDF
447           output.
448           To allow the usage of this functionality the superuser has to:
449           
450           + set up a PMA database as described above
451           + within this database create a table following this scheme:
452                  CREATE TABLE `PMA_table_coords` (
453                    `db_name` varchar(64) NOT NULL default '',
454                    `table_name` varchar(64) NOT NULL default '',
455                    `pdf_page_number` int NOT NULL default '0',
456                    `x` float unsigned NOT NULL default '0',
457                    `y` float unsigned NOT NULL default '0',
458                    PRIMARY KEY (`db_name`, `table_name`,
459             `pdf_page_number`)
460                  ) TYPE=MyISAM COMMENT='Table coordinates for phpMyAdmin
461             PDF output';
462           + also within this database create:
463                  CREATE TABLE `PMA_pdf_pages` (
464                    `db_name` varchar(64) NOT NULL default '',
465                    `page_nr` int(10) unsigned NOT NULL auto_increment,
466                    `page_descr` varchar(50) NOT NULL default '',
467                    PRIMARY KEY (page_nr),
468                    KEY (db_name)
469                  ) TYPE=MyISAM COMMENT='PDF Relationpages for PMA';
470           + put the first table name in
471             $cfg['Servers'][$i]['table_coords'] and the second table name
472             in $cfg['Servers'][$i]['pdf_pages']
473             
474           Usage tips: PDF output.
475           
476    $cfg['Servers'][$i]['column_comments'] string
477           Since release 2.3.0 you can store comments to describe each
478           column for each table. These will then be shown on the
479           "printview".
480           To allow the usage of this functionality the superuser has to:
481           
482           + set up a PMA database as described above
483           + within this database create a table following this scheme:
484                  CREATE TABLE `PMA_column_comments` (
485                    id int(5) unsigned NOT NULL auto_increment,
486                    db_name varchar(64) NOT NULL default '',
487                    table_name varchar(64) NOT NULL default '',
488                    column_name varchar(64) NOT NULL default '',
489                    comment varchar(255) NOT NULL default '',
490                    PRIMARY KEY (id),
491                    UNIQUE KEY db_name (db_name, table_name, column_name)
492                  ) TYPE=MyISAM COMMENT='Comments for Columns';
493           + put the table name in $cfg['Servers'][$i]['column_comments']
494             
495    $cfg['Servers'][$i]['AllowDeny']['order'] string
496           If your rule order is empty, then IP authentication is
497           disabled.
498           If your rule order is set to 'deny,allow' then the system
499           applies all deny rules followed by allow rules. Access is
500           allowed by default. Any client which does not match a Deny
501           command or does match an Allow command will be allowed access
502           to the server.
503           If your rule order is set to 'allow,deny' then the system
504           applies all allow rules followed by deny rules. Access is
505           denied by default. Any client which does not match an Allow
506           directive or does match a Deny directive will be denied access
507           to the server.
508           If your rule order is set to 'explicit', the authentication is
509           performed in a similar fashion to rule order 'deny,allow', with
510           the added restriction that your host/username combination must
511           be listed in the allow rules, and not listed in the deny rules.
512           This is the most secure means of using Allow/Deny rules, and
513           was available in Apache by specifying allow and deny rules
514           without setting any order.
515           
516    $cfg['Servers'][$i]['AllowDeny']['rules'] array of strings
517           The general format for the rules is as such:
518                 <'allow' | 'deny'> <username> [from] <ipmask>
519           If you wish to match all users, it is possible to use a '%' as
520           a wildcard in the username field.
521           There are a few shortcuts you can use in the ipmask field as
522           well:
523                'all' -> 0.0.0.0/0
524                'localhost' -> 127.0.0.1/8
525           Having an empty rule list is equivalent to either using 'allow
526           % from all' if your rule order is set to 'deny,allow' or 'deny
527           % from all' if your rule order is set to 'allow,deny' or
528           'explicit'.
529           For the IP matching system, the following work:
530           xxx.xxx.xxx.xxx (an exact IP address)
531           xxx.xxx.xxx.[yyy-zzz] (an IP address range)
532           xxx.xxx.xxx.xxx/nn (CIDR, Classless Inter-Domain Routing type
533           IP addresses)
534           But the following does not work:
535           xxx.xxx.xxx.xx[yyy-zzz] (partial IP address range)
536           
537    $cfg['ServerDefault'] integer
538           If you have more than one server configured, you can set
539           $cfg['ServerDefault'] to any one of them to autoconnect to that
540           server when phpMyAdmin is started, or set it to 0 to be given a
541           list of servers without logging in.
542           If you have only one server configured, $cfg['ServerDefault']
543           MUST be set to that server.
544           
545    $cfg['OBGzip'] boolean
546           Defines whether to use gzip output buffering for increased
547           speed in HTTP transfers.
548           
549    $cfg['PersistentConnections'] boolean
550           Whether persistent connections should be used or not
551           (mysql_connect or mysql_pconnect).
552           
553    $cfg['ExecTimeLimit'] integer [number of seconds]
554           Set the number of seconds a script is allowed to run. If
555           seconds is set to zero, no time limit is imposed.
556           This setting is used while importing/exporting dump files but
557           has no effect when PHP is running in safe mode.
558           
559    $cfg['SkipLockedTables'] boolean
560           Mark used tables and make it possible to show databases with
561           locked tables (since 3.23.30).
562           
563    $cfg['ShowSQL'] boolean
564           Defines whether sql-queries generated by phpMyAdmin should be
565           displayed or not.
566           
567    $cfg['AllowUserDropDatabase'] boolean
568           Defines whether normal users (non-administrator) are allowed to
569           delete their own database or not. If set as FALSE, the link
570           "Drop Database" will not be shown, and even a "DROP DATABASE
571           mydatabase" will be rejected. Quite practical for ISP's with
572           many customers.
573           
574    $cfg['Confirm'] boolean
575           Whether a warning ("Are your really sure..") should be
576           displayed when you're about to loose data.
577           
578    $cfg['ShowTooltip'] boolean
579           Defines whether to display table comment as tooltip in left
580           frame or not.
581           
582    $cfg['LeftFrameLight'] boolean
583           Defines whether to use select-based menu and display only the
584           current tables in the left frame (smaller page).
585           
586    $cfg['ShowMysqlInfo'] boolean
587           $cfg['ShowMysqlVars'] boolean
588           $cfg['ShowPhpInfo'] boolean
589           $cfg['ShowChgPassword'] boolean
590           Defines whether to display the "MySQL runtime information",
591           "MySQL system variables", "PHP information" and "Change
592           password " links or not for simple users at the starting main
593           (right) frame. This setting does not check MySQL commands
594           entered directly.
595           Please note that to block the usage of phpinfo() in scripts,
596           you have to put this in your php.ini:
597               disable_functions = phpinfo()
598           Also note that enabling the "Change password " link has no
599           effect with "config" authentication mode: because of the hard
600           coded password value in the configuration file, end users can't
601           be allowed to change their passwords.
602           
603    $cfg['SuggestDBName'] boolean
604           Defines whether to suggest a database name on the "Create
605           Database" form or to keep the textfield empty.
606           
607    $cfg['LoginCookieRecall'] boolean
608           Define whether the previous login should be recalled or not in
609           cookie authentication mode.
610           
611    $cfg['UseDbSearch'] boolean
612           Define whether the "search string inside database" is enabled
613           or not.
614           
615    $cfg['ShowStats'] boolean
616           Defines whether to display space usage and statistics about
617           databases and tables or not.
618           Note that statistics requires at least MySQL 3.23.3 and that,
619           at this date, MySQL doesn't return such information for
620           Berkeley DB tables.
621           
622    $cfg['ShowBlob'] boolean
623           Defines whether BLOB fields are shown when browsing a table's
624           content or not.
625           
626    $cfg['NavigationBarIconic'] boolean
627           Defines whether navigation bar buttons contain text or symbols
628           only.
629           
630    $cfg['ShowAll'] boolean
631           Defines whether an user should be displayed a "show all
632           (records)" button in browse mode or not.
633           
634    $cfg['MaxRows'] integer
635           Number of rows displayed when browsing a resultset. If the
636           resultset contains more rows, Previous/Next links will be
637           shown.
638           
639    $cfg['Order'] string [DESC|ASC|SMART]
640           Defines whether fields are displayed in ascending (ASC) order,
641           in descending (DESC) order or in a "smart" (SMART) order -ie
642           descending order for fields of type TIME, DATE, DATETIME &
643           TIMESTAMP, ascending order else- by default.
644           
645    $cfg['ProtectBinary'] boolean or string
646           Defines whether BLOB or BINARY fields are protected from
647           edition when browsing a table's content or not. Valid values
648           are:
649           - FALSE to allow edition of all fields;
650           - blob to allow edition of all fields except BLOBS;
651           - all to disallow edition of all BINARY or BLOB fields.
652           
653    $cfg['ShowFunctionFields'] boolean
654           Defines whether MySQL functions fields should be displayed or
655           not in edit/insert mode.
656           
657    $cfg['ZipDump'] boolean
658           $cfg['GZipDump'] boolean
659           $cfg['BZipDump'] boolean
660           Defines whether to allow the use of zip/gzip/bzip compression
661           when creating a dump file or not.
662           
663    $cfg['DefaultTabDatabase'] string
664           Defines the tab displayed by default on database view. Possible
665           values: "db_details_structure.php3", "db_details.php3" or
666           "db_search.php3".
667           
668    $cfg['DefaultTabTable'] string
669           Defines the tab displayed by default on table view. Possible
670           values: "tbl_properties_structure.php3", "tbl_properties.php3",
671           "tbl_select.php3" or "tbl_change.php3".
672           
673    $cfg['ManualBaseShort'] string
674           If set to an URL which points to the MySQL documentation (on
675           short pages), appropriate help links are generated.
676           
677    $cfg['DefaultLang'] string
678           Defines the default language to use, if not browser-defined or
679           user-defined.
680           See the select_lang.inc.php3 script to know the valid values
681           for this setting.
682           
683    $cfg['Lang'] string
684           Force: always use this language (must be defined in the
685           select_lang.inc.php3 script).
686           
687    $cfg['DefaultCharset'] string
688           Default charset to use for recoding of MySQL queries. This must
689           be enabled and it's described by $cfg['AllowAnywhereRecoding']
690           option.
691           You can give here any charset which is in
692           $cfg['AvailableCharsets'] array and this is just default
693           choice, user can select any of them.
694           
695    $cfg['AllowAnywhereRecoding'] boolean
696           Allow charset recoding of MySQL queries. You need recode or
697           iconv support (compiled in or module) in php to allow MySQL
698           queries recoding and used language file must have it enabled
699           (by default only these which are in unicode, just to avoid
700           losing some characters).
701           
702    $cfg['AvailableCharsets'] array
703           Available charsets for MySQL conversion. You can add your own
704           (any of supported by recode/iconv) or remove these which you
705           don't use. Charsets will be shown in same order as here listed,
706           so if you frequently use some of these move them to the top.
707           
708    $cfg['LeftWidth'] integer
709           Left frame width in pixel.
710           
711    $cfg['LeftBgColor'] string [HTML color]
712           $cfg['RightBgColor'] string [HTML color]
713           The background colors (HTML) used for both the frames.
714           
715    $cfg['RightBgImage'] string
716           The URI of the background image used for the right frame. It
717           can be absolute as well as relative from your phpMyAdmin
718           directory.
719           
720    $cfg['LeftPointerColor'] string [HTML color]
721           The color (HTML) used for the pointer in the left frame (does
722           not work with NS4).
723           
724    $cfg['Border'] integer
725           The size of a table's border.
726           
727    $cfg['ThBgcolor'] string [HTML color]
728           The color (HTML) used for table headers.
729           
730    $cfg['BgcolorOne'] string [HTML color]
731           The color (HTML) #1 for table rows.
732           
733    $cfg['BgcolorTwo'] string [HTML color]
734           The color (HTML) #2 for table rows.
735           
736    $cfg['BrowsePointerColor'] string [HTML color]
737           $cfg['BrowseMarkerColor'] string [HTML color]
738           The colors (HTML) uses for the pointer and the marker in browse
739           mode (does not work with NS4).
740           The former feature highlights the row over which your mouse is
741           passing and the latter lets you visually mark/unmark rows by
742           clicking on them.
743           You can disable both of these features by emptying the
744           respective directive.
745           
746    $cfg['TextareaCols'] integer
747           $cfg['TextareaRows'] integer
748           Number of columns and rows for the textareas.
749           This value will be emphasized (*2) for sql query textareas.
750           
751    $cfg['LimitChars'] integer
752           Maximal number of Chars showed in a TEXT OR a BLOB field on
753           browse view. Can be turned off by a toggle button on the browse
754           page.
755           
756    $cfg['ModifyDeleteAtLeft'] boolean
757           $cfg['ModifyDeleteAtRight'] boolean
758           Defines the place where modify and delete links would be put
759           when tables contents are displayed (you may have them displayed
760           both at the left and at the right). "Left" and "right" are
761           parsed as "top" and "bottom" with vertical display mode.
762           
763    $cfg['DefaultDisplay'] string
764           There are 2 display modes: horizontal and vertical. Define
765           which one is displayed by default.
766           
767    $cfg['RepeatCells'] integer
768           Repeat the headers every X cells, or 0 to deactivate.
769           
770    $cfg['ColumnTypes'] array
771           All possible types of a MySQL column. In most cases you don't
772           need to edit this.
773           
774    $cfg['AttributeTypes'] array
775           Possible attributes for fields. In most cases you don't need to
776           edit this.
777           
778    $cfg['Functions'] array
779           A list of functions MySQL supports. In most cases you don't
780           need to edit this.
781           
782    $cfg['keywords'] array
783           A list of keywords that is used for syntax coloring. All
784           keywords that are in this list will also get a new line before
785           them.
786           Usually you won't need to change those.
787    ______________________________________________________________________
788    
789    Top  -  Requirements  -  Introduction  -  Installation  -
790    Configuration  -  FAQ  -  Developers  -  Credits
791    ______________________________________________________________________
792    
793 FAQ - Frequently Asked Questions
795    Server  -  Configuration  -  Limitations  -  Multi-user  -  Browsers
796    -  Usage tips  -  Project
797    
798   [1. Server]
799   
800    [1.1] I'm running php 4+ and my server is crashing each time a
801    specific action is required or phpMyAdmin sends a blank page or a page
802    full of cryptic characters to my browser, what can I do?
803    There are some known php bugs with output buffering and compression.
804    Try to set the $cfg['OBGzip'] directive to FALSE in your
805    config.inc.php or .php3 file and the zlib.output_compression directive
806    to Off in your php configuration file.
807    Furthermore, we know about such problems connected to the release
808    candidates of php 4.2.0 (tested with php 4.2.0 RC1 to RC4) together
809    with MS Internet Explorer. Please upgrade to the release version php
810    4.2.0.
811    
812    [1.2] My Apache server crashes when using phpMyAdmin.
813    You should first try the latest versions of Apache (and possibly
814    MySQL).
815    See also the other FAQ entry about php bugs with output buffering.
816    If your server keeps crashing, please ask for help in the various
817    Apache support groups.
818    
819    [1.3] I'm running phpMyAdmin with "cookie" authentication mode under
820    PHP 4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the
821    script: I'm always displayed the login screen.
822    This is a kown PHP bug (see this bug report) from the official php bug
823    database. It means there is and won't be any phpMyAdmin fix against it
824    because there is no way to code a fix.
825    
826    [1.4] Using phpMyAdmin on IIS, I'm displayed the error message: "The
827    specified CGI application misbehaved by not returning a complete set
828    of HTTP headers...."
829    You just forgot to read the install.txt file from the php
830    distribution. Have a look at the last message in this bug report from
831    the official php bug database.
832    
833    [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
834    messages with the http or advanced authentication mode.
835    This is a known problem with the php ISAPI filter: it's not so stable.
836    For some more information and complete testings see the messages
837    posted by André B. aka "djdeluxe76" in this thread from the phpWizard
838    forum.
839    Please use instead the cookie authentication mode.
840    
841    [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!
842    This seems to be a PWS bug. Filippo Simoncini found a workaroud (at
843    this time there is no better fix): remove or comment the DOCTYPE
844    declarations (3 lines) from the scripts header.inc.php3, index.php3,
845    left.php3 and libraries/common.lib.php3.
846    
847    [1.7] How can I GZip or Bzip a dump or a CSV export. It seems to not
848    work?
849    These features are based on the gzencode() and bzcompress() php
850    functions to be more independent of the platform (Unix/Windows, Safe
851    Mode or not, and so on). So, you must have PHP4 >= 4.0.4 and
852    Zlib/Bzip2 support (--with-zlib and --with-bz2).
853    We faced php crashes when trying to download a dump with MS Internet
854    Explorer when phpMyAdmin is run with a release candidate of php 4.2.0.
855    In this case you should switch to the release version of php 4.2.0.
856    
857    [1.8] I cannot insert a text file in a table, and I get an error about
858    safe mode being in effect.
859    Your uploaded file is saved by PHP in the "upload dir", as defined in
860    php.ini by the variable upload_tmp_dir (usually the system default is
861    /tmp).
862    We recommend the following setup for Apache servers running in safe
863    mode, to enable uploads of files while being reasonably secure:
864      * create a separate directory for uploads: mkdir /tmp/php
865      * give ownership to the Apache server's user.group: chown
866        apache.apache /tmp/php
867      * give proper permission: chmod 600 /tmp/php
868      * put upload_tmp_dir = /tmp/php in php.ini
869      * restart Apache
870        
871    [1.9] I'm having troubles when uploading files. In general file
872    uploads don't work on my system and uploaded files have a
873    Content-Type: header in the first line.
874    It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat
875    7.0 and you updated your php rpm to php-4.0.4pl1-3.i386.rpm, didn't
876    you?
877    So the problem is that this package has a serious bug that was
878    corrected ages ago in php (2001-01-28: see php's bug tracking system
879    for more details). The problem is that the bugged package is still
880    available though it was corrected (see redhat's bugzilla for more
881    details).
882    So please download the fixed package (4.0.4pl1-9) and the problem
883    should go away.
884    And that fixes the \r\n problem with file uploads!
885    
886    [1.10] I'm having troubles when uploading files with phpMyAdmin
887    running on a secure server. My browser is Internet Explorer and I'm
888    using the Apache server.
889    As suggested by "Rob M" in the phpWizard forum, add this line to your
890    httpd.conf:
891        SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown
892    It seems to clear up many problems between IE and SSL.
893    
894    [1.11] I get an 'open_basedir restriction' while uploading a file from
895    the query box.
896    Since version 2.2.4, phpMyAdmin supports servers with open_basedir
897    restrictions. Assuming that the restriction allows you to open files
898    in the current directory ('.'), all you have to do is create a 'tmp'
899    directory under the phpMyAdmin install directory, with permissions 777
900    and the same owner as the owner of your phpMyAdmin directory. The
901    uploaded files will be moved there, and after execution of your SQL
902    commands, removed.
903    
904    [1.12] I have lost my MySQL root password, what can I do?
905    The MySql manual explains how to reset the permissions.
906    
907    [1.13] I get an error 'No SQL query' when trying to execute a
908    bookmark.
909    If PHP does not have read/write access to its upload_tmp_dir, it
910    cannot access the uploaded query.
911    
912    [1.14] I get an error 'No SQL query' when trying to submit a query
913    from the convenient text area.
914    Check the post_max_size directive from your php configuration file and
915    try to increase it.
916    
917    [1.15] I have problems with mysql.user field names.
918    In older MySQL versions, the User and Password fields were named user
919    and password. Please modify your field names to align with current
920    standards.
921    
922    [1.16] I cannot upload big dump files.
923    The first things to check (or ask your host provider to check) are the
924    values of upload_max_filesize, memory_limit and post_max_size in the
925    php.ini configuration file.
926    All of these three settings limit the maximum size of data that can be
927    submitted and handled by php. One user also said that post_max_size
928    and memory_limit need to be larger than upload_max_filesize.
929    
930    [1.17] Does phpMyAdmin support MySQL 4?
931    MySQL 4 is not yet fully supported by phpMyAdmin.
932    Because of MySQL 4's backwards compatibility you can use phpMyAdmin
933    for administering MySQL 4 servers, but phpMyAdmin does not yet support
934    its new features. Please notice that in this case it is recommended to
935    use php >= 4.1 since older versions of php are not compatible to
936    MySQL 4.
937    Furthermore, several users reported problems with phpMyAdmin related
938    to bugs in MySQL 4. MySQL 4 is still an alpha release and should be
939    used for test purposes only!
940    
941    [1.18] I'm running MySQL <= 4.0.1 having lower_case_table_names set to
942    1. If I create a new table with a capital letter in its name it is
943    changed to lowercase as it should. But if I try to DROP this table
944    MySQL is unable to find the corresponding file.
945    This is a bug of MySQL <= 4.0.1. Please upgrade to at least
946    MySQL 4.0.2 or turn off your lower_case_table_names directive.
947    
948    [1.19] I can't run the "display relations" feature because the script
949    seems not to know the font face I'm using!
950    The "FPDF" library we're using for this feature requires some special
951    files to use font faces.
952    Please refers to the FPDF manual to build these files.
953    
954    [1.20] I receive the error "cannot load MySQL extension, please check
955    PHP Configuration".
956    To connect to a MySQL server, PHP needs a set of MySQL functions
957    called "MySQL extension". This extension may be part of the PHP server
958    (compiled-in), otherwise it needs to be loaded dynamically. Its name
959    is probably mysql.so or mysql.dll. phpMyAdmin tried to load the
960    extension but failed.
961    Usually, the problem is solved by installing a software package called
962    "PHP-MySQL" or something similar.
963    
964   [2. Configuration]
965   
966    [2.1] The error message "Warning: Cannot add header information -
967    headers already sent by ..." is displayed, what's the problem?
968    Edit your config.inc.php or .php3 file and ensure there is nothing (ie
969    no blank lines, no spaces, no characters...) neither before the <?php
970    tag at the beginning, neither after the ?> tag at the end.
971    
972    [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
973    Either there is an error with your PHP setup or your username/password
974    is wrong. Try to make a small script which uses mysql_connect and see
975    if it works. If it doesn't, it may be you haven't even compiled MySQL
976    support into PHP.
977    
978    [2.3] The error message "Warning: MySQL Connection Failed: Can't
979    connect to local MySQL server through socket '/tmp/mysql.sock'
980    (111)...") is displayed. What can I do?
981    For RedHat users, Harald Legner suggests this on the mailing list:
982    On my RedHat-Box the socket of mysql is /var/lib/mysql/mysql.sock. In
983    your php.ini you will find a line
984        mysql.default_socket = /tmp/mysql.sock
985    change it to
986        mysql.default_socket = /var/lib/mysql/mysql.sock
987    Then restart apache and it will work.
988    Here is a fix suggested by Brad Ummer in the phpwizard forum:
989      * First, you need to determine what socket is being used by MySQL.
990        To do this, telnet to your server and go to the MySQL bin
991        directory. In this directory there should be a file named
992        mysqladmin. Type ./mysqladmin variables, and this should give you
993        a bunch of info about your MySQL server, including the socket
994        (/tmp/mysql.sock, for example).
995      * Then, you need to tell PHP to use this socket.
996        Assuming you are using PHP 3.0.10 or better, you can specify the
997        socket to use when you open the connection. To do this in
998        phpMyAdmin, you need to complete the socket information in the
999        config.inc.php3.
1000        For example: $cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';
1001        
1002    Have also a look at the corresponding section of the MySQL
1003    documentation.
1004    
1005    [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin,
1006    what can I do?
1007    Try to set the $cfg['OBGZip'] directive to FALSE in the phpMyAdmin
1008    configuration file. It helps sometime.
1009    Also have a look at your php version number: if it contains "4.0b..."
1010    it means you're running a beta version of PHP. That's not a so good
1011    idea, please upgrade to a plain revision.
1012    
1013    [2.5] Each time I want to insert or change a record or drop a database
1014    or a table, an error 404 (page not found) is displayed or, with http
1015    or cookie authentication, I'm asked to login again. What's wrong?
1016    Check the value you set for the $cfg['PmaAbsoluteUri'] directive in
1017    the phpMyAdmin configuration file.
1018    
1019   [3. Known limitations]
1020   
1021    [3.1] When using http authentication, an user who logged out can not
1022    relog in with the same nick.
1023    This is related to the authentication mechanism (protocol) used by
1024    phpMyAdmin. We plan to change it as soon as we may find enough free
1025    time to do it, but you can bypass this problem: just close all the
1026    opened browser windows and then go back to phpMyAdmin. You should be
1027    able to logs in again.
1028    
1029    [3.2] When dumping a large table in compressed mode, I get a memory
1030    limit error or a time limit error.
1031    As of version 2.2.4, we build the compressed dump in memory, so large
1032    tables dumps may hang. The only alternative we can think about (using
1033    system calls to mysqldump then gzip or bzip2) would not be applicable
1034    in environments where PHP is in safe mode: access to system programs
1035    is is limited by the system administrator, and time limit is enforced.
1036    
1037    [3.3] With InnoDB tables, I lose foreign key relationships when I
1038    rename or alter a table.
1039    This seems to be a InnoDB bug (fixed in MySQL 3.23.50?). However, keep
1040    in mind that phpMyAdmin as of version 2.3.0 does not support InnoDB.
1041    
1042   [4. ISPs, multi-user installations ]
1043   
1044    [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I
1045    need to install it for each customer?
1046    Since version 2.0.3, you can setup a central copy of phpMyAdmin for
1047    all your users. The development of this feature was kindly sponsored
1048    by NetCologne GmbH. This requires a properly setup MySQL user
1049    management and phpMyAdmin http or cookie authentication. See the
1050    install section on "Using http authentication".
1051    
1052    [4.2] What's the preferred way of making phpMyAdmin secure against
1053    evil access?
1054    This depends on your system.
1055    If you're running a server which cannot be accessed by other people,
1056    it's sufficient to use the directory protection bundled with your
1057    webserver (with Apache you can use .htaccess files, for example).
1058    If other people have telnet access to your server, you should use
1059    phpMyAdmin's http authentication feature.
1060    Suggestions:
1061      * Your config.inc.php3 file should be chmod 660.
1062      * All your phpMyAdmin files should be chown phpmy.apache, where
1063        phpmy is a user whose password is only known to you, and apache is
1064        the group under which Apache runs.
1065      * You should use PHP safe mode, to protect from other users that try
1066        to include your config.inc.php3 in their scripts.
1067        
1068    [4.3] I get errors about not being able to include a file in /lang or
1069    in /libraries.
1070    Check php.ini, or ask your sysadmin to check it. The include_path must
1071    contain "." somewhere in it, and open_basedir, if used, must contain
1072    "." and "./lang" to allow normal operation of phpMyAdmin.
1073    
1074    [4.4] phpMyAdmin always gives "Access denied" when using http
1075    authentication.
1076    This could happen for several reasons:
1077      * $cfg['Servers'][$i]['controluser'] and/or
1078        $cfg['Servers'][$i]['controlpass'] are wrong.
1079      * The username/password you specify in the login-dialog are invalid.
1080      * You have already setup a security mechanism for the
1081        phpMyAdmin-directory, eg. a .htaccess file. This would interfere
1082        with phpMyAdmin's authentication, so remove it.
1083        
1084    [4.5] Is it possible to let users create their own databases?
1085    Starting with 2.2.5, in the user management page, you can enter a
1086    wildcard database name for a user, and put the privileges you want.
1087    For example, adding SELECT, INSERT, UPDATE, DELETE, CREATE, DROP,
1088    INDEX, ALTER would let a user create/manage his/her database(s).
1089    
1090    [4.6] How can I use the Host-based authentication additions?
1091    If you have existing rules from an old .htaccess file, you can take
1092    them and add a username between the 'deny'/'allow' and 'from' strings.
1093    Using the username wildcard of '%' would be a major benefit here if
1094    your installation is suited to using it. Then you can just add those
1095    updated lines into the $cfg['Servers'][$i]['AllowDeny']['rules']
1096    array.
1097    If you want a pre-made sample, you can try this fragment. It stops the
1098    'root' user from logging in from any networks other than the private
1099    network IP blocks.
1100        //block root from logging in except from the private networks
1101        $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';
1102        $cfg['Servers'][$i]['AllowDeny']['rules'] = array(
1103            'deny root from all',
1104            'allow root from localhost',
1105            'allow root from 10.0.0.0/8',
1106            'allow root from 192.168.0.0/16',
1107            'allow root from 172.16.0.0/12',
1108            );
1109    
1110   [5. Browsers or client OS]
1111   
1112    [5.1] I get an out of memory error, and my controls are
1113    non-functional, when trying to create a table with more than 14
1114    fields.
1115    We could reproduce this problem only under Win98/98SE. Testing under
1116    WinNT4 or Win2K, we could easily create more than 60 fields.
1117    A workaround is to create a smaller number of fields, then come back
1118    to your table properties and add the other fields.
1119    
1120    [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
1121    This is not a phpMyAdmin problem but a Xitami known bug: you'll face
1122    it with each script/website that use forms.
1123    Upgrade or downgrade your Xitami server.
1124    
1125    [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2)
1126    With Konqueror 2.1.1: plain dumps, zip and gzip dumps work ok, except
1127    that the proposed file name for the dump is always 'tbl_dump.php'.
1128    Bzip2 dumps don't seem to work.
1129    With Konqueror 2.2.1: plain dumps work; zip dumps are placed into the
1130    user's temporary directory, so they must be moved before closing
1131    Konqueror, or else they disappear. Gzip dumps give an error message.
1132    Testing needs to be done for Konqueror 2.2.2.
1133    
1134    [5.4] I can't use the cookie authentication mode because Internet
1135    Explorer never stores the cookies.
1136    MS Internet Explorer seems to be really buggy about cookies, at least
1137    till version 6. And thanks to Andrew Zivolup we've traced also a php
1138    4.1.1 bug in this area!
1139    Then, if you're running php 4.1.1, try to upgrade or downgrade... it
1140    may work!
1141    
1142    [5.5] In Internet Explorer 5.0, I get Javascript errors when browsing
1143    my rows.
1144    Upgrade to at least Internet Explorer 5.5SP2.
1145    
1146    [5.6] In Internet Explorer 5.0, 5.5 or 6.0, I get an error when trying
1147    to modify a row in a table with many fields, or with a text field.
1148    Your table neither have a primary key nor an unique one, so we must
1149    use a long URL to identify this row. There is a limit on the lenght of
1150    the URL in those browsers, and this not happen in Netscape, for
1151    example. The workaround is to create a primary or unique key, or use
1152    another browser.
1153    
1154    [5.7] I refresh (reload) my browser, and come back to the welcome
1155    page.
1156    Some browsers support right-clicking into the frame you want to
1157    refresh, just do this in the right frame.
1158    
1159    [5.8] With Mozilla 0.9.7 I have problems sending a query modified in
1160    the query box.
1161    Looks like a Mozilla bug: 0.9.6 was ok. We will keep an eye on future
1162    Mozilla versions.
1163    
1164    [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
1165    whitespace in the SQL-Query edit area: the page scrolls down.
1166    This is a Mozilla bug (see bug #26882 at Bugzilla).
1167    
1168    [5.10] With Netscape 4.75 I get empty rows between each row of data in
1169    a CSV exported file.
1170    This is a known Netscape 4.75 bug: it adds some line feeds when
1171    exporting data in octet-stream mode. Since we can't detect the
1172    specific Netscape version, we cannot workaround this bug.
1173    
1174   [6. Using phpMyAdmin]
1175   
1176    [6.1] I can't insert new rows into a table - MySQL brings up a
1177    SQL-error.
1178    Examine the SQL error with care. I've found that many programmers
1179    specifying a wrong field-type.
1180    Common errors include:
1181      * Using VARCHAR without a size argument
1182      * Using TEXT or BLOB with a size argument
1183        
1184    Also, look at the syntax chapter in the MySQL manual to confirm that
1185    your syntax is correct.
1186    
1187    [6.2] When I create a table, I click the Index checkbox for 2 fields
1188    and phpMyAdmin generates only one index with those 2 fields.
1189    In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a
1190    multi-fields index. If you want two indexes, create the first one when
1191    creating the table, save, then display the table properties and click
1192    the Index link to create the other index.
1193    
1194    [6.3] How can I insert a null value into my table?
1195    Since version 2.2.3, you have a checkbox for each field that can be
1196    null. Before 2.2.3, you had to enter "null", without the quotes, as
1197    the field's value.
1198    
1199    [6.4] How can I backup my database or table?
1200    Click on a database or table name in the left frame, the properties
1201    will be displayed. Then on the menu, click "Export", you can dump the
1202    structure, the data, or both. This will generate standard SQL
1203    statements that can be used to recreate your database/table.
1204    You will need to choose "Save as file", so that phpMyAdmin can
1205    transmit the resulting dump to your station. Depending on your PHP
1206    configuration, you will see options to compress the dump. See also the
1207    $cfg['ExecTimeLimit'] configuration variable.
1208    For additional help on this subject, look for the word "dump" in this
1209    document.
1210    
1211    [6.5] How can I restore (upload) my database or table using a dump?
1212    Click on a database name in the left frame, the properties will be
1213    displayed. Then in the "Run SQL query" section, type in your local
1214    dump filename, or use the Browse button. Then click Go.
1215    For additional help on this subject, look for the word "upload" in
1216    this document.
1217    
1218    [6.6] How can I use the relation table in Query-by-example?
1219    Here is an example with the tables persons, towns and countries, all
1220    located in the database mydb. If you don't have a PMA_relation table,
1221    create it as explained in the configuration section. Then create the
1222    example tables:
1223         CREATE TABLE countries (
1224           country_code char(1) NOT NULL default '',
1225           description varchar(10) NOT NULL default '',
1226           PRIMARY KEY (country_code)
1227         ) TYPE=MyISAM;
1228         INSERT INTO countries VALUES ('C', 'Canada');
1229         CREATE TABLE persons (
1230           id tinyint(4) NOT NULL auto_increment,
1231           person_name varchar(32) NOT NULL default '',
1232           town_code varchar(5) default '0',
1233           country_code char(1) NOT NULL default '',
1234           PRIMARY KEY (id)
1235         ) TYPE=MyISAM;
1236         INSERT INTO persons VALUES (11, 'Marc', 'S', '');
1237         INSERT INTO persons VALUES (15, 'Paul', 'S', 'C');
1238         CREATE TABLE towns (
1239           town_code varchar(5) NOT NULL default '0',
1240           description varchar(30) NOT NULL default '',
1241           PRIMARY KEY (town_code)
1242         ) TYPE=MyISAM;
1243         INSERT INTO towns VALUES ('S', 'Sherbrooke');
1244         INSERT INTO towns VALUES ('M', 'Montréal');
1245         INSERT INTO `PMA_relation` VALUES ('mydb', 'persons',
1246    'town_code', 'mydb', 'towns', 'town_code');
1247         INSERT INTO `PMA_relation` VALUES ('mydb', 'persons',
1248    'country_code', 'mydb', 'countries', 'country_code');
1249    Then test like this:
1250      * Click on your db name in the left frame
1251      * Choose "Query by example"
1252      * Use tables: persons, towns, countries
1253      * Click "Update query"
1254      * In the fields row, choose persons.person_name and click the "Show"
1255        tickbox
1256      * Do the same for towns.description and countries.descriptions in
1257        the other 2 columns
1258      * Click "Update query" and you will see in the query box that the
1259        correct joins have been generated
1260      * Click "Submit query"
1261        
1262    [6.7] How can I use the "display field" feature?
1263    Starting from the previous example, create the PMA_table_info as
1264    explained in the configuration section, then browse your persons
1265    table, and move the mouse over a town code or country code.
1266    
1267    [6.8] How can I produce a PDF schema of my database?
1268    First you have to fill the "relation", "table_coords" and "pdf_pages"
1269    configuration variables.
1270    Then, think about your schema layout: which tables will go on which
1271    pages.
1272      * Click on your db name in the left frame
1273      * Choose "Structure" in the navigation on top
1274      * Choose "Edit PDF Pages" which should be somewhere at the bottom of
1275        the page
1276      * Enter the name for a first pdf page and submit
1277      * Choose this page to edit
1278      * Now add a table you want to show on this page and it's coordinates
1279        and submit
1280        First you will have to guess this coordinates of course, so just
1281        expect to have an area of about 297 * 210 and put the tables
1282        coordinates somewhere in there, you will be able to have a look at
1283        what happened and change them later.
1284        For example, x=100 and y=200 means that the table will be at 200
1285        mm down and 100 mm right from the upper left corner.
1286        Actually if you have a width of more than 300 or a height of more
1287        than 200 than it will automatically be scaled but 300*100 is a
1288        good start to have an idea of what coordinates to use.
1289      * After every table you submitted you will have the possibility to
1290        submit more tables
1291      * When you have entered enough tables Click on your db name in the
1292        left frame again
1293      * Now, again at the bottom of the page you should be able to choose
1294        "Display PDF schema"
1295        For testing it might be useful to show the grid as well, so you
1296        can see the coordinates used.
1297        Maybe also choose color and submit.
1298      * Save the file he will offer you to something like Schema.pdf
1299        (Internet Explorer has some bug there which might make it offer it
1300        without an extension. Under Windows it is important to have the
1301        extension ".pdf", under other OSes you should be fine just saving
1302        the file under the name it offers).
1303        
1304    [6.9] phpMyAdmin is changing the type of one of my columns!
1305    No, it's MySQL that is doing silent column type changing.
1306    
1307    [6.10] My database has an underscore in it's name, and when I grant
1308    privileges to a user for this database, a backslash is added before
1309    the underscore. 
1310    This is normal and means that the grant is done only for this
1311    database. If there was no backslash, this would be a wildcard grant,
1312    and the underscore would mean "any character". So, if the database
1313    name is "john_db", the user would get rights to john1db, john2db...
1314    instead of just john_db.
1315    If you really want to grant using a wildcard, there is a dialog box "
1316    Database (wildcards allowed)" for this.
1317    
1318    [6.11] What is the curious symbol ø in the table statistics?
1319    It means "average".
1320    
1321    [6.12] I want to understand some Export options.
1322    "Complete inserts" adds the column names on every INSERT command, for
1323    better documentation (but resulting file is bigger).
1324    "Extended inserts" provides a shorter dump file by using only once the
1325    INSERT verb and the table name.
1326    "Enclose table and field names with backquotes" ensures that field and
1327    table names formed with special characters are protected.
1328    
1329   [7. phpMyAdmin project]
1330   
1331    [7.1] I have found a bug. How do I inform developers?
1332    Our Bug Tracker is located at
1333    http://sourceforge.net/projects/phpmyadmin/ under the Bugs section.
1334    But please first discuss your bug with other users:
1335    http://sourceforge.net/projects/phpmyadmin/ (and choose Forums)
1336    
1337    [7.2] I want to translate the messages to a new language or upgrade an
1338    existing language, where do I start?
1339    Always use the current cvs version of your language file. For a new
1340    language, start from english-iso-8859-1.inc.php3. If you don't know
1341    how to get the cvs version, please ask one of the developers.
1342    Please note that we try not to use html entities like &eacute; in the
1343    translations, since we define the right character set in the file.
1344    With html entities, the text on buttons would not display correctly.
1345    You can then put your translations, as a zip file to avoid losing
1346    special characters, on the sourceforge.net translation tracker.
1347    It would be a good idea to subscribe to the phpmyadmin-translators
1348    mailing list, because this is where we ask for translations of new
1349    messages.
1350    
1351    [7.3] I would like to help out with the development of phpMyAdmin. How
1352    should I proceed?
1353    The following method is preferred for new developers:
1354      * fetch the current CVS tree over anonymous CVS:
1355        cvs
1356        -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmy
1357        admin login
1358        [Password: simply press the Enter key]
1359        cvs -z3
1360        -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmy
1361        admin checkout phpMyAdmin
1362        [This will create a new sub-directory named phpMyAdmin]
1363      * add your stuff
1364      * put the modified files (tar'ed and gzip'ed) inside the patch
1365        tracker of the phpMyAdmin SourceForge account.
1366        
1367    Write access to the CVS tree is granted only to experienced developers
1368    who have already contributed something useful to phpMyAdmin.
1369    Also, have a look at the Developers section.
1370    ______________________________________________________________________
1371    
1372    Top  -  Requirements  -  Introduction  -  Installation  -
1373    Configuration  -  FAQ  -  Developers  -  Credits
1374    ______________________________________________________________________
1375    
1376 Developers Information
1378    phpMyAdmin is Open Source, so you're invited to contribute to it. Many
1379    great features have been written by other people and you too can help
1380    to make phpMyAdmin a useful tool.
1381    
1382    If you're planning to contribute source, please read the following
1383    information:
1384      * All files include header.inc.php3 (layout),
1385        libraries/common.lib.php3 (common functions) and config.inc.php3.
1386        All configuration data belongs in config.inc.php3. Please keep it
1387        free from other code.
1388        Commonly used functions should be added to
1389        libraries/common.lib.php3 and more specific ones may be added
1390        within a library stored into the libraries sub-directory.
1391      * Obviously, you're free to use whatever coding style you want. But
1392        please try to keep your code as simple as possible: beginners are
1393        using phpMyAdmin as an example application.
1394        As far as possible, we want the scripts to be XHTML1.0 and CSS2
1395        compliant on one hand, they fit PEAR coding standards on the other
1396        hand. Please pay attention to this.
1397      * Please try to keep up the file-naming conventions. Table-related
1398        stuff goes to tbl_*.php3, db-related code to db_*.php3 and so on.
1399      * Please don't use verbose strings in your code, instead add the
1400        string (at least) to english-iso-8859-1.inc.php3 and print() it
1401        out.
1402      * If you want to be really helpful, write an entry for the
1403        ChangeLog.
1404        
1405    IMPORTANT: With 1.4.1, development has switched to CVS. The following
1406    method is preferred for new developers:
1407      * fetch the current CVS tree over anonymous CVS:
1408        cvs
1409        -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmy
1410        admin login
1411        [Password: simply press the Enter key]
1412        cvs -z3
1413        -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmy
1414        admin checkout phpMyAdmin
1415        [This will create a new sub-directory named phpMyAdmin]
1416      * add your stuff
1417      * put the modified files (tar'ed and gzip'ed) inside the patch
1418        tracker of the phpMyAdmin SourceForge account
1419        (http://sourceforge.net/projects/phpmyadmin/)
1420        
1421    Write access to the CVS tree is granted only to developers who have
1422    already contributed something useful to phpMyAdmin. If you're
1423    interested in that, please contact us using the phpmyadmin-devel
1424    mailing list.
1425    ______________________________________________________________________
1426    
1427    Top  -  Requirements  -  Introduction  -  Installation  -
1428    Configuration  -  FAQ  -  Developers  -  Credits
1429    ______________________________________________________________________
1430    
1431 Credits
1434 phpMyAdmin - Credits
1435 ====================
1437 CREDITS, in chronological order
1438 -------------------------------
1440 [tr] - Tobias Ratschiller <tobias_at_phpwizard.net>
1441     * creator of the phpmyadmin project
1442     * maintainer from 1998 to summer 2000
1444 [md] - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca>
1445     * multi-language version
1446     * various fixes and improvements
1447     * project co-administrator
1449 [om] - Olivier Müller <om_at_omnis.ch>
1450     * started SourceForge phpMyAdmin project in March 2001
1451     * sync'ed different existing CVS trees with new features and bugfixes
1452     * multi-language improvements, dynamic language selection
1453     * current project maintainer
1455 [lc] - Loïc Chapeaux <lolo_at_phpheaven.net>
1456     * rewrote and optimized javascript, DHTML and DOM stuff
1457     * rewrote the scripts so they fit the PEAR coding standards and
1458       generate XHTML1.0 and CSS2 compliant codes
1459     * improved the language detection system
1460     * many bugfixes and improvements
1462 [rj] - Robin Johnson <robbat2_at_users.sourceforge.net>
1463     * database maintence controls
1464     * table type code
1465     * Host authentication IP Allow/Deny
1466     * DB-based configuration
1468 [af] - Armel Fauveau <armel.fauveau_at_globalis-ms.com>
1469     * bookmarks feature
1470     * multiple dump feature
1471     * gzip dump feature
1472     * zip dump feature
1474 [gl] - Geert Lund <glund_at_silversoft.dk>
1475     * various fixes
1476     * moderator of the phpMyAdmin users forum at phpwizard.net
1478 [kc] - Korakot Chaovavanich <korakot_at_iname.com>
1479     * "insert as new row" feature
1481 [pk] - Pete Kelly <webmaster_at_trafficg.com>
1482     * rewrote and fix dump code
1483     * bugfixes
1485 [sa] - Steve Alberty <alberty_at_neptunlabs.de>
1486     * rewrote dump code for PHP4
1487     * mySQL table statistics
1488     * bugfixes
1490 [bg] - Benjamin Gandon <gandon_at_isia.cma.fr>
1491     * main author of the version 2.1.0.1
1492     * bugfixes
1494 [at] - Alexander M. Turek <rabus_at_bugfixes.info>
1495     * various small features and fixes
1496     * German language file updates
1498 [mb] - Mike Beck <mike.beck at ibmiller.de>
1499     * automatic joint in QBE
1500     * links column in printview
1501     * Relation view
1504 Thanks to these guys who have sent us some major improvements to merge into the
1505 code since version 2.1.0:
1507 - Michal Cihar <nijel at users.sourceforge.net> who implemented the
1508   enhanced index creation/display feature, and the mecanism to display
1509   a character set in MySQL different than the one in HTML.
1510 - Christophe Gesché from the "MySQL Form Generator for PHPMyAdmin"
1511   (http://sourceforge.net/projects/phpmysqlformgen/) who suggested the patch
1512   for multiple table printviews.
1513 - Garvin Hicking <hicking at faktor-e.de> who built the patch for
1514   vertical display of table rows.
1515 - Yukihiro Kawada <kawada at den.fujifilm.co.jp> for the japanese kanji
1516   encoding conversion feature.
1517 - Piotr Roszatycki <d3xter at users.sourceforge.net> and Dan Wilson, for
1518   the Cookie authentication mode.
1519 - Axel Sander <n8falke at users.sourceforge.net> for the table
1520   relation-links feature.
1521 - Maxime Delorme <delorme.maxime at free.fr> for the PDF schema output;
1522   thanks also to Olivier Plathey for the "FPDF" library
1523   (see http://www.fpdf.org/).
1526 And also to the following people who have contributed minor changes,
1527 enhancements, bugfixes or support for a new language since version 2.1.0:
1529 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
1530 Péter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow, Laurent Dhima,
1531 Kristof Hamann, Thomas Kläger, Lubos Klokner, Martin Marconcini,
1532 Girish Nair, David Nordenberg, Bernard M. Piller, Laurent Haas,
1533 "Sakamoto", Yuval Sarna, www.securereality.com.au,
1534 Alvar Soome, Siu Sun, Peter Svec, Michael Tacelosky, Rachim Tamsjadi,
1535 Kositer Uros, Luís V., Martijn W. van der Lee, Algis Vainauskas,
1536 Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai, Jakub Wilk,
1537 Thomas Michael Winningham, Vilius Zigmantas.
1540 Original Credits of Version 2.1.0
1541 ---------------------------------
1543     This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
1544     to create a web-based interface to MySQL using PHP3. Although I have not
1545     used any of his source-code, there are some concepts I've borrowed from
1546     him. phpMyAdmin was created because Peter told me he wasn't going to
1547     further develop his (great) tool.
1548     Thanks go to
1549     - Amalesh Kempf <ak-lsml_at_living-source.com> who contributed the
1550       code for the check when dropping a table or database. He also suggested
1551       that you should be able to specify the primary key on tbl_create.php3. To
1552       version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
1553       well as a bug-report. Plus many smaller improvements.
1554     - Jan Legenhausen <jan_at_nrw.net>: He made many of the changes that
1555       were introduced in 1.3.0 (including quite significant ones like the
1556       authentication). For 1.4.1 he enhanced the table-dump feature. Plus
1557       bug-fixes and help.
1558     - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca> made phpMyAdmin
1559       language-independent by outsourcing the strings to a separate file. He
1560       also contributed the French translation.
1561     - Alexandr Bravo <abravo_at_hq.admiral.ru> who contributed
1562       tbl_select.php3, a feature to display only some fields from a table.
1563     - Chris Jackson <chrisj_at_ctel.net> added support for MySQL
1564       functions in tbl_change.php3. He also added the
1565       "Query by Example" feature in 2.0.
1566     - Dave Walton <walton_at_nordicdms.com> added support for multiple
1567       servers and is a regular contributor for bug-fixes.
1568     - Gabriel Ash <ga244_at_is8.nyu.edu> contributed the random access
1569       features for 2.0.6.
1570     The following people have contributed minor changes, enhancements, bugfixes
1571     or support for a new language:
1572     Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
1573     Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
1574     Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
1575     G. Wieggers.
1577     And thanks to everyone else who sent me email with suggestions, bug-reports
1578     and or just some feedback.
1579    ______________________________________________________________________
1580    
1581    Top  -  Requirements  -  Introduction  -  Installation  -
1582    Configuration  -  FAQ  -  Developers  -  Credits
1583    ______________________________________________________________________
1584    
1585                                         Valid XHTML 1.0!      Valid CSS!