| blob | d2b2aff86d4e60bf79cea0131f5ab8a12733524e |
4 <!-- $Id$ -->
5 <!--
6 vim: expandtab ts=4 sw=4 sts=4 tw=78
7 -->
9 <head>
13 </head>
15 <body>
25 <br />
32 </div>
37 <!-- TOP MENU -->
38 <ul>
39 <li>
41 SourceForge phpMyAdmin project page [ http://www.phpmyadmin.net/ ]
42 </a>
43 </li>
44 <li>
45 Local documents:
46 <ul>
50 </ul>
51 </li>
52 <li>
53 Documentation version:
55 </li>
56 </ul>
59 <!-- REQUIREMENTS -->
63 <ul>
64 <li>
65 PHP3, PHP4 or PHP5: phpMyAdmin widely uses the 'str_replace()' PHP
72 If you want to display inline thumbnails of JPEGs, you also need
73 GD2 support in PHP.
74 </li>
75 <li>
79 </span>
80 </li>
81 <li>
82 a web-browser (doh!).
83 </li>
84 </ul>
87 <!-- INTRODUCTION -->
91 <p>
92 phpMyAdmin can manage a whole MySQL server (needs a super-user) as well as
93 a single database. To accomplish the latter you'll need a properly set up
94 MySQL user who can read/write only the desired database. It's up to you to
95 look up the appropriate part in the MySQL manual.<br />
96 Currently phpMyAdmin can:
97 </p>
99 <ul>
112 <li>using Query-by-example (QBE), create complex queries automatically connecting required tables</li>
115 <li>transform stored data into any format using a set of predefined functions,
116 like displaying BLOB-data as image or download-link or ...</li>
117 <li>
118 communicate in
120 </li>
121 </ul>
124 (*)
125 phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats) dumps
128 </p>
131 <!-- INSTALLATION -->
135 <p>
137 methods to the MySQL database server. It is still the system administrator's job to
138 grant permissions on the MySQL databases properly. </span>phpMyAdmin's
140 </p>
142 <p>
144 version before OS X, StuffIt unstuffs with Mac formats.<br />
145 So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin scripts
146 before uploading them to your server, as PHP seems not to like Mac-style
148 </p>
150 <p>
153 if you are using a kit with files having this extension.
154 </p>
157 <ol>
158 <li> Choose and download a distribution kit with the files having the
160 web/PHP server interprets those extensions.</li>
161 <li> Untar or unzip the distribution (be sure to unzip the subdirectories):
163 document root. If you don't have direct access to your document root,
164 put the files in a directory on your local machine, and, after step 3,
165 transfer the directory on your web server using, for example, ftp.</li>
166 <li> Open the file config.inc.php3 in your favorite editor and change
167 the values for host, user, password and authentication mode to fit
170 Have a look at
172 explanation of all values.</li>
173 <li> It is recommended that you protect the directory in which you
174 installed phpMyAdmin (unless it's on a closed intranet, or you wish to
175 use HTTP or cookie authentication), for example with HTTP-AUTH (in a
178 information.</li>
179 <li> Open the file
181 in your browser. phpMyAdmin should now display a welcome screen
182 and your databases, or a login dialog if using HTTP or cookie
183 authentication mode.</li>
184 <li> For a whole set of new features (bookmarks, comments, SQL-history, PDP-generation)
185 you need to create a set of tables in your database. Please look at your scripts/
187 You can already use your phpMyAdmin to create the tables for you. Please be
188 aware that you may have to have special (administrator) privileges to create
190 you should specify the table names in your config.inc.php3 file. The directives
193 </ol>
196 <ul>
197 <li>Please do not copy your older config.inc.php3 over the new one: it may
198 offer new configuration variables, and the new version may depend on
199 these for normal behavior. It is suggested instead to insert your site
200 values in the new one.</li>
201 </ul>
204 <ul>
206 environment</b> where you want to give users access to their own
207 database and don't want them to play around with others.
208 <br />
209 Nevertheless be aware that MS Internet Explorer seems to be really
211 bit buggy in this area!<br />
213 HTTP or cookie mode so that your user/password pair are not in clear
214 in the configuration file.<br /><br /></li>
216 <li>HTTP and cookie authentication modes are more secure: the MySQL
217 password does not need to be set in the phpMyAdmin configuration file
220 <br />
221 However, keep in mind that the password travels in plain text, unless
222 you are using the HTTPS protocol.
223 <br />
224 In cookie mode, we send the password in a temporary cookie, so most
225 browsers should not store the password in their cookie file.
226 <br /><br /></li>
228 <li>
229 For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that has
234 You must specify the details for the controluser in the
240 only an example: use something else in your file!</b><br />
242 if it's not the same as the MySQL server's one.
243 <pre>
245 GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
246 GRANT SELECT (
247 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
248 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
249 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
250 Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
251 Execute_priv, Repl_slave_priv, Repl_client_priv
252 ) ON mysql.user TO 'pma'@'localhost';
253 GRANT SELECT ON mysql.db TO 'pma'@'localhost';
254 GRANT SELECT ON mysql.host TO 'pma'@'localhost';
255 GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
256 ON mysql.tables_priv TO 'pma'@'localhost';
257 </pre>
258 If you are using an old MySQL version (below 4.0.2), please use this
259 query instead of the second one:
260 <pre>
262 GRANT SELECT (
263 Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
264 Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
265 File_priv, Grant_priv, References_priv, Index_priv, Alter_priv
266 ) ON mysql.user TO 'pma'@'localhost';
267 </pre>
268 ... and if you want to use the many new relation and bookmark
269 features:
270 <pre>
273 </pre>
274 (this of course requires you to have a special DB for phpMyAdmin, the
275 contents will be explained later)<br />
276 Of course, the above queries only work if your MySQL version supports
277 the GRANT command. This is the case since 3.22.11.
278 </li>
279 <li>
281 privileges on a set of particular databases. Normally you shouldn't
282 give global privileges to an ordinary user, unless you understand
283 the impact of those privileges (for example, you are creating
284 a superuser).<br />
287 <tt>GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost IDENTIFIED BY 'real_password';</tt>
288 <br />
289 What the user may now do is controlled entirely by the MySQL user
290 management system.<br />
291 With HTTP or cookie authentication mode, you don't need to fill the user/password
293 </li>
294 </ul>
297 <ul>
300 allows you to login as any valid MySQL user.</li>
301 <li>Is only supported with PHP running as an Apache module, not with
302 CGI.</li>
303 </ul>
306 <ul>
307 <li>You can use this method as a replacement for the HTTP
308 authentication (for example, if you're running IIS).
309 </li>
311 <li>With this mode, the use can truly logout of phpMyAdmin and login back
312 with the same username.</li>
313 </ul>
316 <ul>
317 <li>This mode is the less secure one because it requires you to fill the
322 <li>In the ISP FAQ section, there is an entry explaining how to protect
323 your configuration file.<br /></li>
324 <li>For additional security in this mode, you may wish to consider the
327 directives.</li>
328 </ul>
331 <!-- CONFIGURATION -->
335 <p>
338 the option that allows to use the *nix end of line character
340 you have modified.
341 </p>
344 <dl>
346 <dd>
347 Sets here the complete URL (with full path) to your phpMyAdmin version.
349 <br /><br />
350 phpMyAdmin needs this setting, because of requirements of the HTTP
351 protocol, explained in RFC2616, section 14.30.
352 <br /><br />
353 Don't forget the slash at the end of your URL. The URL must contain
354 characters that are valid for a URL, and on some servers, the path
355 is case-sensitive.
356 <br /><br />
357 Starting with version 2.3.0, you can try to leave this parameter
358 empty, because the program tries to auto-detect its proper value.
359 Additional details are in the configuration file.
360 <br /><br />
361 Alternatively, this setting can be dynamically completed. For example,
362 you can try to use such a kind of code:
363 <pre>
364 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
365 . $_SERVER['HTTP_HOST']
366 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
369 or
371 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
372 . $_SERVER['SERVER_NAME']
373 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
375 </pre>
379 <br /><br />
380 </dd>
382 <dd>
383 By default, when you leave $cfg['PmaAbsoluteUri'] empty, and the system
384 detects your absolute URI automatically, we display a warning to remind
385 you. If you have tested the automatic detection, and it works perfectly
386 for your setup, then you can set this variable to squelch the warning.
387 <br /><br />
388 </dd>
391 <dd>
392 Starting with version 2.3.0 phpMyAdmin offers a lot of features to work
393 with master / foreign - tables (see
395 <br />
396 If you tried to set this up and it does not work for you, have a look on
398 use it. You will find a link that will analyze why those features have
399 been disabled.<br />
400 If you do not want to use those features set this variable to
402 <br /><br />
403 </dd>
406 <dd>
407 Since version 1.4.2, phpMyAdmin supports the administration of multiple
408 MySQL servers.
409 Therefore, a $cfg['Servers']-array has been added which contains
410 the login information for the different servers. The first
413 the second server, etc.
414 If you have only one server to administer, simply leave free the
415 hostname of the other $cfg['Server']-entries.
416 <br /><br />
417 </dd>
420 <dd>
421 The hostname of your $i-th MySQL-server. E.g. localhost.
422 <br /><br />
423 </dd>
426 <dd>
427 The port-number of your $i-th MySQL-server. Default is 3306 (leave
429 ignores this port number and connects with the socket, so if you want
430 to connect to a port different from the default port, use
432 $cfg['Servers'][$i]['host'].
433 <br /><br />
434 </dd>
437 <dd>
438 The path to the socket to use. Leave blank for default.<br />
439 To use the socket feature you must run PHP 3.0.10 or more.
440 <br /><br />
441 </dd>
444 <dd>
445 What type connection to use with the MySQL server. Your options are
447 is nearly guaranteed to be available on all MySQL servers, while
448 sockets are not supported on some platforms.
449 <br /><br />
450 To use the socket mode, your MySQL server must be on the same machine
451 as the Web server.
452 <br /><br />
453 </dd>
456 <dd>
457 Whether to use a compressed protocol for the MySQL server connection
458 or not (experimental).<br />
460 </dd>
462 <dt>
465 </dt>
466 <dd>
467 When using HTTP or cookie authentication modes (or 'config'
468 authentication mode since phpMyAdmin 2.2.1), you need to supply the
473 This account is used to check what databases the user will see at
474 login.<br />
477 <br /><br />
478 Note that if you try login to phpMyAdmin with this
482 <br /><br />
483 In versions before 2.2.5, those were called
485 <br /><br />
486 </dd>
489 <dd>
490 Whether config or cookie or http authentication should be used for this
491 server.
493 <ul>
494 <li>
495 'config' authentication
497 way: username and password are stored in
499 </li>
500 <li>
501 'cookie' authentication mode
503 2.2.3 allows you to log in as any valid MySQL user with the
504 help of... cookies. Log name and password are stored in
505 cookies during the session and password is deleted when it
506 ends.
507 </li>
508 <li>
509 'http' authentication (was called 'advanced' in older versions)
511 allows you to log in as any valid MySQL user via HTTP-Auth.
512 </li>
513 </ul><br />
516 for more information.
517 <br /><br />
518 </dd>
520 <dt>
522 </dt>
523 <dd>
525 a secret passphrase which will be used by the blowfish encryption
526 mecanism to protect the password stored in the temporary cookie.
527 </dd>
528 <dt>
531 </dt>
532 <dd>
533 The user/password-pair which phpMyAdmin will use to connect to this
534 MySQL-server. This user/password pair is not needed when HTTP or cookie
535 authentication is used, and should be empty.<br /><br />
536 </dd>
539 <dd>
540 If set to a(an array of) database name(s), only this(these) database(s)
541 will be shown to the user. Since phpMyAdmin 2.2.1, this/these
542 database(s) name(s) may contain MySQL wildcards characters
546 This setting is an efficient way to lower the server charge since the
547 latter does not need to send MySQL requests to build the available
549 privileges rules of the MySQL database server</span>. If set, it just
550 means only these databases will be displayed but
552 <br /><br />
553 An example of using more that one database:
555 </dd>
558 <dd>
559 Only useful when using phpMyAdmin with multiple server entries. If set,
560 this string will be displayed instead of the hostname in the pull-down
561 menu on the main page. This can be useful if you want to show only
562 certain databases on your system, for example.
563 <br /><br />
564 </dd>
566 <dt>
569 </dt>
570 <dd>
571 Starting with version 2.3.0 phpMyAdmin offers a lot of features
572 to work with master / foreign - tables. To use those as well as
573 the bookmark feature you need special tables with a
574 predefined structure, which we explain below.<br />
575 If you are the only user of this phpMyAdmin installation, you can
576 use your current database to store those special tables; in this
577 case, just put your current database name in
579 <br /><br />
580 If you are setting up a multi-user phpMyAdmin installation,
581 you will need to create a new database and setup special privileges,
582 so, as superuser:
583 <br /><br />
584 <ul>
585 <li>
586 create a new database for phpMyAdmin:<br />
590 privileges on this database. Here is a query to set up
593 controluser):<br />
594 <tt>
595 GRANT SELECT,INSERT,UPDATE,DELETE ON phpmyadmin.* to 'pma'@'localhost';
596 </tt><br />
598 </li>
599 <li>
601 </li>
602 </ul><br />
603 </dd>
605 <dt>
608 </dt>
609 <dd>
610 Since release 2.2.0 phpMyAdmin allows to bookmark queries. This can be
611 useful for queries you often run.<br /><br />
613 To allow the usage of this functionality you have to:
614 <ul>
616 <li>within this database create a table following this scheme:
617 <br />
618 <tt>
627 </tt>
628 </li>
629 <li>enter the table name in
631 </ul><br />
632 </dd>
634 <dt>
637 </dt>
638 <dd>
639 Since release 2.2.4 you can describe, in a special 'relation' table,
640 which field is a key in another table (a foreign key). phpMyAdmin
641 currently uses this to
642 <ul>
643 <li>
644 make clickable, when you browse the master table, the data values
645 that point to the foreign table;
646 </li>
647 <li>
649 when browsing the master table, if you move the mouse to a column
650 containing a foreign key (use also the 'table_info' table);<br />
651 (see FAQ 6.7)
652 </li>
653 <li>
654 in edit/insert mode, display a drop-down list of possible
656 shown)<br />
657 (see FAQ 6.21)
658 <li>
659 display links on the table properties page, to check referential
660 integrity (display missing foreign keys) for each described key;
661 </li>
662 <li>
663 in query-by-example, create automatic joins (see FAQ 6.6)
664 </li>
665 <li>
666 enable you to get a PDF schema of your database (also uses the
667 table_coords table).
668 </li>
669 </ul>
670 <br />
672 The keys can be numeric or character.
673 <br /><br />
675 To allow the usage of this functionality the superuser has to:
676 <ul>
678 <li>
679 within this database create a table following this scheme:
680 <br />
681 <tt>
687 `foreign_table` varchar(64) NOT NULL default '',<br />
688 `foreign_field` varchar(64) NOT NULL default '',<br />
689 PRIMARY KEY (`master_db`, `master_table`, `master_field`),<br />
692 </tt>
693 </li>
694 <li>
695 put the relation table name in
697 </li>
698 <li>
699 now as normal user open phpMyAdmin and for each one of your
700 tables where you want to use this feature, click
702 </li>
703 </ul><br />
706 future development of the cross-db relations.<br /><br />
707 </dd>
709 <dt>
712 </dt>
713 <dd>
714 Since release 2.3.0 you can describe, in a special 'table_info'
715 table, which field is to be displayed as a tool-tip when moving the
716 cursor over the corresponding key.
717 <br />
718 This configuration variable will hold the name of this special
719 table.
720 To allow the usage of this functionality the superuser has to:
721 <ul>
723 <li>within this database create a table following this scheme:
724 <br />
725 <tt>
729 `display_field` varchar(64) NOT NULL default '',<br />
732 </tt>
733 </li>
734 <li>
735 put the table name in
737 </li>
738 <li>
739 then for each table where you want to use this feature,
741 to choose the field.
742 </li>
743 </ul><br />
745 <br /><br />
746 </dd>
748 <dt>
752 </dt>
753 <dd>
754 Since release 2.3.0 you can have phpMyAdmin create PDF pages showing
755 the relations between your tables. To do this it needs two tables
758 table will be placed on a PDF schema output).
759 <br /><br />
762 output.
763 <br /><br />
764 To allow the usage of this functionality the superuser has to:
765 <ul>
767 <li>
768 within this database create a table following this scheme:
769 <br />
770 <tt>
777 PRIMARY KEY (`db_name`, `table_name`, `pdf_page_number`)<br />
778 ) TYPE=MyISAM COMMENT='Table coordinates for phpMyAdmin PDF output';<br />
779 </tt>
780 </li>
781 <li>
782 also within this database create:<br />
783 <tt>
786 `page_nr` int(10) unsigned NOT NULL auto_increment,<br />
791 </tt>
792 </li>
793 <li>
794 put the first table name in
796 and the second table name in
798 </li>
799 </ul><br />
801 <br /><br />
802 </dd>
804 <dt>
807 </dt>
808 <dd>
809 <!-- This part requires a content update! -->
810 Since release 2.3.0 you can store comments to describe each column
812 <br /><br />
813 Starting with release 2.5.0, comments are consequently used on the table property
814 pages and table browse view, showing up as tool-tips above the column name (properties page)
815 or embedded within the header of table in browse view. They can also be shown
816 in a table dump. Please see the relevant configuration directives later on.
817 <br /><br />
818 Also new in release 2.5.0 is a mime-transformation system which is also based on
820 for further information. To use the mime-transformation system, your column_info
821 table has to have the three new fields 'mimetype', 'transformation', 'transformation_options'.
822 <br /><br />
823 To allow the usage of this functionality the superuser has to:
824 <ul>
826 <li>
827 within this database create a table following this scheme:
828 <br />
829 <tt>
837 transformation varchar(255) NOT NULL default '',<br />
838 transformation_options varchar(255) NOT NULL default '',<br />
840 UNIQUE KEY db_name (db_name, table_name, column_name)<br />
842 </tt>
843 </li>
844 <li>
845 put the table name in
847 </li>
848 <li>
850 <tt>
854 ADD `transformation_options` VARCHAR( 255 ) NOT NULL ;<br />
855 </tt>
856 and remember that the Variable in config.inc.php has been renamed
857 from <br />$cfg['Servers'][$i]['column_comments'] to $cfg['Servers'][$i]['column_info']
858 </li>
859 </ul><br />
860 </dd>
862 <dt>
865 </dt>
866 <dd>
867 Since release 2.5.0 you can store your SQL history, which means all queries you
868 entered manually into the phpMyAdmin interface. If you don't want to use a table-
869 based history, you can use the JavaScript-based history. Using that, all your
870 history items are deleted when closing the window.<br /><br />
873 you want to have on hold. On every login, this list gets cut to the maximum amount.
874 <br /><br />
876 The query history is only available if you use the JavaScript-based query window,
878 <br /><br />
880 To allow the usage of this functionality the superuser has to:
881 <ul>
883 <li>
884 within this database create a table following this scheme:
885 <br />
886 <tt>
895 INDEX ( `username` , `db` , `table` , `timevalue` )<br />
897 </tt>
898 </li>
899 <li>
900 put the table name in
902 </li>
903 </ul><br />
904 </dd>
906 <dt>
909 </dt>
910 <dd>
911 Because release 2.5.0 introduced the new MIME-transformation support, the
912 column_info table got enhanced with three new fields. If the above variable is
913 set to TRUE (default) phpMyAdmin will check if you have the latest table structure
914 available. If not, it will emit a warning to the superuser.<br /><br />
916 You can disable this checking behavior by setting the variable to false, which
917 should offer a performance increase.<br /><br />
919 Recommended to set to FALSE, when you are sure, your table structure is up to date.
920 <br /><br />
921 </dd>
923 <dt>
925 </dt>
926 <dd>
927 If your rule order is empty, then IP authentication is disabled.
928 <br /><br />
930 applies all deny rules followed by allow rules.
931 Access is allowed by default. Any client which does not match a Deny
932 command or does match an Allow command will be allowed access to the
933 server.
934 <br /><br />
936 applies all allow rules followed by deny rules. Access is denied by
937 default. Any client which does not match an Allow directive or does
938 match a Deny directive will be denied access to the server.
939 <br /><br />
940 If your rule order is set to 'explicit', the authentication is
941 performed in a similar fashion to rule order 'deny,allow', with the
945 and was available in Apache by specifying allow and deny rules without
946 setting any order.
947 <br /><br />
948 </dd>
950 <dt>
952 </dt>
953 <dd>
954 The general format for the rules is as such:<br />
955 <tt>
956
958 </tt>
959 <br /><br />
964 well:<br />
965 <tt>
968 </tt>
969 <br /><br />
971 Having an empty rule list is equivalent to either using
975 <br /><br />
977 For the IP matching system, the following work:<br />
981 But the following does not work:<br />
983 <br /><br />
984 </dd>
987 <dd>
988 If you have more than one server configured, you can set
990 that server when phpMyAdmin is started, or set it to 0 to be given a
991 list of servers without logging in.<br />
993 MUST be set to that server.
994 <br /><br />
995 </dd>
998 <dd>
999 Defines whether to use GZip output buffering for increased
1000 speed in HTTP transfers.
1001 <br /><br />
1002 </dd>
1005 <dd>
1006 Whether persistent connections should be used or not (mysql_connect or
1007 mysql_pconnect).
1008 <br /><br />
1009 </dd>
1012 <dd>
1013 Set the number of seconds a script is allowed to run. If seconds is set
1014 to zero, no time limit is imposed.<br />
1015 This setting is used while importing/exporting dump files but has no
1016 effect when PHP is running in safe mode.
1017 <br /><br />
1018 </dd>
1021 <dd>
1022 Mark used tables and make it possible to show databases with locked
1023 tables (since 3.23.30).
1024 <br /><br />
1025 </dd>
1028 <dd>
1029 Defines whether SQL-queries generated by phpMyAdmin should be displayed
1030 or not.
1031 <br /><br />
1032 </dd>
1035 <dd>
1036 Defines whether normal users (non-administrator) are allowed to
1037 delete their own database or not. If set as FALSE, the link "Drop
1039 mydatabase" will be rejected. Quite practical for ISP's with many
1040 customers.
1041 <br /><br />
1042 </dd>
1045 <dd>
1047 displayed when you're about to loose data.
1048 <br /><br />
1049 </dd>
1052 <dd>
1053 Define whether the previous login should be recalled or not in cookie
1054 authentication mode.
1055 <br /><br />
1056 </dd>
1059 <dd>
1060 Define whether the "search string inside database" is enabled or not.
1061 <br /><br />
1062 </dd>
1065 <dd>
1066 Defines whether to use select-based menu and display only the current
1067 tables in the left frame (smaller page).
1068 Only in Non-Lightmode you can use the feature to display nested folders
1069 using $cfg['LeftFrameTableSeparator']
1070 <br /><br />
1071 </dd>
1074 <dd>
1075 Defines a string to be used to nest table spaces. Defaults to '__'. This
1076 means if you have tables like 'first__second__third' this will be
1078 If set to FALSE or empty, the feature is disabled.
1079 NOTE: You shall not use this Separator in a table name at the beginning or
1080 end of a table name, or multiple times after another without any other
1081 characters in between.
1082 <br /><br />
1083 </dd>
1086 <dd>
1087 Defines how many sublevels should be displayed when splitting
1088 up tables by the above Separator.
1089 <br /><br />
1090 </dd>
1093 <dd>
1094 Defines whether to display table comment as tool-tip in left frame or
1095 not.
1096 <br /><br />
1097 </dd>
1100 <dd>
1101 If tool-tips are enabled and a DB comment is set, this will flip the comment
1102 and the real name. That means, if you have a table called 'user0001' and add
1103 the comment 'MyName' on it, you will see the name 'MyName' used consequently
1104 in the left frame and the tool-tip shows the real name of the DB.
1105 <br /><br />
1106 </dd>
1109 <dd>
1110 Same as $cfg['ShowTooltipAliasDB'], except this works for table names.
1111 <br /><br />
1112 </dd>
1115 <dd>
1116 Defines whether to display space usage and statistics about databases
1117 and tables or not.<br />
1118 Note that statistics requires at least MySQL 3.23.3 and that, at this
1119 date, MySQL doesn't return such information for Berkeley DB tables.
1120 <br /><br />
1121 </dd>
1123 <dt>
1128 </dt>
1129 <dd>
1133 starting main (right) frame. This setting does not check MySQL commands
1134 entered directly.
1135 <br /><br />
1137 Please note that to block the usage of phpinfo() in scripts, you
1138 have to put this in your php.ini:<br />
1140 <br /><br />
1144 coded password value in the configuration file, end users can't be
1145 allowed to change their passwords.
1146 <br /><br />
1147 </dd>
1150 <dd>
1151 Defines whether to suggest a database name on the
1153 <br /><br />
1154 </dd>
1157 <dd>
1159 content or not.
1160 <br /><br />
1161 </dd>
1164 <dd>
1165 Defines whether navigation bar buttons contain text or symbols only.
1166 <br /><br />
1167 </dd>
1170 <dd>
1171 Defines whether an user should be displayed a
1173 <br /><br />
1174 </dd>
1177 <dd>
1178 Number of rows displayed when browsing a result set. If the result set
1179 contains more rows, Previous/Next links will be shown.
1180 <br /><br />
1181 </dd>
1184 <dd>
1188 DATE, DATETIME & TIMESTAMP, ascending order else- by default.
1189 <br /><br />
1190 </dd>
1193 <dd>
1195 from edition when browsing a table's content or not.
1196 Valid values are:<br />
1199 <br />
1202 <br /><br />
1203 </dd>
1206 <dd>
1207 Defines whether MySQL functions fields should be displayed or not in
1208 edit/insert mode.
1209 <br /><br />
1210 </dd>
1213 <dd>
1214 Defines which type of editing controls should be used for CHAR and
1215 VARCHAR fields. Possible values are:
1216 <ul>
1217 <li>
1218 input - this allows to limit size of text to size of field in
1219 MySQL, but has problems with newlines in fields
1220 </li>
1221 <li>
1222 textarea - no problems with newlines in fields, but also no
1223 length limitations
1224 </li>
1225 </ul>
1226 Default is old behavior so input.
1227 <br /><br />
1228 </dd>
1230 <dt>
1234 </dt>
1235 <dd>
1236 Defines whether to allow the use of zip/GZip/BZip2 compression when
1237 creating a dump file or not.
1238 <br /><br />
1239 </dd>
1242 <dd>
1243 If set to True, do use less graphically intense tabs on the top of the mainframe.
1244 <br /><br />
1245 </dd>
1248 <dd>
1249 Defines the tab displayed by default on server view. Possible
1254 <br /><br />
1255 </dd>
1258 <dd>
1259 Defines the tab displayed by default on database view. Possible
1262 <br /><br />
1263 </dd>
1266 <dd>
1267 Defines the tab displayed by default on table view. Possible
1271 <br /><br />
1272 </dd>
1275 <dd>
1276 If set to an URL which points to the MySQL documentation (type depends
1278 generated.
1279 <br />
1281 Documentation page</a> for more information about MySQL manuals and
1282 their types.
1283 <br /><br />
1284 </dd>
1287 <dd>
1288 Type of MySQL documentation:
1289 <ul>
1295 </ul>
1296 <br /><br />
1297 </dd>
1300 <dd>
1301 Defines the default language to use, if not browser-defined or
1302 user-defined.<br />
1304 this setting.
1305 <br /><br />
1306 </dd>
1309 <dd>
1310 Force: always use this language (must be defined in the
1312 <br /><br />
1313 </dd>
1316 <dd>
1317 Default character set to use for recoding of MySQL queries. This must be
1319 option.<br />
1320 You can give here any character set which is in
1322 choice, user can select any of them.
1323 <br /><br />
1324 </dd>
1327 <dd>
1328 Allow character set recoding of MySQL queries. You need recode or iconv
1329 support (compiled in or module) in PHP to allow MySQL queries recoding
1330 and used language file must have it enabled (by default only these
1331 which are in Unicode, just to avoid losing some characters).
1332 <br /><br />
1333 </dd>
1336 <dd>
1337 You can select here which functions will be used for character set
1338 conversion.
1339 Possible values are:<br />
1340 <ul>
1341 <li>auto - automatically use available one (first is tested
1342 iconv, then recode)</li>
1345 </ul>
1346 Default is auto.
1347 <br /><br />
1348 </dd>
1351 <dd>
1352 Specify some parameters for iconv used in charset conversion. See
1353 <a
1355 documentation</a> for details.
1356 <br /><br />
1357 </dd>
1360 <dd>
1361 Available character sets for MySQL conversion. You can add your own (any of
1362 supported by recode/iconv) or remove these which you don't use.
1363 Character sets will be shown in same order as here listed, so if you
1364 frequently use some of these move them to the top.
1365 <br /><br />
1366 </dd>
1369 <dd>
1371 MIME transformations.<br />
1372 Possible values are:<br />
1373 <ul>
1374 <li>
1375 auto - automatically detect, this is a bit expensive
1377 according to your server real possibilities
1378 </li>
1381 </ul>
1382 Default is auto.
1383 <br /><br />
1384 </dd>
1387 <dd>
1388 Left frame width in pixel.
1389 <br /><br />
1390 </dd>
1392 <dt>
1395 </dt>
1396 <dd>
1397 The background colors (HTML) used for both the frames.
1398 <br /><br />
1399 </dd>
1401 <dt>
1403 </dt>
1404 <dd>
1405 The URI of the background image used for the right frame. It can be
1406 absolute as well as relative from your phpMyAdmin directory.
1407 </dd>
1410 <dd>
1411 The color (HTML) used for the pointer in the left frame (does not work
1412 with Netscape 4).
1413 <br /><br />
1414 </dd>
1417 <dd>
1418 The size of a table's border.
1419 <br /><br />
1420 </dd>
1423 <dd>
1424 The color (HTML) used for table headers.
1425 <br /><br />
1426 </dd>
1429 <dd>
1430 The color (HTML) #1 for table rows.
1431 <br /><br />
1432 </dd>
1435 <dd>
1436 The color (HTML) #2 for table rows.
1437 <br /><br />
1438 </dd>
1440 <dt>
1443 </dt>
1444 <dd>
1445 The colors (HTML) uses for the pointer and the marker in browse mode
1447 The former feature highlights the row over which your mouse is passing
1448 and the latter lets you visually mark/unmark rows by clicking on
1449 them.<br />
1450 You can disable both of these features by emptying the respective
1451 directive.
1452 <br /><br />
1453 </dd>
1455 <dt>
1460 </dt>
1461 <dd>
1462 Number of columns and rows for the textareas.<br />
1464 SQL textareas inside the query window.<br />
1465 The Char* values are used for CHAR and VARCHAR editing (if configured
1466 via $cfg['CharEditing']).
1467 <br /><br />
1468 </dd>
1470 <dt>
1472 </dt>
1473 <dd>
1474 Defines whether textarea for LONGTEXT fields should have double size.
1475 <br /><br />
1476 </dd>
1478 <dt>
1480 </dt>
1481 <dd>
1482 Defines if the whole textarea of the query box will be selected on
1483 click.
1484 <br /><br />
1485 </dd>
1487 <dt>
1489 </dt>
1490 <dd>
1491 Enable Ctrl+Arrows moving between fields when editing?
1492 <br /><br />
1493 </dd>
1496 <dd>
1497 Maximal number of Chars showed in any non-numeric
1498 field on browse view. Can be turned off by a toggle button on the
1499 browse page.
1500 <br /><br />
1501 </dd>
1503 <dt>
1506 </dt>
1507 <dd>
1508 Defines the place where modify and delete links would be put when
1509 tables contents are displayed (you may have them displayed both at the
1510 left and at the right).
1513 <br /><br />
1514 </dd>
1518 </dt>
1519 <dd>
1520 There are 3 display modes: horizontal, horizontalflipped and vertical. Define
1521 which one is displayed by default. The first mode displays each row on a
1522 horizontal line, the second rotates the headers by 90 degrees, so you can use
1523 descriptive headers even though fields only contain small values and still
1524 print them out. The vertical mode sorts each row on a vertical lineup.<br /><br />
1525 The HeaderFlipType can be set to 'css' or 'faked'. When using 'css' the rotation
1526 of the header for horizontalflipped is done via CSS. If set to 'faked' PGP
1527 does the transformation for you, but of course this does not look as good as CSS.
1528 <br /><br />
1529 </dd>
1532 <dd>
1533 When editing/creating new columns in a table all fields normally get lined up
1534 one field a line. (default: 'horizontal'). If you set this to 'vertical' you
1535 can have each field lined up vertically beneath each other. You can save up
1536 a lot of place on the horizontal direction and no longer have to scroll.
1537 <br /><br />
1538 </dd>
1542 </dt>
1543 <dd>
1544 By setting the corresponding variable to TRUE you can enable the display of
1545 column comments in Browse or Property display. In browse mode, the comments
1546 are show inside the header. In property mode, comments are displayed using
1547 a CSS-formatted dashed-line below the name of the field. The comment is shown
1548 as a tool-tip for that field.
1549 <br /><br />
1550 </dd>
1553 <dd>
1554 The name of the directory, ending with a slash, where SQL files have
1555 been uploaded by other means than phpMyAdmin (for example, ftp).
1556 Those files are available under a drop-down box when you click the
1557 database name, then the SQL tab.
1558 <br /><br />
1560 <br /><br />
1561 This feature is useful when your file is too big to be uploaded via
1562 HTTP, or when file uploads are disabled in PHP.
1563 <br /><br />
1564 Please note that if PHP is running in safe mode, this directory must
1565 be owned by the same user as the owner of the phpMyAdmin scripts.
1566 <br /><br />
1567 </dd>
1570 <dd>
1571 The name of the directory, ending with a slash, where dumps can
1572 be saved.
1573 <br /><br />
1574 Please note that the directory has to be writable for user running
1575 webserver.
1576 <br /><br />
1577 Please note that if PHP is running in safe mode, this directory must
1578 be owned by the same user as the owner of the phpMyAdmin scripts.
1579 <br /><br />
1580 </dd>
1583 <dd>
1584 In this array are defined default parameters for export, names of
1585 items are simmilar to texts seen on export page, so you can easily
1586 identify what they mean.
1587 <br /><br />
1588 </dd>
1591 <dd>
1592 Repeat the headers every X cells, or 0 to deactivate.
1593 <br /><br />
1594 </dd>
1604 </dt>
1605 <dd>
1606 All those variables affect the new query frame/window. When $cfg['QueryFrame']
1607 is set to true a new frame is embedded on the left with a small area. Clicking
1608 on that results in opening a direct interface to enter SQL queries.<br /><br />
1609 When $cfg['QueryFrameJS'] is set to true, clicking on that link opens a new
1610 custom sized browser window ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] -
1611 both integers for the size in pixels). If set to false, clicking on the link
1612 only opens the SQL input in the mainframe.<br /><br />
1613 The usage of the JavaScript query window is recommended if you have a JavaScript
1614 enabled browser. Basic functions are used to exchange quite a few variables, so
1615 most 4th generation browsers should be capable to use that feature. It currently
1617 If $cfg['QueryHistoryDB'] is set to TRUE, all your Queries are logged to a table,
1619 If set to FALSE, all your queries will be appended to the form, but only as long
1620 as your window is opened they remain saved.<br /><br />
1621 When using the JavaScript based query window, it will always get updated when you
1622 click on a new table/db to browse and will focus if you click on "Edit SQL" after
1623 using a query. You can suppress updating the query window by checking the box
1624 "Do not overwrite this query from outside the window" below the query textarea. Then
1625 you can browse tables/databases in the background without losing the contents of the
1626 textarea, so this is especially useful when composing a query with tables you first
1627 have to look in. The checkbox will get automatically checked whenever you change the
1628 contents of the textarea. Please uncheck the button whenever you definitely want the
1629 query window to get updated even though you have made alterations.<br /><br />
1630 If $cfg['QueryHistoryDB'] is set to TRUE you can specify the amount of saved
1631 history items using $cfg['QueryHistoryMax'].<br /><br />
1632 The query window also has a custom tabbed look to group the features. Using the
1633 variable $cfg['QueryWindowDefTab'] you can specify the default tab to be used
1634 when opening the query window. It can be set to either 'sql', 'files', 'history'
1635 or 'full'.<br /><br />
1636 The variable $cfg['QueryFrameDebug'] can be used by developers for easier future
1637 feature integration.
1638 <br /><br />
1639 </dd>
1642 <dd>
1644 <br /><br />
1645 </dd>
1648 <dd>
1649 Determines for how large tables phpMyAdmin should get exact row count by
1653 <br /><br />
1654 </dd>
1657 <dd>
1658 Utilizes a WYSIWYG editing control to easily place elements of a PDF page.
1659 By clicking on the button 'toggle scratchboard' on the page where you
1660 edit x/y coordinates of those elements you can activate a scratchboard where
1661 all your elements are placed. By clicking on an element, you can move them
1662 around in the pre-defined area and the x/y coordinates will get updated
1663 dynamically. Likewise, when entering a new position directly into the
1664 input field, the new position in the scratchboard changes after your
1665 cursors leaves the input field.<br />
1666 You have to click on the 'OK'-button below the tables to save the new positions.
1667 If you want to place a new element, first add it to the table of elements and
1668 then you can drag the new element around.<br />
1669 By changing the paper size and the orientation you can change the size of the
1670 scratchboard as well. You can do so by just changing the dropdown field below,
1671 and the scratchboard will resize automatically, without interfering with the
1672 current placement of the elements.<br />
1673 If ever an element gets out of range you can either enlarge the paper size
1674 or click on the 'reset' button to place all elements below each other.<br />
1676 to work. The basic Drag&Drop script functionality was kindly borrowed from www.youngpup.net and
1677 is underlying so specific license.
1678 <br /><br />
1679 </dd>
1682 <dd>
1683 The main use of the new SQL Parser is to pretty-print SQL queries. By
1684 default we use HTML to format the query, but you can disable this by
1686 <br /><br />
1687 </dd>
1691 <dd>
1692 For the pretty-printing of SQL queries, under some cases the part of a
1693 query inside a bracket is indented. By changing
1696 specifies the units of the indent amount that you specified. This is
1697 used via stylesheets.
1698 <br /><br />
1699 </dd>
1702 <dd>
1703 This array is used to define the colours for each type of element of
1704 the pretty-printed SQL queries. The tuple format is<br />
1706 If you specify an empty string for the color of a class, it is ignored
1707 in creating the stylesheet.
1708 You should not alter the class names, only the colour strings.<br />
1710 <ul>
1734 <li><b>quote_single</b> Single quotes <tt>'</tt></li>
1735 <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
1736 </ul><br />
1737 </dd>
1739 <dt><b>$cfg['SQLValidator']['use']</b> boolean</dt>
1740 <dd>
1741 phpMyAdmin now supports use of the <a href="http://developer.mimer.com/validator/index.htm">Mimer SQL Validator</a> service,
1742 as originally published on
1744 <br />
1745 For help in setting up your system to use the service, see the
1747 <br /><br />
1748 </dd>
1750 <dt><b>$cfg['SQLValidator']['username']</b> string<br />
1751 <b>$cfg['SQLValidator']['password']</b> string</dt>
1752 <dd>
1753 The SOAP service allows you to login with <tt>anonymous</tt>
1754 and any password, so we use those by default.. Instead, if
1755 you have an account with them, you can put your login details
1756 here, and it will be used in place of the anonymous login.
1757 <br /><br />
1758 </dd>
1760 <dt><b>$cfg['DBG']['enable']</b> boolean</dt>
1761 <dd>
1762 <b>DEVELOPERS ONLY!</b><br />
1763 Enable the DBG extension for debugging phpMyAdmin. Required for profiling
1764 the code.
1765 <br />
1766 For help in setting up your system to this, see the
1768 </dd>
1770 <dt><b>$cfg['DBG']['profile']['enable']</b> boolean</dt>
1771 <dd>
1772 <b>DEVELOPERS ONLY!</b><br />
1773 Enable profiling support for phpMyAdmin. This will append a chunk of data
1774 to the end of every page displayed in the main window with profiling
1775 statistics for that page.<br />
1776 You may need need to increase the maximum execution time for this to
1777 complete successfully.
1778 </dd>
1780 <dt><b>$cfg['DBG']['profile']['threshold']</b> float (units in milliseconds)</dt>
1781 <dd>
1782 <b>DEVELOPERS ONLY!</b><br />
1783 When profiling data is displayed, this variable controls the threshold of
1784 display for any profiling data, based on the average time each time has
1785 taken. If it is over the threshold it is displayed, otherwise it is not
1786 displayed. This takes a value in milliseconds. In most cases you don't need
1787 to edit this.
1788 </dd>
1790 <dt><b>$cfg['ColumnTypes'] </b>array</dt>
1791 <dd>
1792 All possible types of a MySQL column. In most cases you don't need to
1793 edit this.
1794 <br /><br />
1795 </dd>
1797 <dt><b>$cfg['AttributeTypes'] </b>array</dt>
1798 <dd>
1799 Possible attributes for fields. In most cases you don't need to edit
1800 this.
1801 <br /><br />
1802 </dd>
1804 <dt><b>$cfg['Functions'] </b>array</dt>
1805 <dd>
1806 A list of functions MySQL supports. In most cases you don't need to
1807 edit this.
1808 <br /><br />
1809 </dd>
1811 </dl>
1813 <!-- TRANSFORMATIONS -->
1815 <h2>Transformations</h2>
1817 <p>
1821 </p>
1824 <h3>[1. Introduction]</h3>
1826 <p>To enable transformations, you have to setup the column_info table and the proper
1828 <br />
1830 <p>You can apply different transformations to the contents of each field. The
1831 transformation will take the content of each field and transform it with
1832 certain rules defined in the selected transformation.</p><br />
1834 <p>Say you have a field 'filename' which contains a filename. Normally you would see
1835 in phpMyAdmin only this filename. Using transformations you can transform that filename
1836 into a HTML link, so you can click inside of the phpMyAdmin structure on the field's
1837 link and will see the file displayed in a new browser window. Using transformation
1838 options you can also specify strings to append/prepend to a string or the format you
1839 want the output stored in.</p><br />
1841 <p>For a general overview of all available transformations and their options, you can
1842 consult your <i><www.your-host.com>/<your-install-dir>/libraries/transformations/overview.php3</i>
1843 installation.</p>
1846 <h3>[2. Usage]</h3>
1848 <p>Go to your tbl_properties.inc.php3 page (i.e. reached through clicking on the
1849 'properties' link for a table). There you will see three new fields at the end of the
1850 line. They are called 'MIME-type', 'Browser transformation' and 'Transformation options'.</p>
1851 <br />
1853 <ul>
1854 <li>The field 'MIME-type' is a dropdown field. You have the options to leave that field
1855 empty or to use 'auto' [this feature is not yet available]. Please note that
1856 transformations are inactive as long as no mime-type is selected.</li>
1858 <li>The field 'Browser transformation' is a drop-down field. You can choose from a
1859 hopefully growing amount of pre-defined transformations. See below for information on
1860 how to build your own transformation.<br />
1862 There are global transformations and mimetype-bound transformations. Global transformations
1863 can be used for any mimetype. They will take the mimetype, if necessary, into regard.
1864 Mimetype-bound transformations usually only operate on a certain mimetype. There are
1865 transformations which operate on the main mimetype (like 'image'), which will most likely
1866 take the subtype into regard, and those who only operate on a
1867 specific subtype (like 'image/jpeg').<br />
1869 You can use transformations on mimetypes for which the function was not defined for. There
1870 is no security check for you selected the right transformation, so take care of what the
1871 output will be like.</li>
1873 <li>The field 'Transformation options' is a free-type textfield. You have to enter
1874 transform-function specific options here. Usually the transforms can operate with default
1875 options, but it is generally a good idea to look up the overview to see which options are
1876 necessary.<br />
1878 Much like the ENUM/SET-Fields, you have to split up several options using the format
1879 'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
1880 parsed as an array, leaving the first value the first element in the array, and so
1881 forth.<br />
1883 If you want to specify a MIME character set you can define it in the transformation_options.
1884 You have to put that outside of the pre-defined options of the specific mime-transform,
1886 for which you can specify 2 options and you want to append a character set, enter "'first
1887 parameter','second parameter','charset=us-ascii'". You can, however use the defaults for
1889 </ul>
1892 <h3>[3. File structure]</h3>
1894 <p>All mimetypes and their transformations are defined through single files in
1895 the directory 'libraries/transformations/'.</p><br />
1897 <p>They are stored in files to ease up customization and easy adding of new
1898 transformations.</p><br />
1900 <p>Because the user cannot enter own mimetypes, it is kept sure that transformations
1901 always work. It makes no sense to apply a transformation to a mimetype, the
1902 transform-function doesn't know to handle.</p><br />
1904 <p>One can, however, use empty mime-types and global transformations which should work
1905 for many mimetypes. You can also use transforms on a different mimetype they where built
1906 for, but pay attention to option usage as well as what the transformation does to your
1907 field.</p><br />
1909 <p>There is a basic file called 'global.inc.php3'. This function can be included by
1910 any other transform function and provides some basic functions.</p><br />
1912 <p>There are 5 possible file names:</p>
1914 <ol>
1915 <li>A mimetype+subtype transform:<br /><br />
1917 [mimetype]_[subtype]__[transform].inc.php3<br /><br />
1919 Please not that mimetype and subtype are separated via '_', which shall not be
1920 contained in their names. The transform function/filename may contain only
1921 characters which cause no problems in the file system as well as the PHP function
1922 naming convention.<br /><br />
1924 The transform function will the be called 'PMA_transform_[mimetype]_[subtype]__[transform]()'.<br /><br />
1926 <b>Example:</b><br /><br />
1928 text_html__formatted.inc.php3<br />
1929 PMA_transform_text_html__formatted()</li>
1931 <li>A mimetype (w/o subtype) transform:<br /><br />
1933 [mimetype]__[transform].inc.php3<br /><br />
1935 Please note that there are no single '_' characters.
1936 The transform function/filename may contain only characters which cause no problems
1937 in the file system as well as the PHP function naming convention.<br /><br />
1939 The transform function will the be called 'PMA_transform_[mimetype]__[transform]()'.<br /><br />
1941 <b>Example:</b><br /><br />
1943 text__formatted.inc.php3<br />
1944 PMA_transform_text__formatted()</li>
1946 <li>A mimetype+subtype without specific transform function<br /><br />
1948 [mimetype]_[subtype].inc.php3<br /><br />
1950 Please note that there are no '__' characters in the filename. Do not use special
1951 characters in the filename causing problems with the file system.<br /><br />
1953 No transformation function is defined in the file itself.<br /><br />
1955 <b>Example:</b><br /><br />
1957 text_plain.inc.php3<br />
1958 (No function)</li>
1960 <li>A mimetype (w/o subtype) without specific transform function<br /><br />
1962 [mimetype].inc.php3<br /><br />
1964 Please note that there are no '_' characters in the filename. Do not use special
1965 characters in the filename causing problems with the file system.<br /><br />
1967 No transformation function is defined in the file itself.<br /><br />
1969 <b>Example:</b><br /><br />
1971 text.inc.php3<br />
1972 (No function)</li>
1974 <li>A global transform function with no specific mimetype<br /><br />
1976 global__[transform].inc.php3<br /><br />
1978 The transform function will the be called 'PMA_transform_global__[transform]()'.<br /><br />
1980 <b>Example:</b><br /><br />
1982 global__formatted<br />
1983 PMA_transform_global__formatted()</li>
1984 </ol>
1986 <br />
1987 <p>So generally use '_' to split up mimetype and subtype, and '__' to provide a
1988 transform function.</p><br />
1990 <p>All filenames containing no '__' in themselves are not shown as valid transform
1991 functions in the dropdown.</p><br />
1993 <p>Please see the libraries/transformations/TEMPLATE file for adding your own transform
1994 function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
1995 without a transform function. Also note the introduction of a function description in
1996 the language files. For each function a $strTransformation_[filename without .inc.php3]
1997 has to exist.</p><br />
1999 <p>You can use the template generator to generate new functions and entries in the
2000 language file.</p><br />
2002 <p>To create a new transform function please see libraries/transformations/template_generator.sh.
2003 To create a new, empty mimetype please see libraries/transformations/template_generator_mimetype.sh.</p><br />
2005 <!-- FAQ -->
2007 <h2>FAQ - Frequently Asked Questions</h2>
2009 <p>
2018 </p>
2021 <h3>[1. Server]</h3>
2023 <h4>
2024 [1.1] I'm running PHP 4+ and my server is crashing each time a specific
2025 action is required or phpMyAdmin sends a blank page or a page full of
2026 cryptic characters to my browser, what can I do?
2027 </h4>
2028 <p>
2029 There are some known PHP bugs with output buffering and compression.<br />
2030 Try to set the <tt>$cfg['OBGzip']</tt> directive to <tt>FALSE</tt> in your
2031 <i>config.inc.php or .php3</i> file and the
2032 <tt>zlib.output_compression</tt> directive to <tt>Off</tt> in your php
2033 configuration file.<br />
2034 Furthermore, we know about such problems connected to the release
2035 candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together with
2036 MS Internet Explorer. Please upgrade to the release version PHP 4.2.0.
2037 </p>
2039 <h4>
2040 [1.2] My Apache server crashes when using phpMyAdmin.
2041 </h4>
2042 <p>
2043 You should first try the latest versions of Apache (and possibly MySQL).
2044 <br />
2045 See also the other FAQ entry about PHP bugs with output buffering.
2046 <br />
2047 If your server keeps crashing, please ask for help in the various
2048 Apache support groups.
2049 </p>
2051 <h4>
2053 PHP 4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the
2054 script: I'm always displayed the login screen.
2055 </h4>
2056 <p>
2057 This is a known PHP bug (see this
2059 official PHP bug database. It means there is and won't be any phpMyAdmin
2060 fix against it because there is no way to code a fix.
2061 </p>
2063 <h4>
2064 [1.4] Using phpMyAdmin on IIS, I'm displayed the error message:
2065 "The specified CGI application misbehaved by not returning a
2066 complete set of HTTP headers...".
2067 </h4>
2068 <p>
2069 You just forgot to read the <i>install.txt</i> file from the php
2070 distribution. Have a look at the last message in this
2072 official PHP bug database.
2073 </p>
2075 <h4>
2076 [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
2077 messages with the HTTP or advanced authentication mode.
2078 </h4>
2079 <p>
2080 This is a known problem with the PHP ISAPI filter: it's not so stable. For
2081 some more information and complete testings see the messages posted by
2082 André B. aka "djdeluxe76" in
2083 <a href="http://www.phpwizard.net/phorum/read.php?f=1&i=6624&t=6300">this thread</a>
2084 from the phpWizard forum.<br />
2085 Please use instead the cookie authentication mode.
2086 </p>
2088 <h4>
2089 [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!</h4>
2090 <p>
2091 This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
2092 time there is no better fix): remove or comment the <tt>DOCTYPE</tt>
2093 declarations (2 lines) from the scripts <i>header.inc.php3</i>,
2094 <i>header_printview.inc.php3</i>, <i>index.php3</i>, <i>left.php3</i> and
2095 <i>libraries/common.lib.php3</i>.
2096 </p>
2098 <h4>
2099 [1.7] How can I GZip or Bzip a dump or a CSV export. It does not seem to
2100 work.
2101 </h4>
2102 <p>
2103 These features are based on the <tt>gzencode()</tt> and
2104 <tt>bzcompress()</tt> PHP functions to be more independent of the platform
2105 (Unix/Windows, Safe Mode or not, and so on).
2106 So, you must have PHP4 >= 4.0.4 and Zlib/Bzip2 support
2107 (<tt>--with-zlib</tt> and <tt>--with-bz2</tt>).<br />
2108 We faced PHP crashes when trying to download a dump with MS Internet
2109 Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0. In
2110 this case you should switch to the release version of PHP 4.2.0.
2111 </p>
2113 <h4>
2114 [1.8] I cannot insert a text file in a table, and I get an error about
2115 safe mode being in effect.
2116 </h4>
2117 <p>
2118 Your uploaded file is saved by PHP in the "upload dir", as
2119 defined in <i>php.ini</i> by the variable <tt>upload_tmp_dir</tt> (usually
2120 the system default is <i>/tmp</i>).
2121 <br />
2122 We recommend the following setup for Apache servers running in safe mode,
2123 to enable uploads of files while being reasonably secure:
2124 </p>
2125 <ul>
2126 <li>create a separate directory for uploads:
2127 <tt>mkdir /tmp/php</tt></li>
2128 <li>give ownership to the Apache server's user.group:
2129 <tt>chown apache.apache /tmp/php</tt></li>
2130 <li>give proper permission: <tt>chmod 600 /tmp/php</tt></li>
2131 <li>put <tt>upload_tmp_dir = /tmp/php</tt> in php.ini</li>
2132 <li>restart Apache</li>
2133 </ul>
2135 <h4>
2136 [1.9] I'm having troubles when uploading files. In general file uploads
2137 don't work on my system and uploaded files have a <tt>Content-Type:</tt>
2138 header in the first line.
2139 </h4>
2140 <p>
2141 It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat 7.0
2142 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't you?
2143 <br />
2144 So the problem is that this package has a serious bug that was corrected
2145 ages ago in PHP (2001-01-28: see
2147 for more details). The problem is that the bugged package is still
2148 available though it was corrected (see
2150 for more details).
2151 <br />
2152 So please download
2153 <a href="http://www.redhat.com/swr/i386/php-4.0.4pl1-9.i386.html">the fixed package (4.0.4pl1-9)</a>
2154 and the problem should go away.
2155 <br />
2156 And that fixes the \r\n problem with file uploads!
2157 </p>
2159 <h4>
2160 [1.10] I'm having troubles when uploading files with phpMyAdmin running
2161 on a secure server. My browser is Internet Explorer and I'm using the
2162 Apache server.
2163 </h4>
2164 <p>
2165 As suggested by "Rob M" in the phpWizard forum, add this line to
2166 your <i>httpd.conf</i>:<br />
2167 <tt>SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown</tt><br />
2168 It seems to clear up many problems between Internet Explorer and SSL.
2169 </p>
2171 <h4>
2172 [1.11] I get an 'open_basedir restriction' while uploading a file from
2173 the query box.
2174 </h4>
2175 <p>
2176 Since version 2.2.4, phpMyAdmin supports servers with open_basedir
2177 restrictions. Assuming that the restriction allows you to open files in the
2178 current directory ('.'), all you have to do is create a 'tmp' directory
2179 under the phpMyAdmin install directory, with permissions 777 and the same
2180 owner as the owner of your phpMyAdmin directory. The uploaded files will
2181 be moved there, and after execution of your SQL commands, removed.
2182 </p>
2184 <h4>
2185 [1.12] I have lost my MySQL root password, what can I do?
2186 </h4>
2187 <p>
2188 The MySQL manual explains how to
2190 reset the permissions</a>.
2191 </p>
2193 <h4>
2194 [1.13] I get an error 'No SQL query' when trying to execute a bookmark.
2195 </h4>
2196 <p>
2197 If PHP does not have read/write access to its <tt>upload_tmp_dir</tt>, it
2198 cannot access the uploaded query.
2199 </p>
2201 <h4>
2202 [1.14] I get an error 'No SQL query' when trying to submit a query from
2203 the convenient text area.
2204 </h4>
2205 <p>
2206 Check the <tt>post_max_size</tt> directive from your PHP configuration file
2207 and try to increase it.
2208 </p>
2210 <h4>
2211 [1.15] I have problems with <i>mysql.user</i> field names.
2212 </h4>
2213 <p>
2214 In older MySQL versions, the <tt>User</tt> and <tt>Password</tt> fields
2215 were named <tt>user</tt> and <tt>password</tt>. Please modify your field
2216 names to align with current standards.
2217 </p>
2218 <h4>
2219 [1.16] I cannot upload big dump files.
2220 </h4>
2221 <p>
2222 The first things to check (or ask your host provider to check) are the
2223 values of <tt>upload_max_filesize</tt>, <tt>memory_limit</tt> and
2224 <tt>post_max_size</tt> in the <i>php.ini</i> configuration file.
2225 <br />
2226 All of these three settings limit the maximum size of data that can be
2227 submitted and handled by PHP. One user also said that post_max_size
2228 and memory_limit need to be larger than upload_max_filesize.
2229 </p>
2231 <h4>
2232 [1.17] Does phpMyAdmin support MySQL 4.1 and 5.0?
2233 </h4>
2234 <p>
2235 phpMyAdmin provides limited support for MySQL 4.1. That means that you
2236 can neither assign character sets to a table or field on create nor change
2237 the (automatically) assigned character set.<br />
2238 When compiling php, we strongly recommend that you manually link it to a
2239 MySQL 4.1 client library since the one that is currently bundled with
2240 php is rather old and might cause problems.<br />
2241 MySQL 5 is not yet supported.
2242 </p>
2244 <h4>
2245 [1.18] I'm running MySQL <= 4.0.1 having
2246 <tt>lower_case_table_names</tt> set to 1. If I create a new table with a
2247 capital letter in its name it is changed to lowercase as it should. But
2248 if I try to DROP this table MySQL is unable to find the corresponding
2249 file.
2250 </h4>
2251 <p>
2252 This is a bug of MySQL <= 4.0.1. Please upgrade to at least
2253 MySQL 4.0.2 or turn off your <tt>lower_case_table_names</tt>
2254 directive.
2255 </p>
2257 <h4>
2258 [1.19] I can't run the "display relations" feature because the
2259 script seems not to know the font face I'm using!
2260 </h4>
2261 <p>
2262 The "FPDF" library we're using for this feature requires some
2263 special files to use font faces.<br />
2264 Please refers to the
2266 these files.
2267 </p>
2270 <h4>
2271 [1.20] I receive the error "cannot load MySQL extension, please
2272 check PHP Configuration".
2273 </h4>
2274 <p>
2275 To connect to a MySQL server, PHP needs a set of MySQL functions called
2276 "MySQL extension".
2277 This extension may be part of the PHP server (compiled-in), otherwise it
2278 needs to be loaded dynamically. Its name is probably <i>mysql.so</i> or
2279 <i>mysql.dll</i>. phpMyAdmin tried to load the extension but failed.
2280 <br /><br />
2281 Usually, the problem is solved by installing a software package called
2282 "PHP-MySQL" or something similar.
2283 </p>
2285 <h4>
2286 [1.21] I am running the CGI version of PHP under Unix, and I cannot
2287 login using cookie auth.
2288 </h4>
2289 <p>
2290 In <i>php.ini</i>, set <tt>mysql.max_links</tt> higher than 1.
2291 </p>
2293 <h4>
2294 [1.22] I don't see the "Location of text file" field, so
2295 I cannot upload.
2296 </h4>
2297 <p>
2298 This is most likely because in <i>php.ini</i>, your <tt>file_uploads</tt>
2299 parameter is not set to "on".
2300 </p>
2302 <h4>
2303 [1.23] I'm running MySQL on a Win32 machine. Each time I create a new
2304 table the table and field names are changed to lowercase!
2305 </h4>
2306 <p>
2307 This happens because the MySQL directive <tt>lower_case_table_names</tt>
2308 defaults to 1 (<tt>ON</tt>) in the Win32 version of MySQL. You can change
2309 this behavior by simply changing the directive to 0 (<tt>OFF</tt>):<br />
2310 Just edit your <tt>my.ini</tt> file that should be located in your Windows
2311 directory and add the following line to the group [mysqld]:<br />
2312 <tt>set-variable = lower_case_table_names=0</tt><br />
2313 Next, save the file and restart the MySQL service. You can always check the
2314 value of this directive using the query<br />
2315 <tt>SHOW VARIABLES LIKE 'lower_case_table_names';</tt>
2316 </p>
2318 <h4>
2319 [1.24] Some characters are being truncated in my queries, or I get
2320 characters randomly added. I am running PHP 4.2.3.
2321 </h4>
2322 <p>
2323 This is a
2325 </p>
2327 <h4>
2328 [1.25] I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
2329 and I get problems, such as undefined variables when I run a SQL query.
2330 </h4>
2331 <p>
2332 A tip from Jose Fandos: put a comment on the following two lines
2333 in httpd.conf, like this:<br />
2334 <tt># mod_gzip_item_include file \.php$</tt><br />
2336 as this version of mod_gzip on Apache (Windows) has problems handling
2337 PHP scripts. Of course you have to restart Apache.
2338 </p>
2340 <h4>
2341 [1.26] I just installed phpMyAdmin in my document root of IIS but
2342 I get the error "No input file specified" when trying to
2343 run phpMyAdmin.
2344 </h4>
2345 <p>
2346 This is a permission problem. Right-click on the phpmyadmin folder
2347 and choose properties. Under the tab Security, click on "Add"
2348 and select the user "IUSER_machine" from the list. Now set his
2349 permissions and it should work.
2350 </p>
2352 <h4>
2353 [1.27] I get empty page when I want to view huge page (eg.
2354 db_details_structure.php3 with plenty of dabases).
2355 </h4>
2356 <p>
2358 GZIP output buffering enabled. If you turn off it (by <code>$cfg['OBGzip']
2359 = FALSE</code> in config.inc.php3), it should work. This bug will be fixed
2360 in PHP 5.0.0.
2361 </p>
2363 <h4>
2364 [1.28] My MySQL server sometimes refuses queries and returns the message
2365 'Errorcode: 13'. What does this mean?
2366 </h4>
2367 <p>
2368 This can happen due to a MySQL bug when having database / table names with
2369 upper case characters although <tt>lower_case_table_names</tt> is set to 1.
2370 To fix this, turn off this directive, convert all database and table names
2371 to lower case and turn it on again. Alternatively, there's a bug-fix
2372 available starting with MySQL 3.23.56 / 4.0.11-gamma.
2373 </p>
2376 <h4>
2377 [1.29] When I create a table or modify a field, I get an error
2378 and the fields are duplicated.
2379 </h4>
2380 <p>
2381 It is possible to configure Apache in such a way that PHP has problems
2382 interpreting .php files.
2383 <br /><br />
2384 The problems occur when two different (and conflicting) set of directives
2385 are used:
2386 <br /><br />
2387 <tt>
2388 SetOutputFilter PHP<br />
2389 SetInputFilter PHP<br />
2390 </tt>
2391 &
2392 <br />
2393 <tt>
2394 AddType application/x-httpd-php .php
2395 </tt>
2396 <br /><br />
2397 In the case we saw, one set of directives was in <tt>httpd.conf</tt>, while
2398 the other set was in <tt>php.conf</tt>.<br />
2399 The recommended way is with <tt>AddType</tt>, so just comment out
2400 the first set of lines and restart Apache:
2401 <br /><br />
2402 <tt><b>
2403 #SetOutputFilter PHP<br />
2404 #SetInputFilter PHP<br /></b>
2405 </tt>
2406 </p>
2409 <h3>[2. Configuration]</h3>
2411 <h4>
2412 [2.1] The error message "Warning: Cannot add header information -
2413 headers already sent by ..." is displayed, what's the problem?
2414 </h4>
2415 <p>
2416 Edit your <i>config.inc.php or .php3</i> file and ensure there is nothing
2417 (I.E. no blank lines, no spaces, no characters...) neither before the
2418 <tt><?php</tt> tag at the beginning, neither after the <tt>?></tt>
2419 tag at the end.
2420 </p>
2422 <h4>
2423 [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
2424 </h4>
2425 <p>
2426 Either there is an error with your PHP setup or your username/password is
2427 wrong. Try to make a small script which uses mysql_connect and see if it
2428 works. If it doesn't, it may be you haven't even compiled MySQL support
2429 into PHP.
2430 </p>
2432 <h4>
2433 [2.3] The error message "Warning: MySQL Connection Failed: Can't
2434 connect to local MySQL server through socket '/tmp/mysql.sock'
2435 (111)..." is displayed. What can I do?
2436 </h4>
2437 <p><br />
2438 For RedHat users, Harald Legner suggests this on the mailing list:
2439 <br /><br />
2440 On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
2441 In your php.ini you will find a line
2442 <br />
2443 <tt>mysql.default_socket = /tmp/mysql.sock</tt>
2444 <br />
2445 change it to
2446 <br />
2447 <tt>mysql.default_socket = /var/lib/mysql/mysql.sock</tt>
2448 <br />
2449 Then restart apache and it will work.
2450 <br /><br />
2451 Here is a fix suggested by Brad Ummer in the phpwizard forum:
2452 </p>
2453 <ul>
2454 <li>
2455 First, you need to determine what socket is being used by MySQL.
2456 <br />
2457 To do this, telnet to your server and go to the MySQL bin directory. In
2458 this directory there should be a file named <i>mysqladmin</i>. Type
2459 <tt>./mysqladmin variables</tt>, and this should give you a bunch of
2460 info about your MySQL server, including the socket
2461 (<i>/tmp/mysql.sock</i>, for example).
2462 </li>
2463 <li>
2464 Then, you need to tell PHP to use this socket.<br />Assuming you are
2465 using PHP 3.0.10 or better, you can specify the socket to use when you
2466 open the connection. To do this in phpMyAdmin, you need to complete the
2467 socket information in the config.inc.php3.<br />
2468 For example:
2469 <tt>$cfg['Servers'][$i]['socket'] = '/tmp/mysql.sock';</tt><br /><br />
2470 Please also make sure that the permissions of this file allow to be readable
2471 by your webserver (i.e. '0755').
2472 </li>
2473 </ul>
2474 <p>
2475 Have also a look at the
2477 corresponding section of the MySQL documentation</a>.
2478 </p>
2480 <h4>
2481 [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin,
2482 what can I do?
2483 </h4>
2484 <p>
2485 Try to set the <tt>$cfg['OBGZip']</tt> directive to <tt>FALSE</tt> in the
2486 phpMyAdmin configuration file. It helps sometime.<br />
2487 Also have a look at your PHP version number: if it contains
2488 "4.0b..." it means you're running a beta version of PHP. That's
2489 not a so good idea, please upgrade to a plain revision.
2490 </p>
2492 <h4>
2493 [2.5] Each time I want to insert or change a record or drop a database
2494 or a table, an error 404 (page not found) is displayed or, with HTTP or
2495 cookie authentication, I'm asked to login again. What's wrong?
2496 </h4>
2497 <p>
2498 Check the value you set for the <tt>$cfg['PmaAbsoluteUri']</tt> directive
2499 in the phpMyAdmin configuration file.
2500 </p>
2502 <h4>
2503 [2.6] I get an "Access denied for user: 'root@localhost' (Using
2504 password: YES)"-error when trying to access a MySQL-Server on a
2505 host which is port-forwarded for my localhost
2506 </h4>
2507 <p>
2508 When you are using a port on your localhost, which you redirect via
2509 port-forwarding to another host, MySQL is not resolving the localhost
2510 as expected.<br />
2511 Erik Wasser explains: The solution is: if your host is "localhost"
2512 MySQL (the commandline tool 'mysql' as well) always tries to use the socket
2513 connection for speeding up things. And that doesn't work in this configuration
2514 with port forwarding.<br />
2516 TCP connection.
2517 </p>
2521 <h3>[3. Known limitations]</h3>
2523 <h4>
2524 [3.1] When using HTTP authentication, an user who logged out can not
2525 relogin in with the same nick.
2526 </h4>
2527 <p>
2528 This is related to the authentication mechanism (protocol) used by
2529 phpMyAdmin. We plan to change it as soon as we may find enough free time
2530 to do it, but you can bypass this problem: just close all the opened
2531 browser windows and then go back to phpMyAdmin. You should be able to
2532 log in again.
2533 </p>
2535 <h4>
2536 [3.2] When dumping a large table in compressed mode, I get a memory
2537 limit error or a time limit error.
2538 </h4>
2539 <p>
2540 As of version 2.2.4, we build the compressed dump in memory, so large
2541 tables dumps may hang. The only alternative we can think about (using
2542 system calls to mysqldump then gzip or bzip2) would not be applicable in
2543 environments where PHP is in safe mode: access to system programs is
2544 is limited by the system administrator, and time limit is enforced.
2545 </p>
2547 <h4>
2548 [3.3] With InnoDB tables, I lose foreign key relationships when I rename
2549 or alter a table.
2550 </h4>
2551 <p>
2552 This seems to be a InnoDB bug (fixed in MySQL 3.23.50?). However, keep in
2553 mind that phpMyAdmin as of version 2.3.0 does not support InnoDB.
2554 </p>
2556 <h4>
2557 [3.4] I am unable to import dumps I created with the mysqldump tool
2558 bundled with the MySQL server distribution.
2559 </h4>
2560 <p>
2561 The problem is that mysqldump creates invalid comments like this:
2562 </p>
2563 <pre>
2564 -- MySQL dump 8.22
2565 --
2566 -- Host: localhost Database: database
2567 ---------------------------------------------------------
2568 -- Server version 3.23.54
2569 </pre>
2570 <p>
2571 The invalid part of the code is the horizontal line made of dashes that
2572 appears once in every dump created with mysqldump. If you want to run your
2573 dump you have to turn it into valid MySQL. This means, you have to add a
2574 whitespace after the first to dashes of the line or add a # before it:
2575 <br />
2576 <code>
2577 -- -------------------------------------------------------<br />
2578 </code>
2579 or<br />
2580 <code>
2581 #---------------------------------------------------------
2582 </code>
2583 </p>
2585 <h4>
2586 [3.3] When using nested folders ($cfg['LeftFrameTableSeparator']) there
2587 are some multiple hierarchies displayed in a wrong manner?!
2588 </h4>
2589 <p>
2590 Please note that you should not use the seperating string multiple times
2591 without any characters between them, or at the beginning/end of your table
2592 name. If you have to, think about using another TableSeparator or disabling
2593 that feature
2594 </p>
2597 <h3>[4. ISPs, multi-user installations ]</h3>
2599 <h4>
2600 [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I
2601 need to install it for each customer.
2602 </h4>
2603 <p>
2604 Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
2605 your users. The development of this feature was kindly sponsored by
2606 NetCologne GmbH.
2607 This requires a properly setup MySQL user management and phpMyAdmin
2608 HTTP or cookie authentication. See the install section on
2609 "Using HTTP authentication".
2610 </p>
2612 <h4>
2613 [4.2] What's the preferred way of making phpMyAdmin secure against evil
2614 access.
2615 </h4>
2616 <p>
2617 This depends on your system.<br />
2618 If you're running a server which cannot be accessed by other people, it's
2619 sufficient to use the directory protection bundled with your webserver
2620 (with Apache you can use <i>.htaccess</i> files, for example).<br />
2621 If other people have telnet access to your server, you should use
2622 phpMyAdmin's HTTP authentication feature.
2623 <br /><br />
2624 Suggestions:
2625 </p>
2626 <ul>
2627 <li>
2628 Your <i>config.inc.php3</i> file should be <tt>chmod 660</tt>.
2629 </li>
2630 <li>
2631 All your phpMyAdmin files should be chown phpmy.apache, where phpmy
2632 is a user whose password is only known to you, and apache is the
2633 group under which Apache runs.
2634 </li>
2635 <li>
2636 You should use PHP safe mode, to protect from other users that try
2637 to include your <i>config.inc.php3</i> in their scripts.
2638 </li>
2639 </ul>
2641 <h4>
2642 [4.3] I get errors about not being able to include a file in
2643 <i>/lang</i> or in <i>/libraries</i>.
2644 </h4>
2645 <p>
2646 Check <i>php.ini</i>, or ask your sysadmin to check it. The
2647 <tt>include_path</tt> must contain "." somewhere in it, and
2648 <tt>open_basedir</tt>, if used, must contain "." and
2649 "./lang" to allow normal operation of phpMyAdmin.
2650 </p>
2651 <h4>
2652 [4.4] phpMyAdmin always gives "Access denied" when using HTTP
2653 authentication.
2654 </h4>
2655 <p>
2656 This could happen for several reasons:
2657 </p>
2658 <ul>
2659 <li>
2660 <tt>$cfg['Servers'][$i]['controluser']</tt> and/or
2661 <tt>$cfg['Servers'][$i]['controlpass']</tt> are wrong.
2662 </li>
2663 <li>
2664 The username/password you specify in the login-dialog are invalid.
2665 </li>
2666 <li>
2667 You have already setup a security mechanism for the
2668 phpMyAdmin-directory, eg. a .htaccess file. This would interfere with
2669 phpMyAdmin's authentication, so remove it.
2670 </li>
2671 </ul>
2673 <h4>
2674 [4.5] Is it possible to let users create their own databases?
2675 </h4>
2676 <p>
2677 Starting with 2.2.5, in the user management page, you can enter a wildcard
2678 database name for a user (for example "joe%"),
2679 and put the privileges you want. For example,
2680 adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
2681 would let a user create/manage his/her database(s).
2682 </p>
2684 <h4>
2685 [4.6] How can I use the Host-based authentication additions?
2686 </h4>
2687 <p>
2688 If you have existing rules from an old .htaccess file, you can take them
2689 and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
2690 <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
2691 be a major benefit here if your installation is suited to using it. Then
2692 you can just add those updated lines into the
2693 <tt>$cfg['Servers'][$i]['AllowDeny']['rules']</tt> array.
2694 <br /><br />
2695 If you want a pre-made sample, you can try this fragment. It stops the
2696 'root' user from logging in from any networks other than the private
2697 network IP blocks.
2698 <br />
2699 <tt>
2700 //block root from logging in except from the private networks<br />
2701 $cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';<br />
2702 $cfg['Servers'][$i]['AllowDeny']['rules'] = array(<br />
2703 'deny root from all',<br />
2704 'allow root from localhost',<br />
2705 'allow root from 10.0.0.0/8',<br />
2706 'allow root from 192.168.0.0/16',<br />
2707 'allow root from 172.16.0.0/12',<br />
2708 );
2709 </tt>
2710 </p>
2711 <h4>
2712 [4.7] Authentication window is displayed more than once, why?
2713 </h4>
2714 <p>
2715 This happens if you are using a URL to start phpMyAdmin which is
2716 different than the one set in your <tt>$cfg['PmaAbsoluteUri']</tt>.
2717 For example, a missing "www", or entering with an IP address
2718 while a domain name is defined in the config file.
2719 </p>
2722 <h3>[5. Browsers or client OS]</h3>
2724 <h4>
2725 [5.1] I get an out of memory error, and my controls are non-functional,
2726 when trying to create a table with more than 14 fields.
2727 </h4>
2728 <p>
2729 We could reproduce this problem only under Win98/98SE. Testing under
2730 WinNT4 or Win2K, we could easily create more than 60 fields.
2731 <br />
2732 A workaround is to create a smaller number of fields, then come back to
2733 your table properties and add the other fields.
2734 </p>
2736 <h4>
2737 [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
2738 </h4>
2739 <p>
2740 This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
2741 with each script/website that use forms.<br />
2742 Upgrade or downgrade your Xitami server.
2743 </p>
2745 <h4>
2746 [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
2747 </h4>
2748 <p>
2749 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
2750 the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
2751 don't seem to work.<br />
2753 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
2754 the user's temporary directory, so they must be moved before closing
2755 Konqueror, or else they disappear. GZip dumps give an error message.<br />
2757 Testing needs to be done for Konqueror 2.2.2.<br />
2758 </p>
2760 <h4>
2761 [5.4] I can't use the cookie authentication mode because Internet
2762 Explorer never stores the cookies.
2763 </h4>
2764 <p>
2765 MS Internet Explorer seems to be really buggy about cookies, at least till
2766 version 6. And thanks to Andrew Zivolup we've traced also a PHP 4.1.1 bug
2767 in this area!
2768 <br />
2769 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it may
2770 work!
2771 </p>
2773 <h4>
2774 [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
2775 rows.
2776 </h4>
2777 <p>
2778 Upgrade to at least Internet Explorer 5.5 SP2.<br />
2779 </p>
2781 <h4>
2783 when trying to modify a row in a table with many fields, or with a text field
2784 </h4>
2785 <p>
2786 Your table neither have a primary key nor an unique one, so we must use a
2787 long URL to identify this row. There is a limit on the length of the URL in
2788 those browsers, and this not happen in Netscape, for example. The
2789 workaround is to create a primary or unique key, or use another browser.
2790 <br />
2791 </p>
2793 <h4>
2794 [5.7] I refresh (reload) my browser, and come back to the welcome
2795 page.
2796 </h4>
2797 <p>
2798 Some browsers support right-clicking into the frame you want to refresh,
2799 just do this in the right frame.<br />
2800 </p>
2802 <h4>
2803 [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
2804 query box.
2805 </h4>
2806 <p>
2807 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
2808 Mozilla versions.<br />
2809 </p>
2811 <h4>
2812 [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
2813 whitespace in the SQL-Query edit area: the page scrolls down.
2814 </h4>
2815 <p>
2816 This is a Mozilla bug (see bug #26882 at
2818 </p>
2820 <h4>
2821 [5.10] With Netscape 4.75 I get empty rows between each row of data in a
2822 CSV exported file.
2823 </h4>
2824 <p>
2825 This is a known Netscape 4.75 bug: it adds some line feeds when exporting
2826 data in octet-stream mode. Since we can't detect the specific Netscape
2827 version, we cannot workaround this bug.
2828 </p>
2830 <h4>
2831 [5.11] Extended-ASCII characters like German umlauts are displayed
2832 wrong.
2833 </h4>
2834 <p>
2835 Please ensure that you have set your browser's character set to the one of the
2836 language file you have selected on phpMyAdmin's start page.
2837 Alternatively, you can try the auto detection mode that is supported by the
2838 recent versions of the most browsers.
2839 </p>
2841 <h4>
2842 [5.12] Apple OS X: Safari browser changes special characters to
2843 "?".
2844 </h4>
2845 <p>
2846 This issue has been reported by a OS X user, who adds that Chimera,
2847 Netscape and Mozilla do not have this problem.
2848 </p>
2850 <h4>
2851 [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type,
2852 I cannot manage two servers: I login to the first one, then the other one,
2853 but if I switch back to the first, I have to login on each operation.
2854 </h4>
2855 <p>
2856 This is a bug in Internet Explorer, other browsers do not behave this way.
2857 </p>
2859 <h4>
2860 [5.14] Using Opera6, I can manage to get to the authentification, but nothing
2861 happens after that, only a blank screen.
2862 </h4>
2863 <p>
2864 Having $cfg['QueryFrameJS'] set to TRUE, this leads to a bug in Opera6, because it
2865 is not able to interpret frameset definitiions written by JavaScript. Please upgrade
2866 to Opera7 at least.
2867 </p>
2870 <h3>[6. Using phpMyAdmin]</h3>
2872 <h4>
2873 [6.1] I can't insert new rows into a table / I can't create a table
2874 - MySQL brings up a SQL-error.
2875 </h4>
2876 <p>
2877 Examine the SQL error with care. Often the problem is caused by
2878 specifying a wrong field-type.<br />
2879 Common errors include:
2880 </p>
2881 <ul>
2882 <li>Using <tt>VARCHAR</tt> without a size argument</li>
2883 <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
2884 </ul>
2885 <p>
2886 Also, look at the syntax chapter in the MySQL manual to confirm that your
2887 syntax is correct.
2888 </p>
2890 <h4>
2891 [6.2] When I create a table, I click the Index checkbox for 2 fields and
2892 phpMyAdmin generates only one index with those 2 fields.
2893 </h4>
2894 <p>
2895 In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a multi-fields
2896 index. If you want two indexes, create the first one when creating the
2897 table, save, then display the table properties and click the Index link to
2898 create the other index.
2899 </p>
2901 <h4>
2902 [6.3] How can I insert a null value into my table?
2903 </h4>
2904 <p>
2905 Since version 2.2.3, you have a checkbox for each field that can be null.
2906 Before 2.2.3, you had to enter "null", without the quotes, as the
2907 field's value.
2908 </p>
2910 <h4>
2911 [6.4] How can I backup my database or table?
2912 </h4>
2913 <p>
2914 Click on a database or table name in the left frame, the properties will be
2915 displayed. Then on the menu, click "Export", you can dump
2916 the structure, the data, or both. This will generate standard SQL
2917 statements that can be used to recreate your database/table.
2918 <br /><br />
2919 You will need to choose "Save as file", so that phpMyAdmin can
2920 transmit the resulting dump to your station. Depending on your PHP
2921 configuration, you will see options to compress the dump. See also the
2922 <tt>$cfg['ExecTimeLimit']</tt> configuration variable.
2923 <br /><br />
2924 For additional help on this subject, look for the word "dump" in
2925 this document.
2926 </p>
2928 <h4>
2929 [6.5] How can I restore (upload) my database or table using a dump?
2930 How can I run a ".sql" file.
2931 </h4>
2932 <p>
2933 Click on a database name in the left frame, the properties will be
2934 local displayed. Then in the "Run SQL query" section, type in
2935 your dump filename, or use the Browse button. Then click Go.
2936 <br /><br />
2937 For additional help on this subject, look for the word "upload"
2938 in this document.
2939 </p>
2941 <h4>
2942 [6.6] How can I use the relation table in Query-by-example?
2943 </h4>
2944 <p>
2945 Here is an example with the tables persons, towns and countries, all
2946 located in the database mydb. If you don't have a <tt>PMA_relation</tt>
2947 table, create it as explained in the configuration section. Then create the
2948 example tables:
2949 <br /><br />
2950 <tt>
2951 CREATE TABLE REL_countries (<br />
2952 country_code char(1) NOT NULL default '',<br />
2953 description varchar(10) NOT NULL default '',<br />
2954 PRIMARY KEY (country_code)<br />
2955 ) TYPE=MyISAM;<br />
2956 <br />
2957 INSERT INTO REL_countries VALUES ('C', 'Canada');<br />
2958 <br />
2959 CREATE TABLE REL_persons (<br />
2960 id tinyint(4) NOT NULL auto_increment,<br />
2961 person_name varchar(32) NOT NULL default '',<br />
2962 town_code varchar(5) default '0',<br />
2963 country_code char(1) NOT NULL default '',<br />
2964 PRIMARY KEY (id)<br />
2965 ) TYPE=MyISAM;<br />
2966 <br />
2967 INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');<br />
2968 INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');<br />
2969 <br />
2970 CREATE TABLE REL_towns (<br />
2971 town_code varchar(5) NOT NULL default '0',<br />
2972 description varchar(30) NOT NULL default '',<br />
2973 PRIMARY KEY (town_code)<br />
2974 ) TYPE=MyISAM;<br />
2975 <br />
2976 INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');<br />
2977 INSERT INTO REL_towns VALUES ('M', 'Montréal');<br />
2978 <br />
2979 </tt>
2980 To setup appropriate links and display information:
2981 </p>
2982 <ul>
2983 <li>on table "REL_persons" click Structure, then Relation view</li>
2984 <li>in Links, for "town_code" choose "REL_towns->code"</li>
2985 <li>in Links, for "country_code" choose "REL_countries->country_code"</li>
2986 <li>on table "REL_towns" click Structure, then Relation view</li>
2987 <li>in "Choose field to display", choose "description"</li>
2988 <li>repeat the two previous steps for table "REL_countries"</li>
2989 </ul>
2991 <p>
2992 Then test like this:
2993 </p>
2994 <ul>
2995 <li>Click on your db name in the left frame</li>
2996 <li>Choose "Query"</li>
2997 <li>Use tables: persons, towns, countries</li>
2998 <li>Click "Update query"</li>
2999 <li>In the fields row, choose persons.person_name and click the
3000 "Show" tickbox </li>
3001 <li>Do the same for towns.description and countries.descriptions in the
3002 other 2 columns</li>
3003 <li>Click "Update query" and you will see in the query box that
3004 the correct joins have been generated</li>
3005 <li>Click "Submit query"</li>
3006 </ul>
3007 <br />
3010 <h4>
3011 [6.7] How can I use the "display field" feature?
3012 </h4>
3013 <p>
3014 Starting from the previous example, create the PMA_table_info as explained
3015 in the configuration section, then browse your persons table,
3016 and move the mouse over a town code or country code.
3017 <br /><br />
3018 See also FAQ 6.21 for an additionnal feature that "display field"
3019 enables: drop-down list of possible values.
3020 </p>
3023 <h4>
3024 [6.8] How can I produce a PDF schema of my database?
3025 </h4>
3026 <p>
3027 First you have to fill the "relation", "table_coords"
3028 and "pdf_pages" configuration variables.
3029 <br /><br />
3030 Then, think about your schema layout: which tables will go on which pages.
3031 </p>
3032 <ul>
3033 <li>Click on your db name in the left frame</li>
3034 <li>Choose "Structure" in the navigation on top</li>
3035 <li>Choose "Edit PDF Pages" which should be somewhere at the
3036 bottom of the page</li>
3037 <li>Enter the name for a first pdf page and submit</li>
3038 <li>Choose this page to edit</li>
3039 <li>Now add a table you want to show on this page and it's coordinates and
3040 submit<br />
3041 First you will have to guess this coordinates of course, so just expect
3042 to have an area of about 297 * 210 and put the tables coordinates
3043 somewhere in there, you will be able to have a look at what happened
3044 and change them later.<br />
3045 For example, x=100 and y=200 means that the table will be at 200 mm
3046 down and 100 mm right from the upper left corner.<br />
3047 Actually if you have a width of more than 300 or a height of more than
3048 200 than it will automatically be scaled but 300*100 is a good start to
3049 have an idea of what coordinates to use.</li>
3050 <li>After every table you submitted you will have the possibility to submit
3051 more tables</li>
3052 <li>When you have entered enough tables Click on your db name in the left
3053 frame again</li>
3054 <li>Now, again at the bottom of the page you should be able to choose
3055 "Display PDF schema"<br />
3056 For testing it might be useful to show the grid as well, so you can see
3057 the coordinates used.<br />
3058 Maybe also choose color and submit.</li>
3059 <li>Save the file he will offer you to something like <i>Schema.pdf</i>
3060 (Internet Explorer has some bug there which might make it offer it
3061 without an extension. Under Windows it is important to have the
3062 extension ".pdf", under other OSes you should be fine just
3063 saving the file under the name it offers).</li>
3064 </ul>
3066 <h4>
3067 [6.9] phpMyAdmin is changing the type of one of my columns!
3068 </h4>
3069 <p>
3070 No, it's MySQL that is doing
3071 <a href="http://www.mysql.com/doc/S/i/Silent_column_changes.html">silent column type changing</a>.
3072 </p>
3075 <h4>
3076 [6.10] When creating a privilege, what happens with underscores in
3077 the database name?
3078 </h4>
3079 <p>
3080 If you do not put a backslash before the underscore, this is a wildcard
3081 grant, and the underscore means "any character". So, if the
3082 database name is "john_db", the user would get rights to john1db,
3083 john2db...<br /><br />
3084 If you put a backslash before the underscore, it means that the database
3085 name will have a real underscore.
3086 </p>
3088 <h4>
3089 [6.11] What is the curious symbol ø in the statistics pages?
3090 </h4>
3091 <p>
3092 It means "average".
3093 </p>
3096 <h4>
3097 [6.12] I want to understand some Export options.
3098 </h4>
3099 <p>
3100 "Complete inserts" adds the column names on every INSERT command,
3101 for better documentation (but resulting file is bigger).<br />
3102 "Extended inserts" provides a shorter dump file by using only
3103 once the INSERT verb and the table name.<br />
3104 "Enclose table and field names with backquotes" ensures that
3105 field and table names formed with special characters are protected.<br />
3106 "Include column comments as inline SQL-comments" includes any
3107 column comments set in the PMA-DB in the dump as SQL comments (<i>/* xxx */</i>).<br /></p>
3109 <h4>
3110 [6.13] I would like to create a database with a dot in its name.
3111 </h4>
3112 <p>
3113 This is a bad idea, because in MySQL the syntax "database.table"
3114 is the normal way to reference a database and table name. Worse, MySQL
3115 will usually let you create a database with a dot, but then you cannot
3116 work with it, nor delete it.<br />
3117 </p>
3120 <h4>
3121 [6.14] How do I set up the SQL Validator?
3122 </h4>
3123 <p>
3124 To use it, you need a very recent version of PHP, 4.3.0 recommended, with
3125 XML, PCRE and PEAR support. On your system command line, run
3126 <tt>"pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME
3127 SOAP"</tt> to get the necessary PEAR modules for usage.
3128 <br />
3129 If you use it, you should be aware that any SQL statement you
3130 submit will be stored anonymously (database/table/column names,
3131 strings, numbers replaced with generic values). The Mimer SQL
3132 Validator itself, is © 2001 Upright Database Technology.
3133 We utilize it as free SOAP service.
3134 </p>
3136 <h4>
3137 [6.15] I want to add a BLOB field and put an index on it, but MySQL
3138 says "BLOB column '...' used in key specification without a key
3139 length".
3140 </h4>
3141 <p>
3142 The right way to do this, is to create the field without any indexes,
3143 then display the table structure and use the "Create an index"
3144 dialog. On this page, you will be able to choose your BLOB field, and
3145 set a size to the index, which is the condition to create an index on
3146 a BLOB field.
3147 <br />
3148 </p>
3150 <h4>
3151 [6.16] How can I simply move in page with plenty editing fields?
3152 </h4>
3153 <p>
3154 You can use Ctrl+arrows for moving on most pages with plenty editing
3155 fields (table structure changes, row editing, etc.) (must be anabled in
3156 configuration - see. $cfg['CtrlArrowsMoving']). You can also have a look
3157 at the directive $cfg['DefaultPropDisplay'] ('vertical') and see if this
3158 eases up editing for you.
3159 <br />
3160 </p>
3162 <h4>
3163 [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
3164 then useful for?
3165 </h4>
3166 <p>
3167 Slow down :). Defining mimetypes is of no use, if you can't put transformations on them.
3168 Otherwise you could just put a comment on the field. Because entering your own mimetype will
3169 cause serious syntax checking issues and validation, this introduces a high-risk false-user-input
3170 situation. Instead you have to initialize mimetypes using functions or empty mimetype definitions.
3171 <br />
3172 Plus, you have a whole overview of available mimetypes. Who knows all those mimetypes by heart so
3173 he/she can enter it at will?
3174 <br />
3175 </p>
3178 <h4>
3179 [6.18] Bookmarks: Where can I store bookmarks? Why can't I see any bookmarks below the query box?
3180 What is this variable for?
3181 </h4>
3182 <p>
3183 Any query you have executed can be stored as a bookmark on the page where the results are displayed.
3184 You will find a button labeled 'Bookmark this query' just at the end of the page.<br />
3185 As soon as you have stored a bookmark, it is related to the database you run the query on. You can
3186 now access a bookmark dropdown on each page, the query box appears on for that database.<br />
3187 <br />
3188 Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks. Just use the string
3189 <b>/*[VARIABLE]*/</b> anywhere in your query. Everything which is put into the <i>value</i> input
3190 box on the query box page will replace the string "/*[VARIABLE]*/" in your stored query.
3191 Just be aware of that you HAVE to create a valid query, otherwise your query won't be even able to be
3192 stored in the database.<br />
3193 Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string for your query will remain
3194 the way it is, but will be stripped of the /**/ chars. So you can use:<br /><br />
3195 <code>/*, [VARIABLE] AS myname */</code><br /><br />
3196 which will be expanded to<br /><br />
3197 <code>, VARIABLE as myname</code><br /><br />
3198 in your query, where VARIABLE is the string you entered in the input box. If an empty string is
3199 provided, no replacements are made.<br />
3200 <br />
3201 A more complex example. Say you have stored this query:<br /><br />
3202 <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code><br /><br />
3203 Say, you now enter "phpMyAdmin" as the variable for the stored query, the full query will
3204 be:<br /><br />
3205 <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
3206 <br />
3207 <br />
3208 You can use multiple occurences of <b>/*[VARIABLE]*/</b> in a single query.<br />
3209 <b>NOTE THE ABSENCE OF SPACES</b> inside the "/**/" construct. Any spaces inserted there
3210 will be later also inserted as spaces in your query and may lead to unexpected results especially when
3211 using the variable expansion inside of a "LIKE ''" expression.<br />
3212 Your initial query which is going to be stored as a bookmark has to yield at least one result row so
3213 you can store the bookmark. You may have that to work around using well positioned "/**/"
3214 comments.
3215 </p>
3217 <h4>
3218 [6.19] How can I create simple LaTeX document to include exported table?
3219 </h4>
3220 <p>
3221 You can simply include table in your LaTeX documents, minimal sample
3222 document should look like following one (assuming you have table
3223 exported in file <code>table.tex</code>):
3224 <br />
3225 <br />
3226 <pre>
3227 <font color="#a52a2a"><b>\documentclass</b></font><font color="#6a5acd">{</font><font color="#a020f0">article</font><font color="#6a5acd">}</font>
3228 <font color="#a52a2a"><b>\usepackage</b></font><font color="#6a5acd">{</font><font color="#6a5acd">longtable</font><font color="#6a5acd">}</font>
3230 <font color="#a52a2a"><b>\begin</b></font><font color="#6a5acd">{</font><font color="#a020f0">document</font><font color="#6a5acd">}</font>
3232 <font color="#a52a2a"><b>\include</b></font><font color="#6a5acd">{</font><font color="#6a5acd">table</font><font color="#6a5acd">}</font>
3234 <font color="#a52a2a"><b>\end</b></font><font color="#6a5acd">{</font><font color="#a020f0">document</font><font color="#6a5acd">}</font>
3235 </pre>
3236 </p>
3238 <h4>
3239 [6.20] In MySQL 4, I see a lot of databases which are not mine, and cannot
3240 access them.
3241 </h4>
3242 <p>
3243 Upgrading to MySQL 4 usually gives users a global privilege: CREATE
3244 TEMPORARY TABLES. This privilege also enables users to see all the
3246 So if your users do not need this privilege, you can remove it and their
3247 databases list will shorten.
3248 </p>
3249 <h4>
3250 [6.21] In edit/insert mode, how can I see a list of possible values for
3251 a field, based on some foreign table?
3252 </h4>
3253 <p>
3254 You have to setup appropriate links between the tables, and also
3255 setup the "display field" in the foreign table. See FAQ
3256 6.6 for an example. Then, if there are 200 values or less in the
3257 foreign table, a drop-down list of values will be available.
3258 </p>
3260 <h3>[7. phpMyAdmin project]</h3>
3262 <h4>
3263 [7.1] I have found a bug. How do I inform developers?
3264 </h4>
3265 <p>
3266 Our Bug Tracker is located at
3267 <a href="http://sourceforge.net/projects/phpmyadmin/">http://sourceforge.net/projects/phpmyadmin/</a>
3268 under the Bugs section.
3269 <br /><br />
3270 But please first discuss your bug with other users:
3271 <br />
3273 http://sourceforge.net/projects/phpmyadmin/</a> (and choose Forums)
3274 </p>
3276 <h4>
3277 [7.2] I want to translate the messages to a new language or upgrade an
3278 existing language, where do I start?
3279 </h4>
3280 <p>
3281 Always use the current CVS version of your language file.
3282 For a new language, start from <i>english-iso-8859-1.inc.php3</i>. If you
3283 don't know how to get the CVS version, please ask one of the developers.
3284 <br />
3285 Please note that we try not to use HTML entities like &eacute; in
3286 the translations, since we define the right character set in the file.
3287 With HTML entities, the text on JavaScript messages would not
3288 display correctly.
3289 However there are some entities that need to be there, for quotes
3290 ,non-breakable spaces, ampersands, less than, greater than.
3291 <br />
3292 You can then put your translations, as a zip file to avoid losing special
3293 characters, on the sourceforge.net translation tracker.
3294 <br />
3295 It would be a good idea to subscribe to the phpmyadmin-translators mailing
3296 list, because this is where we ask for translations of new messages.
3297 <br />
3298 </p>
3300 <h4>
3301 [7.3] I would like to help out with the development of phpMyAdmin. How
3302 should I proceed?
3303 </h4>
3304 <p>
3305 The following method is preferred for new developers:
3306 </p>
3307 <ol>
3308 <li>
3309 fetch the current CVS tree over anonymous CVS:<br />
3310 <tt>cvs -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin login</tt><br />
3311 [Password: simply press the Enter key]<br />
3312 <tt>cvs -z3 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin checkout phpMyAdmin</tt><br />
3313 [This will create a new sub-directory named phpMyAdmin]
3314 </li>
3315 <li>
3316 add your stuff
3317 </li>
3318 <li>
3319 put the modified files (tar'ed and gzip'ed) inside the patch tracker of
3320 the
3321 <a href="http://sourceforge.net/projects/phpmyadmin/" target="_blank">phpMyAdmin SourceForge account</a>.
3322 </li>
3323 </ol>
3324 <p>
3325 Write access to the CVS tree is granted only to experienced developers who
3326 have already contributed something useful to phpMyAdmin.<br />
3327 Also, have a look at the
3329 </p>
3331 <h3>[8. Security ]</h3>
3333 <h4>
3334 [8.1] Security alert, dated 2003-06-18.
3335 </h4>
3336 <p>
3337 Last update of this FAQ: 2003-07-02.
3338 <br /><br />
3339 The phpMyAdmin development team received notice of this security alert:
3340 <a href="http://www.securityfocus.com/archive/1/325641" target="_blank">http://www.securityfocus.com/archive/1/325641.</a>
3341 <br /><br />
3343 The team regrets that the author did not communicate with us before
3344 sending this alert. However, here is our current reply to the points mentionned:
3345 <br /><br />
3346 <ul>
3347 <li>"Directory transversal attack"
3348 <br /><br />
3350 This problem had been fixed in version 2.5.0, even if the author reports
3351 the 2.5.2 development version as vulnerable, which we could not reproduce.
3352 <br /><br />
3353 </li>
3354 <li>"Remote local file retrieving"
3355 <br /><br />
3356 This is a misleading title, as the author tells in his text:
3357 "Note that you can't request files ( only dirs )".
3358 <br /><br />
3359 </li>
3361 <li>"Remote internal directory listing"
3362 <br /><br />
3363 It was possible to retrieve the list of phpMyAdmin's directory (which we
3364 doubt can cause any damage), but we fixed this in the upcoming
3365 2.5.2 version.
3366 <br /><br />
3367 </li>
3369 <li>"XSS and Path disclosures"
3370 <br /><br />
3371 Most of the XSS problems have been fixed in version 2.5.0. The rest
3372 have been fixed in the upcoming 2.5.2 version.
3373 <br /><br />
3374 We are currently looking at the Path disclosure issue.
3375 <br /><br />
3376 </li>
3377 <li>"Information encoding weakness"
3378 <br /><br />
3379 We believe that an exploit for this weakness would be difficult
3380 to achieve. However version 2.5.2-dev now encrypts the password
3381 with the well-known blowfish algorithm.
3382 <br /><br />
3383 </li>
3384 </ul>
3386 </p>
3388 <!-- DEVELOPERS -->
3390 <h2>Developers Information</h2>
3392 <p>
3393 phpMyAdmin is Open Source, so you're invited to contribute to it. Many
3394 great features have been written by other people and you too can help to
3395 make phpMyAdmin a useful tool.
3396 </p>
3398 <p>
3399 If you're planning to contribute source, please read the following
3400 information:
3401 </p>
3402 <ul>
3403 <li>
3404 All files include <i>header.inc.php3</i> (layout),
3405 <i>libraries/common.lib.php3</i> (common functions) and
3406 <i>config.inc.php3</i>.
3407 <br />
3408 All configuration data belongs in <i>config.inc.php3</i>. Please keep
3409 it free from other code.
3410 <br />
3411 Commonly used functions should be added to
3412 <i>libraries/common.lib.php3</i> and more specific ones may be added
3413 within a library stored into the <i>libraries</i> sub-directory.
3414 </li>
3415 <li>
3416 Obviously, you're free to use whatever coding style you want. But
3417 please try to keep your code as simple as possible: beginners are
3418 using phpMyAdmin as an example application.<br />
3419 As far as possible, we want the scripts to be XHTML1.0 and CSS2
3420 compliant on one hand, they fit the
3422 on the other hand. Please pay attention to this.
3423 </li>
3424 <li>
3425 Please try to keep up the file-naming conventions. Table-related stuff
3426 goes to <i>tbl_*.php3</i>, db-related code to <i>db_*.php3</i>,
3427 server-related tools to <i>server_*.php3</i> and so on.
3428 </li>
3429 <li>
3430 Please don't use verbose strings in your code, instead add the string
3431 (at least) to <i>english-iso-8859-1.inc.php3</i> and print() it out.
3432 </li>
3433 <li>
3434 If you want to be really helpful, write an entry for the ChangeLog.
3435 </li>
3438 Debugger DBG</a>) is now supported by phpMyAdmin for developers to
3439 better debug and profile their code.<br />
3440 Please see the <tt>$cfg['DBG']*</tt> configuration options for more
3441 information.<br />
3442 This is in memoriam of the Space Shuttle Columbia (STS-107) which was
3443 lost during its re-entry into Earth's atmosphere and in memory of the
3444 brave men and women who gave their lives for the people of Earth.
3445 </li>
3447 </ul>
3449 <!-- CREDITS -->
3451 <h2>Credits</h2>
3453 <pre>
3455 phpMyAdmin - Credits
3456 ====================
3458 CREDITS, in chronological order
3459 -------------------------------
3461 - Tobias Ratschiller <tobias.ratschiller_at_maguma.com>
3462 * creator of the phpmyadmin project
3463 * maintainer from 1998 to summer 2000
3465 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca>
3466 * multi-language version
3467 * various fixes and improvements
3468 * project co-administrator
3470 - Olivier Müller <om_at_omnis.ch>
3471 * started SourceForge phpMyAdmin project in March 2001
3472 * sync'ed different existing CVS trees with new features and bugfixes
3473 * multi-language improvements, dynamic language selection
3474 * current project maintainer
3475 * many bugfixes and improvements
3477 - Loïc Chapeaux <lolo_at_phpheaven.net>
3478 * rewrote and optimized javascript, DHTML and DOM stuff
3479 * rewrote the scripts so they fit the PEAR coding standards and
3480 generate XHTML1.0 and CSS2 compliant codes
3481 * improved the language detection system
3482 * many bugfixes and improvements
3484 - Robin Johnson <robbat2_at_users.sourceforge.net>
3485 * database maintence controls
3486 * table type code
3487 * Host authentication IP Allow/Deny
3488 * DB-based configuration (Not completed)
3489 * SQL parser
3490 * SQL validator
3491 * many bugfixes and improvements
3493 - Armel Fauveau <armel.fauveau_at_globalis-ms.com>
3494 * bookmarks feature
3495 * multiple dump feature
3496 * gzip dump feature
3497 * zip dump feature
3499 - Geert Lund <glund_at_silversoft.dk>
3500 * various fixes
3501 * moderator of the phpMyAdmin users forum at phpwizard.net
3503 - Korakot Chaovavanich <korakot_at_iname.com>
3504 * "insert as new row" feature
3506 - Pete Kelly <webmaster_at_trafficg.com>
3507 * rewrote and fix dump code
3508 * bugfixes
3510 - Steve Alberty <alberty_at_neptunlabs.de>
3511 * rewrote dump code for PHP4
3512 * mySQL table statistics
3513 * bugfixes
3515 - Benjamin Gandon <gandon_at_isia.cma.fr>
3516 * main author of the version 2.1.0.1
3517 * bugfixes
3519 - Alexander M. Turek <derrabus_at_gmx.de>
3520 * XML exports
3521 * MySQL 4 related features
3522 * various features and fixes
3523 * German language file updates
3525 - Mike Beck <mike.beck_at_ibmiller.de>
3526 * automatic joins in QBE
3527 * links column in printview
3528 * Relation view
3530 - Michal Cihar <nijel_at_users.sourceforge.net>
3531 * enhanced index creation/display feature
3532 * feature to use a different charset for HTML than for MySQL
3533 * Czech language file updates
3535 - Christophe Gesché from the "MySQL Form Generator for PHPMyAdmin"
3536 (http://sourceforge.net/projects/phpmysqlformgen/)
3537 * suggested the patch for multiple table printviews
3539 - Garvin Hicking <hicking_at_faktor-e.de>
3540 * built the patch for vertical display of table rows
3541 * built the Javascript based Query window + SQL history
3542 * Improvement of column/db comments
3543 * (MIME)-Transformations for columns
3544 * Use custom alias names for Databases in left frame
3545 * vertical display of column properties page
3546 * some bugfixes, smaller features
3548 - Yukihiro Kawada <kawada_at_den.fujifilm.co.jp>
3549 * japanese kanji encoding conversion feature
3551 - Piotr Roszatycki <d3xter_at_users.sourceforge.net> and Dan Wilson
3552 * the Cookie authentication mode
3554 - Axel Sander <n8falke_at_users.sourceforge.net>
3555 * table relation-links feature
3557 - Maxime Delorme <delorme.maxime_at_free.fr>
3558 * PDF schema output, thanks also to Olivier Plathey for the
3559 "FPDF" library (see http://www.fpdf.org/).
3561 - Olof Edlund <olof.edlund_at_upright.se>
3562 * SQL validator server
3564 - Ivan R. Lanin <ivanlanin_at_users.sourceforge.net>
3565 * phpMyAdmin logo
3567 - Mike Cochrane <mike_at_graftonhall.co.nz>
3568 * blowfish library from the Horde project
3570 And also to the following people who have contributed minor changes,
3571 enhancements, bugfixes or support for a new language since version 2.1.0:
3573 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
3574 Péter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
3575 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kläger,
3576 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
3577 Bernard M. Piller, Laurent Haas, "Sakamoto", Yuval Sarna,
3578 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
3579 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
3580 Luís V., Martijn W. van der Lee,
3581 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
3582 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, "Manuzhai".
3585 Original Credits of Version 2.1.0
3586 ---------------------------------
3588 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
3589 to create a web-based interface to MySQL using PHP3. Although I have not
3590 used any of his source-code, there are some concepts I've borrowed from
3591 him. phpMyAdmin was created because Peter told me he wasn't going to
3592 further develop his (great) tool.
3593 Thanks go to
3594 - Amalesh Kempf <ak-lsml_at_living-source.com> who contributed the
3595 code for the check when dropping a table or database. He also suggested
3596 that you should be able to specify the primary key on tbl_create.php3. To
3597 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
3598 well as a bug-report. Plus many smaller improvements.
3599 - Jan Legenhausen <jan_at_nrw.net>: He made many of the changes that
3600 were introduced in 1.3.0 (including quite significant ones like the
3601 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
3602 bug-fixes and help.
3603 - Marc Delisle <DelislMa_at_CollegeSherbrooke.qc.ca> made phpMyAdmin
3604 language-independent by outsourcing the strings to a separate file. He
3605 also contributed the French translation.
3606 - Alexandr Bravo <abravo_at_hq.admiral.ru> who contributed
3607 tbl_select.php3, a feature to display only some fields from a table.
3608 - Chris Jackson <chrisj_at_ctel.net> added support for MySQL
3609 functions in tbl_change.php3. He also added the
3610 "Query by Example" feature in 2.0.
3611 - Dave Walton <walton_at_nordicdms.com> added support for multiple
3612 servers and is a regular contributor for bug-fixes.
3613 - Gabriel Ash <ga244_at_is8.nyu.edu> contributed the random access
3614 features for 2.0.6.
3615 The following people have contributed minor changes, enhancements, bugfixes
3616 or support for a new language:
3617 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
3618 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
3619 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
3620 G. Wieggers.
3622 And thanks to everyone else who sent me email with suggestions, bug-reports
3623 and or just some feedback.
3624 </pre>
3631 <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" border="0" height="31" width="88" /></a>
3632
3634 <img src="http://www.w3.org/Icons/valid-css" alt="Valid CSS!" border="0" width="88" height="31" /></a>
3635 </p>
3637 </body>
3638 </html>