update
[phpmyadmin/crack.git] / Documentation.html
blob2778d336e823f1c58aef7dbfced7c4fc798fdf86
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US">
4 <!-- $Id$ -->
5 <!--
6 vim: expandtab ts=4 sw=4 sts=4 tw=78
7 -->
9 <head>
10 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
11 <title>phpMyAdmin 2.5.3-dev - Documentation</title>
12 <link rel="stylesheet" type="text/css" href="docs.css" />
13 </head>
15 <body>
16 <a name="top"></a><br />
18 <div class="header">
19 <hr noshade="noshade" width="100%" />
20 <a href="#top">Top</a> &nbsp;-&nbsp;
21 <a href="#require">Requirements</a> &nbsp;-&nbsp;
22 <a href="#intro">Introduction</a> &nbsp;-&nbsp;
23 <a href="#setup">Installation</a> &nbsp;-&nbsp;
24 <a href="#config">Configuration</a>
25 <br />
26 <a href="#transformations">Transformations</a> &nbsp;-&nbsp;
27 <a href="#faq">FAQ</a> &nbsp;-&nbsp;
28 <a href="#developers">Developers</a> &nbsp;-&nbsp;
29 <a href="#credits">Credits</a> &nbsp;-&nbsp;
30 <a href="translators.html">Translators</a>
31 <hr noshade="noshade" width="100%" />
32 </div>
34 <h1>phpMyAdmin 2.5.3-dev Documentation</h1>
37 <!-- TOP MENU -->
38 <ul>
39 <li>
40 <a href="http://www.phpmyadmin.net/">
41 SourceForge phpMyAdmin project page&nbsp;&nbsp;&nbsp;[ http://www.phpmyadmin.net/ ]
42 </a>
43 </li>
44 <li>
45 Local documents:
46 <ul>
47 <li>Version history: <a href="ChangeLog">ChangeLog</a></li>
48 <li>General notes: <a href="README">README</a></li>
49 <li>License: <a href="LICENSE">LICENSE</a></li>
50 </ul>
51 </li>
52 <li>
53 Documentation version:
54 <i>$Id$</i>
55 </li>
56 </ul>
59 <!-- REQUIREMENTS -->
60 <a name="require"></a><br />
61 <h2>Requirements</h2>
63 <ul>
64 <li>
65 PHP3, PHP4 or PHP5: phpMyAdmin widely uses the 'str_replace()' PHP
66 function that was added in PHP&nbsp;3.0.6, but was buggy up until
67 PHP&nbsp;3.0.8.
68 Then <span class="important">you should not run this script with
69 PHP3&nbsp;&lt;&nbsp;3.0.8</span>.<br />
70 PHP also needs to be <span class="important">compiled with MySQL
71 support</span>;<br />
72 If you want to display inline thumbnails of JPEGs with the original
73 aspect ratio, you also need GD2 support in PHP.
74 </li>
75 <li>
76 MySQL (tested with 3.21.x, 3.22.x, 3.23.x, 4.0.x and 4.1.x);<br />
77 <span class="important">
78 Note: The implemented MySQL&nbsp;4.1.x support is experimental!
79 </span>
80 </li>
81 <li>
82 a web-browser (doh!).
83 </li>
84 </ul>
87 <!-- INTRODUCTION -->
88 <a name="intro"></a><br />
89 <h2>Introduction</h2>
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>
100 <li>create and drop databases</li>
101 <li>create, copy, drop, rename and alter tables</li>
102 <li>do table maintenance</li>
103 <li>delete, edit and add fields</li>
104 <li>execute any SQL-statement, even batch-queries</li>
105 <li>manage keys on fields</li>
106 <li>load text files into tables</li>
107 <li>create (*) and read dumps of tables</li>
108 <li>export (*) data to CSV, XML and Latex formats</li>
109 <li>administer multiple servers</li>
110 <li>manage MySQL users and privileges</li>
111 <li>check referential integrity</li>
112 <li>using Query-by-example (QBE), create complex queries automatically connecting required tables</li>
113 <li>create PDF graphics of your Database layout</li>
114 <li>search globally in a database or a subset of it</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
119 <a href="./translators.html">42 different languages</a>
120 </li>
121 </ul>
123 <p class="footnote">
124 (*)&nbsp;
125 phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats) dumps
126 and CSV exports if you use PHP4&nbsp;>=&nbsp;4.0.4 with Zlib support
127 (<tt>--with-zlib</tt>) and/or Bzip2 support (<tt>--with-bz2</tt>).
128 </p>
131 <!-- INSTALLATION -->
132 <a name="setup"></a><br />
133 <h2>Installation</h2>
136 <span class="important">NOTE: phpMyAdmin does not apply any special security
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
139 &quot;Privileges&quot; page can be used for this.
140 </p>
143 <span class="important">Warning for Mac users:</span>if you are on a MacOS
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
147 end of lines character (&quot;<tt>\r</tt>&quot;).
148 </p>
151 <span class="important">Documentation warning:</span> when you see in this
152 document a <i>.php3</i> file extension, please transpose to <i>.php</i>
153 if you are using a kit with files having this extension.
154 </p>
156 <p><b>Quick Install:</b></p>
157 <ol>
158 <li> Choose and download a distribution kit with the files having the
159 extension (<i>.php3</i> or <i>.php</i>) depending on the way your
160 web/PHP server interprets those extensions.</li>
161 <li> Untar or unzip the distribution (be sure to unzip the subdirectories):
162 <tt>tar -xzvf phpMyAdmin_x.x.x.tar.gz</tt> in your webserver's
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
168 your environment. Here, &quot;host&quot; means the MySQL server.
169 Also insert the correct value for <tt>$cfg['PmaAbsoluteUri']</tt>.
170 Have a look at
171 <a href="#config">Configuration section</a> for an
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
176 <i>.htaccess</i> file). See the
177 <a href="#faq">FAQ section</a> for additional
178 information.</li>
179 <li> Open the file
180 <i>&lt;www.your-host.com&gt;/&lt;your-install-dir&gt;/index.php3</i>
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/
186 directory, where you should find a file called <i>create_tables.sql</i>.
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
189 the database and tables. After having imported the <i>create_tables.sql</i> file,
190 you should specify the table names in your config.inc.php3 file. The directives
191 used for that can be found in the <a href="#config">Configuration section</a>.</li>
193 </ol>
195 <p><b>Upgrading from an older version:</b></p>
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>
203 <p><b>Using authentication modes:</b></p>
204 <ul>
205 <li>HTTP and cookie authentication modes are recommended in a <b>multi-user
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
210 buggy about cookies, at least till version 6. And PHP 4.1.1 is also a
211 bit buggy in this area!<br />
212 Even in a <b>single-user environment</b>, you might prefer to use
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
218 (except for the &quot;controluser&quot; -see the
219 <a href="#config">Configuration section</a>).
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, the password is stored, encrypted with the blowfish
225 algorithm, in a temporary cookie.
226 <br /><br /></li>
228 <li>
229 For 'HTTP' and 'cookie' modes, phpMyAdmin needs a controluser that has
230 <b>only</b> the <tt>SELECT</tt> privilege on the <i>mysql.user (all
231 columns except &quot;Password&quot;)</i>, <i>mysql.db (all columns)</i>
232 &amp; <i>mysql.tables_priv (all columns except &quot;Grantor&quot;
233 &amp; &quot;Timestamp&quot;) </i>tables.<br />
234 You must specify the details for the controluser in the
235 <i>config.inc.php3</i> file under the
236 <tt>$cfg['Servers'][$i]['controluser']</tt>&amp;
237 <tt>$cfg['Servers'][$i]['controlpass']</tt> settings.<br />
238 The following example assumes you want to use <tt>pma</tt> as the
239 controluser and <tt>pmapass</tt> as the controlpass, but <b>this is
240 only an example: use something else in your file!</b><br />
241 Of course you have to replace <tt>localhost</tt> by the webserver's host
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>
272 GRANT SELECT, INSERT, UPDATE, DELETE ON &lt;pma_db&gt; TO 'pma'@'localhost';
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>
280 Then each of the <i>true</i> users should be granted a set of
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 />
285 For example, to grant the user <i>real_user</i> with
286 all privileges on the database <i>user_base</i>:<br />
287 &nbsp;&nbsp;&nbsp;<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
292 fields inside the <tt>$cfg['Servers']</tt> array.<br />
293 </li>
294 </ul>
296 <p><b>'http' authentication mode:</b></p>
297 <ul>
298 <li>Was called 'advanced' in versions before 2.2.3.</li>
299 <li>Introduced in 1.3.0, it uses Basic HTTP authentication method and
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>
305 <p><b>'cookie' authentication mode:</b></p>
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>
310 <li>Obviously, the user must enable cookies in the browser.</li>
311 <li>With this mode, the use can truly logout of phpMyAdmin and login back
312 with the same username.</li>
313 </ul>
315 <p><b>'config' authentication mode:</b></p>
316 <ul>
317 <li>This mode is the less secure one because it requires you to fill the
318 <tt>$cfg['Servers'][$i]['user']</tt> and
319 <tt>$cfg['Servers'][$i]['password']</tt> fields.<br />
320 But you don't need to setup a &quot;controluser&quot; here:
321 using the <tt>$cfg['Servers'][$i]['only_db']</tt> might be enough.</li>
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
325 Host authentication <tt>$cfg['Servers'][$i]['AllowDeny']['order']</tt>
326 and <tt>$cfg['Servers'][$i]['AllowDeny']['rules']</tt> configuration
327 directives.</li>
328 </ul>
331 <!-- CONFIGURATION -->
332 <a name="config"></a><br />
333 <h2>Configuration</h2>
336 <span class="important">Warning for Mac users:</span> PHP seems not to like
337 Mac end of lines character (&quot;<tt>\r</tt>&quot;). So ensure you choose
338 the option that allows to use the *nix end of line character
339 (&quot;<tt>\n</tt>&quot;) in your text editor before registering a script
340 you have modified.
341 </p>
343 <p>All configurable data is placed in <i>config.inc.php3</i>.</p>
344 <dl>
345 <dt><b>$cfg['PmaAbsoluteUri']</b> string</dt>
346 <dd>
347 Sets here the complete URL (with full path) to your phpMyAdmin version.
348 E.g. <tt>http://www.your_web.net/path_to_your_phpMyAdmin_directory/</tt>.
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'] : '')
367 . substr($_SERVER['PHP_SELF'], 0, strrpos($_SERVER['PHP_SELF'], '/')+1);
371 $cfg['PmaAbsoluteUri'] = (!empty($_SERVER['HTTPS']) ? 'https' : 'http') . '://'
372 . $_SERVER['SERVER_NAME']
373 . (!empty($_SERVER['SERVER_PORT']) ? ':' . $_SERVER['SERVER_PORT'] : '')
374 . substr($_SERVER['SCRIPT_NAME'], 0, strrpos($_SERVER['SCRIPT_NAME'], '/')+1);
375 </pre>
376 Please note that the <tt>$_SERVER</tt> array doesn't exist in
377 PHP&nbsp;&lt;&nbsp;4.1.0. Try to replace <tt>$_SERVER</tt> by
378 <tt>$HTTP_SERVER_VARS</tt> or <tt>$GLOBALS</tt> in this case.
379 <br /><br />
380 </dd>
381 <dt><b>$cfg['PmaAbsoluteUri_DisableWarning']</b> boolean</dt>
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>
390 <dt><b>$cfg['PmaNoRelation_DisableWarning']</b> boolean</dt>
391 <dd>
392 Starting with version 2.3.0 phpMyAdmin offers a lot of features to work
393 with master / foreign - tables (see
394 <a href="#pmadb">$cfg['Servers'][$i]['pmadb']</a>).
395 <br />
396 If you tried to set this up and it does not work for you, have a look on
397 the &quot;Structure&quot; page of one database where you would like to
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
401 <tt>TRUE</tt> to stop this message from appearing.
402 <br /><br />
403 </dd>
405 <dt><b>$cfg['blowfish_secret']</b> string</dt>
406 <dd>
407 Starting with version 2.5.2, the 'cookie' auth_type uses blowfish
408 algorithm to encrypt the password.
409 <br />
410 If at least one server configuration uses 'cookie' auth_type,
411 enter here a passphrase that will be used by blowfish.
412 </dd>
414 <dt><b>$cfg['Servers']</b> array</dt>
415 <dd>
416 Since version 1.4.2, phpMyAdmin supports the administration of multiple
417 MySQL servers.
418 Therefore, a $cfg['Servers']-array has been added which contains
419 the login information for the different servers. The first
420 <tt>$cfg['Servers'][$i]['host']</tt> contains the hostname of the first
421 server, the second <tt>$cfg['Servers'][$i]['host']</tt> the hostname of
422 the second server, etc.
423 If you have only one server to administer, simply leave free the
424 hostname of the other $cfg['Server']-entries.
425 <br /><br />
426 </dd>
428 <dt><b>$cfg['Servers'][$i]['host']</b> string</dt>
429 <dd>
430 The hostname or IP address of your $i-th MySQL-server. E.g. localhost.
431 <br /><br />
432 </dd>
434 <dt><b>$cfg['Servers'][$i]['port']</b> string</dt>
435 <dd>
436 The port-number of your $i-th MySQL-server. Default is 3306 (leave
437 blank). If you use &quot;localhost&quot; as the hostname, MySQL
438 ignores this port number and connects with the socket, so if you want
439 to connect to a port different from the default port, use
440 &quot;127.0.0.1&quot; or the real hostname in
441 $cfg['Servers'][$i]['host'].
442 <br /><br />
443 </dd>
445 <dt><b>$cfg['Servers'][$i]['socket']</b> string</dt>
446 <dd>
447 The path to the socket to use. Leave blank for default.<br />
448 To use the socket feature you must run PHP 3.0.10 or more.
449 <br /><br />
450 </dd>
452 <dt><b>$cfg['Servers'][$i]['connect_type']</b> string</dt>
453 <dd>
454 What type connection to use with the MySQL server. Your options are
455 <tt>'socket'</tt> &amp; <tt>'tcp'</tt>. It defaults to 'tcp' as that
456 is nearly guaranteed to be available on all MySQL servers, while
457 sockets are not supported on some platforms.
458 <br /><br />
459 To use the socket mode, your MySQL server must be on the same machine
460 as the Web server.
461 <br /><br />
462 </dd>
464 <dt><b>$cfg['Servers'][$i]['compress']</b> boolean</dt>
465 <dd>
466 Whether to use a compressed protocol for the MySQL server connection
467 or not (experimental).<br />
468 This feature requires PHP&nbsp;&gt;=&nbsp;4.3.0.
469 </dd>
471 <dt>
472 <b>$cfg['Servers'][$i]['controluser']</b> string<br />
473 <b>$cfg['Servers'][$i]['controlpass']</b> string
474 </dt>
475 <dd>
476 When using HTTP or cookie authentication modes (or 'config'
477 authentication mode since phpMyAdmin 2.2.1), you need to supply the
478 details of a MySQL account that has <tt>SELECT</tt> privilege on the
479 <i>mysql.user (all columns except &quot;Password&quot;)</i>,
480 <i>mysql.db (all columns)</i> &amp; <i>mysql.tables_priv (all columns
481 except &quot;Grantor&quot; &amp; &quot;Timestamp&quot;) </i>tables.
482 This account is used to check what databases the user will see at
483 login.<br />
484 Please see the <a href="#setup">install section</a>
485 on &quot;Using HTTP authentication&quot; for more information.
486 <br /><br />
487 Note that if you try login to phpMyAdmin with this
488 &quot;controluser&quot;, you could get some errors, depending the exact
489 privileges you gave to the &quot;controluser&quot;. phpMyAdmin does not
490 support a direct login with the &quot;controluser&quot;.
491 <br /><br />
492 In versions before 2.2.5, those were called
493 &quot;stduser/stdpass&quot;.
494 <br /><br />
495 </dd>
497 <dt><b>$cfg['Servers'][$i]['auth_type']</b> string <tt>['http'|'cookie'|'config']</tt></dt>
498 <dd>
499 Whether config or cookie or http authentication should be used for this
500 server.
502 <ul>
503 <li>
504 'config' authentication
505 (<tt>$auth_type&nbsp;=&nbsp;'config'</tt>) is the plain old
506 way: username and password are stored in
507 <i>config.inc.php3</i>.
508 </li>
509 <li>
510 'cookie' authentication mode
511 (<tt>$auth_type&nbsp;=&nbsp;'cookie'</tt>) as introduced in
512 2.2.3 allows you to log in as any valid MySQL user with the
513 help of... cookies. Log name and password are stored in
514 cookies during the session and password is deleted when it
515 ends.
516 </li>
517 <li>
518 'http' authentication (was called 'advanced' in older versions)
519 (<tt>$auth_type&nbsp;=&nbsp;'http'</tt>) as introduced in 1.3.0
520 allows you to log in as any valid MySQL user via HTTP-Auth.
521 </li>
522 </ul><br />
524 Please see the install section on &quot;Using authentication modes&quot;
525 for more information.
526 <br /><br />
527 </dd>
529 <dt>
530 <b>$cfg['Servers'][$i]['user']</b> string<br />
531 <b>$cfg['Servers'][$i]['password']</b> string
532 </dt>
533 <dd>
534 The user/password-pair which phpMyAdmin will use to connect to this
535 MySQL-server. This user/password pair is not needed when HTTP or cookie
536 authentication is used, and should be empty.<br /><br />
537 </dd>
539 <dt><b>$cfg['Servers'][$i]['only_db']</b> string or array</dt>
540 <dd>
541 If set to a(an array of) database name(s), only this(these) database(s)
542 will be shown to the user. Since phpMyAdmin 2.2.1, this/these
543 database(s) name(s) may contain MySQL wildcards characters
544 (&quot;_&quot; and &quot;%&quot;): if you want to use literal instances
545 of these characters, escape them (I.E. use <tt>'my\_db'</tt> and not
546 <tt>'my_db'</tt>).<br />
547 This setting is an efficient way to lower the server charge since the
548 latter does not need to send MySQL requests to build the available
549 database list. But <span class="important">it does not replace the
550 privileges rules of the MySQL database server</span>. If set, it just
551 means only these databases will be displayed but
552 <span class="important">not at all other databases can't be used.</span>
553 <br /><br />
554 An example of using more that one database:
555 <tt>$cfg['Servers'][$i]['only_db'] = array('db1', 'db2'); </tt>
556 </dd>
558 <dt><b>$cfg['Servers'][$i]['verbose']</b> string</dt>
559 <dd>
560 Only useful when using phpMyAdmin with multiple server entries. If set,
561 this string will be displayed instead of the hostname in the pull-down
562 menu on the main page. This can be useful if you want to show only
563 certain databases on your system, for example.
564 <br /><br />
565 </dd>
567 <dt>
568 <a name="pmadb"></a><br />
569 <b>$cfg['Servers'][$i]['pmadb']</b> string
570 </dt>
571 <dd>
572 Starting with version 2.3.0 phpMyAdmin offers a lot of features
573 to work with master / foreign - tables. To use those as well as
574 the bookmark feature you need special tables with a
575 predefined structure, which we explain below.<br />
576 If you are the only user of this phpMyAdmin installation, you can
577 use your current database to store those special tables; in this
578 case, just put your current database name in
579 <tt>$cfg['Servers'][$i]['pmadb']</tt>.
580 <br /><br />
581 If you are setting up a multi-user phpMyAdmin installation,
582 you will need to create a new database and setup special privileges,
583 so, as superuser:
584 <br /><br />
585 <ul>
586 <li>
587 create a new database for phpMyAdmin:<br />
588 <tt>&nbsp;&nbsp;CREATE DATABASE phpmyadmin;</tt><br />
589 Note that &quot;controluser&quot; must have
590 <tt>SELECT, INSERT, UPDATE</tt> and <tt>DELETE</tt>
591 privileges on this database. Here is a query to set up
592 those privileges (using &quot;phpmyadmin&quot;
593 as the database name, and &quot;pma&quot; as the
594 controluser):<br />
595 <tt>
596 &nbsp;&nbsp;GRANT SELECT,INSERT,UPDATE,DELETE ON phpmyadmin.* to 'pma'@'localhost';
597 </tt><br />
598 do <b>not</b> give any other user rights on this database.
599 </li>
600 <li>
601 enter the database name in <tt>$cfg['Servers'][$i]['pmadb']</tt>
602 </li>
603 </ul><br />
604 </dd>
606 <dt>
607 <a name="bookmark"></a><br />
608 <b>$cfg['Servers'][$i]['bookmarktable']</b> string
609 </dt>
610 <dd>
611 Since release 2.2.0 phpMyAdmin allows to bookmark queries. This can be
612 useful for queries you often run.<br /><br />
614 To allow the usage of this functionality you have to:
615 <ul>
616 <li>set up &quot;pmadb&quot; as described above</li>
617 <li>within this database create a table following this scheme:
618 <br />
619 <tt>
620 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE `PMA_bookmark` (<br />
621 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id int(11) DEFAULT '0' NOT NULL auto_increment,<br />
622 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;dbase varchar(255) NOT NULL,<br />
623 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;user varchar(255) NOT NULL,<br />
624 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;label varchar(255) NOT NULL,<br />
625 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;query text NOT NULL,<br />
626 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (id)<br />
627 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM COMMENT='Bookmarks';<br />
628 </tt>
629 </li>
630 <li>enter the table name in
631 <tt>$cfg['Servers'][$i]['bookmarktable']</tt></li>
632 </ul><br />
633 </dd>
635 <dt>
636 <a name="relation"></a><br />
637 <b>$cfg['Servers'][$i]['relation']</b> string
638 </dt>
639 <dd>
640 Since release 2.2.4 you can describe, in a special 'relation' table,
641 which field is a key in another table (a foreign key). phpMyAdmin
642 currently uses this to
643 <ul>
644 <li>
645 make clickable, when you browse the master table, the data values
646 that point to the foreign table;
647 </li>
648 <li>
649 display in an optional tool-tip the &quot;display field&quot;
650 when browsing the master table, if you move the mouse to a column
651 containing a foreign key (use also the 'table_info' table);<br />
652 (see FAQ 6.7)
653 </li>
654 <li>
655 in edit/insert mode, display a drop-down list of possible
656 foreign keys (key value and &quot;display field&quot; are
657 shown)<br />
658 (see FAQ 6.21)
659 <li>
660 display links on the table properties page, to check referential
661 integrity (display missing foreign keys) for each described key;
662 </li>
663 <li>
664 in query-by-example, create automatic joins (see FAQ 6.6)
665 </li>
666 <li>
667 enable you to get a PDF schema of your database (also uses the
668 table_coords table).
669 </li>
670 </ul>
671 <br />
673 The keys can be numeric or character.
674 <br /><br />
676 To allow the usage of this functionality the superuser has to:
677 <ul>
678 <li>set up &quot;pmadb&quot; as described above</li>
679 <li>
680 within this database create a table following this scheme:
681 <br />
682 <tt>
683 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE `PMA_relation` (<br />
684 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`master_db` varchar(64) NOT NULL default '',<br />
685 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`master_table` varchar(64) NOT NULL default '',<br />
686 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`master_field` varchar(64) NOT NULL default '',<br />
687 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`foreign_db` varchar(64) NOT NULL default '',<br />
688 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`foreign_table` varchar(64) NOT NULL default '',<br />
689 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`foreign_field` varchar(64) NOT NULL default '',<br />
690 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (`master_db`, `master_table`, `master_field`),<br />
691 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;KEY foreign_field (foreign_db, foreign_table)<br />
692 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM COMMENT='Relation table';<br />
693 </tt>
694 </li>
695 <li>
696 put the relation table name in
697 <tt>$cfg['Servers'][$i]['relation']</tt>
698 </li>
699 <li>
700 now as normal user open phpMyAdmin and for each one of your
701 tables where you want to use this feature, click
702 &quot;Structure/Relation view/&quot; and choose foreign fields.
703 </li>
704 </ul><br />
705 Please note that in the current (2.3.0) version, <tt>master_db</tt>
706 must be the same as <tt>foreign_db</tt>. Those fields have been put in
707 future development of the cross-db relations.<br /><br />
708 </dd>
710 <dt>
711 <a name="table_info"></a><br />
712 <b>$cfg['Servers'][$i]['table_info']</b> string
713 </dt>
714 <dd>
715 Since release 2.3.0 you can describe, in a special 'table_info'
716 table, which field is to be displayed as a tool-tip when moving the
717 cursor over the corresponding key.
718 <br />
719 This configuration variable will hold the name of this special
720 table.
721 To allow the usage of this functionality the superuser has to:
722 <ul>
723 <li>set up &quot;pmadb&quot; as described above</li>
724 <li>within this database create a table following this scheme:
725 <br />
726 <tt>
727 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE `PMA_table_info` (<br />
728 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`db_name` varchar(64) NOT NULL default '',<br />
729 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`table_name` varchar(64) NOT NULL default '',<br />
730 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`display_field` varchar(64) NOT NULL default '',<br />
731 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (`db_name`, `table_name`)<br />
732 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM COMMENT='Table information for phpMyAdmin';<br />
733 </tt>
734 </li>
735 <li>
736 put the table name in
737 <tt>$cfg['Servers'][$i]['table_info']</tt>
738 </li>
739 <li>
740 then for each table where you want to use this feature,
741 click &quot;Structure/Relation view/Choose field to display&quot;
742 to choose the field.
743 </li>
744 </ul><br />
745 Usage tip: <a href="#faqdisplay">Display field</a>.
746 <br /><br />
747 </dd>
749 <dt>
750 <a name="table_coords"></a><br />
751 <b>$cfg['Servers'][$i]['table_coords']</b> string<br />
752 <b>$cfg['Servers'][$i]['pdf_pages']</b> string
753 </dt>
754 <dd>
755 Since release 2.3.0 you can have phpMyAdmin create PDF pages showing
756 the relations between your tables. To do this it needs two tables
757 &quot;pdf_pages&quot; (storing information about the available PDF
758 pages) and &quot;table_coords&quot; (storing coordinates where each
759 table will be placed on a PDF schema output).
760 <br /><br />
761 You must be using the &quot;relation&quot; feature and have a table of
762 PDF pages (see <tt>$cfg['Servers'][$i]['pdf_pages']</tt>) to create PDF
763 output.
764 <br /><br />
765 To allow the usage of this functionality the superuser has to:
766 <ul>
767 <li>set up &quot;pmadb&quot; as described above</li>
768 <li>
769 within this database create a table following this scheme:
770 <br />
771 <tt>
772 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE `PMA_table_coords` (<br />
773 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`db_name` varchar(64) NOT NULL default '',<br />
774 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`table_name` varchar(64) NOT NULL default '',<br />
775 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`pdf_page_number` int NOT NULL default '0',<br />
776 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`x` float unsigned NOT NULL default '0',<br />
777 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`y` float unsigned NOT NULL default '0',<br />
778 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (`db_name`, `table_name`, `pdf_page_number`)<br />
779 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM COMMENT='Table coordinates for phpMyAdmin PDF output';<br />
780 </tt>
781 </li>
782 <li>
783 also within this database create:<br />
784 <tt>
785 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE `PMA_pdf_pages` (<br />
786 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`db_name` varchar(64) NOT NULL default '',<br />
787 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`page_nr` int(10) unsigned NOT NULL auto_increment,<br />
788 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`page_descr` varchar(50) NOT NULL default '',<br />
789 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (page_nr),<br />
790 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;KEY (db_name)<br />
791 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM COMMENT='PDF Relationpages for PMA';<br />
792 </tt>
793 </li>
794 <li>
795 put the first table name in
796 <tt>$cfg['Servers'][$i]['table_coords']</tt>
797 and the second table name in
798 <tt>$cfg['Servers'][$i]['pdf_pages']</tt>
799 </li>
800 </ul><br />
801 Usage tips: <a href="#faqpdf">PDF output</a>.
802 <br /><br />
803 </dd>
805 <dt>
806 <a name="col_com"></a><br />
807 <b>$cfg['Servers'][$i]['column_info']</b> string
808 </dt>
809 <dd>
810 <!-- This part requires a content update! -->
811 Since release 2.3.0 you can store comments to describe each column
812 for each table. These will then be shown on the &quot;printview&quot;.
813 <br /><br />
814 Starting with release 2.5.0, comments are consequently used on the table property
815 pages and table browse view, showing up as tool-tips above the column name (properties page)
816 or embedded within the header of table in browse view. They can also be shown
817 in a table dump. Please see the relevant configuration directives later on.
818 <br /><br />
819 Also new in release 2.5.0 is a mime-transformation system which is also based on
820 the following table structure. See <a href="#transformations">Transformations</a>
821 for further information. To use the mime-transformation system, your column_info
822 table has to have the three new fields 'mimetype', 'transformation', 'transformation_options'.
823 <br /><br />
824 To allow the usage of this functionality the superuser has to:
825 <ul>
826 <li>set up &quot;pmadb&quot; as described above</li>
827 <li>
828 within this database create a table following this scheme:
829 <br />
830 <tt>
831 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE `PMA_column_info` (<br />
832 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id int(5) unsigned NOT NULL auto_increment,<br />
833 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;db_name varchar(64) NOT NULL default '',<br />
834 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;table_name varchar(64) NOT NULL default '',<br />
835 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;column_name varchar(64) NOT NULL default '',<br />
836 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`comment` varchar(255) NOT NULL default '',<br />
837 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;mimetype varchar(255) NOT NULL default '',<br />
838 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;transformation varchar(255) NOT NULL default '',<br />
839 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;transformation_options varchar(255) NOT NULL default '',<br />
840 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (id),<br />
841 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;UNIQUE KEY db_name (db_name, table_name, column_name)<br />
842 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM COMMENT='Comments for Columns';<br />
843 </tt>
844 </li>
845 <li>
846 put the table name in
847 <tt>$cfg['Servers'][$i]['column_info']</tt>
848 </li>
849 <li>
850 To update your PRE-2.5.0 Column_comments Table use this:<br />
851 <tt>
852 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ALTER TABLE `PMA_column_comments` <br />
853 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ADD `mimetype` VARCHAR( 255 ) NOT NULL ,<br />
854 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ADD `transformation` VARCHAR( 255 ) NOT NULL ,<br />
855 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ADD `transformation_options` VARCHAR( 255 ) NOT NULL ;<br />
856 </tt>
857 and remember that the Variable in config.inc.php has been renamed
858 from <br />$cfg['Servers'][$i]['column_comments'] to $cfg['Servers'][$i]['column_info']
859 </li>
860 </ul><br />
861 </dd>
863 <dt>
864 <a name="history"></a><br />
865 <b>$cfg['Servers'][$i]['history']</b> string
866 </dt>
867 <dd>
868 Since release 2.5.0 you can store your SQL history, which means all queries you
869 entered manually into the phpMyAdmin interface. If you don't want to use a table-
870 based history, you can use the JavaScript-based history. Using that, all your
871 history items are deleted when closing the window.<br /><br />
873 Using <b>$cfg['QueryHistoryMax']</b> you can specify an amount of history items
874 you want to have on hold. On every login, this list gets cut to the maximum amount.
875 <br /><br />
877 The query history is only available if you use the JavaScript-based query window,
878 see <b>$cfg['QueryFrame']</b>.
879 <br /><br />
881 To allow the usage of this functionality the superuser has to:
882 <ul>
883 <li>set up &quot;pmadb&quot; as described above</li>
884 <li>
885 within this database create a table following this scheme:
886 <br />
887 <tt>
888 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE `PMA_history` (<br />
889 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,<br />
890 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`username` VARCHAR( 64 ) NOT NULL ,<br />
891 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`db` VARCHAR( 64 ) NOT NULL ,<br />
892 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`table` VARCHAR( 64 ) NOT NULL ,<br />
893 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`timevalue` TIMESTAMP NOT NULL ,<br />
894 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`sqlquery` TEXT NOT NULL ,<br />
895 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY ( `id` ) ,<br />
896 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INDEX ( `username` , `db` , `table` , `timevalue` )<br />
897 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM COMMENT='SQL history';<br />
898 </tt>
899 </li>
900 <li>
901 put the table name in
902 <tt>$cfg['Servers'][$i]['history']</tt>
903 </li>
904 </ul><br />
905 </dd>
907 <dt>
908 <a name="history"></a><br />
909 <b>$cfg['Servers'][$i]['verbose_check']</b> string
910 </dt>
911 <dd>
912 Because release 2.5.0 introduced the new MIME-transformation support, the
913 column_info table got enhanced with three new fields. If the above variable is
914 set to TRUE (default) phpMyAdmin will check if you have the latest table structure
915 available. If not, it will emit a warning to the superuser.<br /><br />
917 You can disable this checking behavior by setting the variable to false, which
918 should offer a performance increase.<br /><br />
920 Recommended to set to FALSE, when you are sure, your table structure is up to date.
921 <br /><br />
922 </dd>
924 <dt>
925 <b>$cfg['Servers'][$i]['AllowDeny']['order']</b> string
926 </dt>
927 <dd>
928 If your rule order is empty, then IP authentication is disabled.
929 <br /><br />
930 If your rule order is set to <tt>'deny,allow'</tt> then the system
931 applies all deny rules followed by allow rules.
932 Access is allowed by default. Any client which does not match a Deny
933 command or does match an Allow command will be allowed access to the
934 server.
935 <br /><br />
936 If your rule order is set to <tt>'allow,deny'</tt> then the system
937 applies all allow rules followed by deny rules. Access is denied by
938 default. Any client which does not match an Allow directive or does
939 match a Deny directive will be denied access to the server.
940 <br /><br />
941 If your rule order is set to 'explicit', the authentication is
942 performed in a similar fashion to rule order 'deny,allow', with the
943 added restriction that your host/username combination <b>must</b> be
944 listed in the <i>allow</i> rules, and not listed in the <i>deny</i>
945 rules. This is the <b>most</b> secure means of using Allow/Deny rules,
946 and was available in Apache by specifying allow and deny rules without
947 setting any order.
948 <br /><br />
949 </dd>
951 <dt>
952 <b>$cfg['Servers'][$i]['AllowDeny']['rules']</b> array of strings
953 </dt>
954 <dd>
955 The general format for the rules is as such:<br />
956 <tt>
957 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
958 &lt;'allow' | 'deny'&gt; &lt;username&gt; [from] &lt;ipmask&gt;
959 </tt>
960 <br /><br />
962 If you wish to match all users, it is possible to use a <tt>'%'</tt> as
963 a wildcard in the <i>username</i> field.<br />
964 There are a few shortcuts you can use in the <i>ipmask</i> field as
965 well:<br />
966 <tt>
967 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'all' -&gt; 0.0.0.0/0<br />
968 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'localhost' -&gt; 127.0.0.1/8
969 </tt>
970 <br /><br />
972 Having an empty rule list is equivalent to either using
973 <tt>'allow % from all'</tt> if your rule order is set to
974 <tt>'deny,allow'</tt> or <tt>'deny % from all'</tt> if your rule order
975 is set to <tt>'allow,deny'</tt> or <tt>'explicit'</tt>.
976 <br /><br />
978 For the IP matching system, the following work:<br />
979 <tt>xxx.xxx.xxx.xxx</tt> (an exact IP address)<br />
980 <tt>xxx.xxx.xxx.[yyy-zzz]</tt> (an IP address range)<br />
981 <tt>xxx.xxx.xxx.xxx/nn</tt> (CIDR, Classless Inter-Domain Routing type IP addresses)<br />
982 But the following does not work:<br />
983 <tt>xxx.xxx.xxx.xx[yyy-zzz]</tt> (partial IP address range)
984 <br /><br />
985 </dd>
987 <dt><b>$cfg['ServerDefault']</b> integer</dt>
988 <dd>
989 If you have more than one server configured, you can set
990 <tt>$cfg['ServerDefault']</tt> to any one of them to autoconnect to
991 that server when phpMyAdmin is started, or set it to 0 to be given a
992 list of servers without logging in.<br />
993 If you have only one server configured, <tt>$cfg['ServerDefault']</tt>
994 MUST be set to that server.
995 <br /><br />
996 </dd>
998 <dt><b>$cfg['OBGzip'] </b>string/boolean</dt>
999 <dd>
1000 Defines whether to use GZip output buffering for increased
1001 speed in HTTP transfers.<br />
1002 Set to true/false for enabling/disabling. When set to 'auto' (string),
1003 phpMyAdmin tries to enable output buffering and will automatically disable
1004 it, if your browser has some problems with buffering. IE6 with a certain patch
1005 is known to cause data corruption having enabled buffering.
1006 <br /><br />
1007 </dd>
1009 <dt><b>$cfg['PersistentConnections'] </b>boolean</dt>
1010 <dd>
1011 Whether persistent connections should be used or not (mysql_connect or
1012 mysql_pconnect).
1013 <br /><br />
1014 </dd>
1016 <dt><b>$cfg['ExecTimeLimit'] </b>integer [number of seconds]</dt>
1017 <dd>
1018 Set the number of seconds a script is allowed to run. If seconds is set
1019 to zero, no time limit is imposed.<br />
1020 This setting is used while importing/exporting dump files but has no
1021 effect when PHP is running in safe mode.
1022 <br /><br />
1023 </dd>
1025 <dt><b>$cfg['SkipLockedTables'] </b>boolean</dt>
1026 <dd>
1027 Mark used tables and make it possible to show databases with locked
1028 tables (since 3.23.30).
1029 <br /><br />
1030 </dd>
1032 <dt><b>$cfg['ShowSQL'] </b>boolean</dt>
1033 <dd>
1034 Defines whether SQL-queries generated by phpMyAdmin should be displayed
1035 or not.
1036 <br /><br />
1037 </dd>
1039 <dt><b>$cfg['AllowUserDropDatabase'] </b>boolean</dt>
1040 <dd>
1041 Defines whether normal users (non-administrator) are allowed to
1042 delete their own database or not. If set as FALSE, the link &quot;Drop
1043 Database&quot; will not be shown, and even a &quot;DROP DATABASE
1044 mydatabase&quot; will be rejected. Quite practical for ISP's with many
1045 customers.
1046 <br /><br />
1047 </dd>
1049 <dt><b>$cfg['Confirm'] </b>boolean</dt>
1050 <dd>
1051 Whether a warning (&quot;Are your really sure..&quot;) should be
1052 displayed when you're about to loose data.
1053 <br /><br />
1054 </dd>
1056 <dt><b>$cfg['LoginCookieRecall'] </b>boolean</dt>
1057 <dd>
1058 Define whether the previous login should be recalled or not in cookie
1059 authentication mode.
1060 <br /><br />
1061 </dd>
1063 <dt><b>$cfg['UseDbSearch'] </b>boolean</dt>
1064 <dd>
1065 Define whether the "search string inside database" is enabled or not.
1066 <br /><br />
1067 </dd>
1069 <dt><b>$cfg['LeftFrameLight']</b> boolean</dt>
1070 <dd>
1071 Defines whether to use select-based menu and display only the current
1072 tables in the left frame (smaller page).
1073 Only in Non-Lightmode you can use the feature to display nested folders
1074 using $cfg['LeftFrameTableSeparator']
1075 <br /><br />
1076 </dd>
1078 <dt><b>$cfg['LeftFrameTableSeparator']</b> string</dt>
1079 <dd>
1080 Defines a string to be used to nest table spaces. Defaults to '__'. This
1081 means if you have tables like 'first__second__third' this will be
1082 shown as a three-level hierarchie like: first &gt; second &gt; third.
1083 If set to FALSE or empty, the feature is disabled.
1084 NOTE: You shall not use this Separator in a table name at the beginning or
1085 end of a table name, or multiple times after another without any other
1086 characters in between.
1087 <br /><br />
1088 </dd>
1090 <dt><b>$cfg['LeftFrameTableLevel']</b> string</dt>
1091 <dd>
1092 Defines how many sublevels should be displayed when splitting
1093 up tables by the above Separator.
1094 <br /><br />
1095 </dd>
1097 <dt><b>$cfg['ShowTooltip'] </b>boolean</dt>
1098 <dd>
1099 Defines whether to display table comment as tool-tip in left frame or
1100 not.
1101 <br /><br />
1102 </dd>
1104 <dt><b>$cfg['ShowTooltipAliasDB'] </b>boolean</dt>
1105 <dd>
1106 If tool-tips are enabled and a DB comment is set, this will flip the comment
1107 and the real name. That means, if you have a table called 'user0001' and add
1108 the comment 'MyName' on it, you will see the name 'MyName' used consequently
1109 in the left frame and the tool-tip shows the real name of the DB.
1110 <br /><br />
1111 </dd>
1113 <dt><b>$cfg['ShowTooltipAliasTB'] </b>boolean</dt>
1114 <dd>
1115 Same as $cfg['ShowTooltipAliasDB'], except this works for table names.
1116 <br /><br />
1117 </dd>
1119 <dt><b>$cfg['ShowStats'] </b>boolean</dt>
1120 <dd>
1121 Defines whether to display space usage and statistics about databases
1122 and tables or not.<br />
1123 Note that statistics requires at least MySQL 3.23.3 and that, at this
1124 date, MySQL doesn't return such information for Berkeley DB tables.
1125 <br /><br />
1126 </dd>
1128 <dt>
1129 <b>$cfg['ShowMysqlInfo'] </b>boolean<br />
1130 <b>$cfg['ShowMysqlVars'] </b>boolean<br />
1131 <b>$cfg['ShowPhpInfo'] </b>boolean<br />
1132 <b>$cfg['ShowChgPassword'] </b>boolean
1133 </dt>
1134 <dd>
1135 Defines whether to display the &quot;MySQL runtime information&quot;,
1136 &quot;MySQL system variables&quot;, &quot;PHP information&quot; and
1137 &quot;Change password &quot; links or not for simple users at the
1138 starting main (right) frame. This setting does not check MySQL commands
1139 entered directly.
1140 <br /><br />
1142 Please note that to block the usage of phpinfo() in scripts, you
1143 have to put this in your php.ini:<br />
1144 &nbsp;&nbsp;&nbsp;&nbsp;<tt>disable_functions = phpinfo()</tt>
1145 <br /><br />
1147 Also note that enabling the &quot;Change password &quot; link has no
1148 effect with &quot;config&quot; authentication mode: because of the hard
1149 coded password value in the configuration file, end users can't be
1150 allowed to change their passwords.
1151 <br /><br />
1152 </dd>
1154 <dt><b>$cfg['SuggestDBName']</b> boolean</dt>
1155 <dd>
1156 Defines whether to suggest a database name on the
1157 &quot;Create Database&quot; form or to keep the textfield empty.
1158 <br /><br />
1159 </dd>
1161 <dt><b>$cfg['ShowBlob'] </b>boolean</dt>
1162 <dd>
1163 Defines whether <tt>BLOB</tt> fields are shown when browsing a table's
1164 content or not.
1165 <br /><br />
1166 </dd>
1168 <dt><b>$cfg['NavigationBarIconic'] </b>boolean</dt>
1169 <dd>
1170 Defines whether navigation bar buttons contain text or symbols only.
1171 <br /><br />
1172 </dd>
1174 <dt><b>$cfg['ShowAll'] </b>boolean</dt>
1175 <dd>
1176 Defines whether an user should be displayed a
1177 &quot;show all (records)&quot; button in browse mode or not.
1178 <br /><br />
1179 </dd>
1181 <dt><b>$cfg['MaxRows'] </b>integer</dt>
1182 <dd>
1183 Number of rows displayed when browsing a result set. If the result set
1184 contains more rows, Previous/Next links will be shown.
1185 <br /><br />
1186 </dd>
1188 <dt><b>$cfg['Order'] </b>string [<tt>DESC</tt>|<tt>ASC</tt>|<tt>SMART</tt>]</dt>
1189 <dd>
1190 Defines whether fields are displayed in ascending (<tt>ASC</tt>) order,
1191 in descending (<tt>DESC</tt>) order or in a &quot;smart&quot;
1192 (<tt>SMART</tt>) order - I.E. descending order for fields of type TIME,
1193 DATE, DATETIME &amp; TIMESTAMP, ascending order else- by default.
1194 <br /><br />
1195 </dd>
1197 <dt><b>$cfg['ProtectBinary'] </b>boolean or string</dt>
1198 <dd>
1199 Defines whether <tt>BLOB</tt> or <tt>BINARY</tt> fields are protected
1200 from edition when browsing a table's content or not.
1201 Valid values are:<br />
1202 - <tt>FALSE</tt> to allow edition of all fields;<br />
1203 - <tt>blob</tt> to allow edition of all fields except <tt>BLOBS</tt>;
1204 <br />
1205 - <tt>all</tt> to disallow edition of all <tt>BINARY</tt> or
1206 <tt>BLOB</tt> fields.
1207 <br /><br />
1208 </dd>
1210 <dt><b>$cfg['ShowFunctionFields'] </b>boolean</dt>
1211 <dd>
1212 Defines whether MySQL functions fields should be displayed or not in
1213 edit/insert mode.
1214 <br /><br />
1215 </dd>
1217 <dt><b>$cfg['CharEditing'] </b>string</dt>
1218 <dd>
1219 Defines which type of editing controls should be used for CHAR and
1220 VARCHAR fields. Possible values are:
1221 <ul>
1222 <li>
1223 input - this allows to limit size of text to size of field in
1224 MySQL, but has problems with newlines in fields
1225 </li>
1226 <li>
1227 textarea - no problems with newlines in fields, but also no
1228 length limitations
1229 </li>
1230 </ul>
1231 Default is old behavior so input.
1232 <br /><br />
1233 </dd>
1235 <dt>
1236 <b>$cfg['ZipDump'] </b>boolean<br />
1237 <b>$cfg['GZipDump'] </b>boolean<br />
1238 <b>$cfg['BZipDump'] </b>boolean
1239 </dt>
1240 <dd>
1241 Defines whether to allow the use of zip/GZip/BZip2 compression when
1242 creating a dump file or not.
1243 <br /><br />
1244 </dd>
1246 <dt><b>$cfg['LightTabs'] </b>string</dt>
1247 <dd>
1248 If set to True, do use less graphically intense tabs on the top of the mainframe.
1249 <br /><br />
1250 </dd>
1252 <dt><b>$cfg['PropertiesIconic'] </b>string</dt>
1253 <dd>
1254 If set to True, will display icons instead of text for db and table properties links (like 'Browse', 'Select', 'Insert', ...).<br />
1255 Can be set to 'both' if you want icons AND text.<br />
1256 When set to False, will only show text.
1257 <br /><br />
1258 </dd>
1260 <dt><b>$cfg['PropertiesNumColumns'] </b>integer</dt>
1261 <dd>
1262 How many columns will be utilized to display the tables on the database property view?
1263 Default is 1 column. When setting this to a value larger than 1, the type of the database will be
1264 omitted for more display space.
1265 <br /><br />
1266 </dd>
1269 <dt><b>$cfg['DefaultTabServer'] </b>string</dt>
1270 <dd>
1271 Defines the tab displayed by default on server view. Possible
1272 values: &quot;main.php3&quot; (recommended for multi-user setups),
1273 &quot;server_databases.php3&quot;, &quot;server_status.php3&quot;,
1274 &quot;server_variables.php3&quot;, &quot;server_privileges.php3&quot; or
1275 &quot;server_processlist.php3&quot;.
1276 <br /><br />
1277 </dd>
1279 <dt><b>$cfg['DefaultTabDatabase'] </b>string</dt>
1280 <dd>
1281 Defines the tab displayed by default on database view. Possible
1282 values: &quot;db_details_structure.php3&quot;,
1283 &quot;db_details.php3&quot; or &quot;db_search.php3&quot;.
1284 <br /><br />
1285 </dd>
1287 <dt><b>$cfg['DefaultTabTable'] </b>string</dt>
1288 <dd>
1289 Defines the tab displayed by default on table view. Possible
1290 values: &quot;tbl_properties_structure.php3&quot;,
1291 &quot;tbl_properties.php3&quot;, &quot;tbl_select.php3&quot; or
1292 &quot;tbl_change.php3&quot;.
1293 <br /><br />
1294 </dd>
1296 <dt><b>$cfg['MySQLManualBase']</b> string</dt>
1297 <dd>
1298 If set to an URL which points to the MySQL documentation (type depends
1299 on <tt>$cfg['MySQLManualType']</tt>), appropriate help links are
1300 generated.
1301 <br />
1302 See <a href="http://www.mysql.com/documentation/index.html">MySQL
1303 Documentation page</a> for more information about MySQL manuals and
1304 their types.
1305 <br /><br />
1306 </dd>
1308 <dt><b>$cfg['MySQLManualType']</b> string</dt>
1309 <dd>
1310 Type of MySQL documentation:
1311 <ul>
1312 <li>old - old style used in phpMyAdmin 2.3.0 and sooner</li>
1313 <li>searchable - &quot;Searchable, with user comments&quot;</li>
1314 <li>chapters - &quot;HTML, one page per chapter&quot;</li>
1315 <li>big - &quot;HTML, all on one page&quot;</li>
1316 <li>none - do not show documentation links</li>
1317 </ul>
1318 <br /><br />
1319 </dd>
1321 <dt><b>$cfg['DefaultLang'] </b>string</dt>
1322 <dd>
1323 Defines the default language to use, if not browser-defined or
1324 user-defined.<br />
1325 See the <i>select_lang.inc.php3</i> script to know the valid values for
1326 this setting.
1327 <br /><br />
1328 </dd>
1330 <dt><b>$cfg['Lang'] </b>string</dt>
1331 <dd>
1332 Force: always use this language (must be defined in the
1333 <i>select_lang.inc.php3</i> script).
1334 <br /><br />
1335 </dd>
1337 <dt><b>$cfg['DefaultCharset'] </b>string</dt>
1338 <dd>
1339 Default character set to use for recoding of MySQL queries. This must be
1340 enabled and it's described by <tt>$cfg['AllowAnywhereRecoding']</tt>
1341 option.<br />
1342 You can give here any character set which is in
1343 <tt>$cfg['AvailableCharsets']</tt> array and this is just default
1344 choice, user can select any of them.
1345 <br /><br />
1346 </dd>
1348 <dt><b>$cfg['AllowAnywhereRecoding'] </b>boolean</dt>
1349 <dd>
1350 Allow character set recoding of MySQL queries. You need recode or iconv
1351 support (compiled in or module) in PHP to allow MySQL queries recoding
1352 and used language file must have it enabled (by default only these
1353 which are in Unicode, just to avoid losing some characters).
1354 <br /><br />
1355 </dd>
1357 <dt><b>$cfg['RecodingEngine'] </b>string</dt>
1358 <dd>
1359 You can select here which functions will be used for character set
1360 conversion.
1361 Possible values are:<br />
1362 <ul>
1363 <li>auto - automatically use available one (first is tested
1364 iconv, then recode)</li>
1365 <li>iconv - use iconv or libiconv functions</li>
1366 <li>recode - use recode_string function</li>
1367 </ul>
1368 Default is auto.
1369 <br /><br />
1370 </dd>
1372 <dt><b>$cfg['IconvExtraParams'] </b>string</dt>
1373 <dd>
1374 Specify some parameters for iconv used in charset conversion. See
1376 href="http://www.gnu.org/software/libiconv/documentation/libiconv/iconv_open.3.html">iconv
1377 documentation</a> for details.
1378 <br /><br />
1379 </dd>
1381 <dt><b>$cfg['AvailableCharsets'] </b>array</dt>
1382 <dd>
1383 Available character sets for MySQL conversion. You can add your own (any of
1384 supported by recode/iconv) or remove these which you don't use.
1385 Character sets will be shown in same order as here listed, so if you
1386 frequently use some of these move them to the top.
1387 <br /><br />
1388 </dd>
1390 <dt><b>$cfg['GD2Available'] </b>string</dt>
1391 <dd>
1392 Specifies whether GD &gt;= 2 is available. If yes it can be used for
1393 MIME transformations.<br />
1394 Possible values are:<br />
1395 <ul>
1396 <li>
1397 auto - automatically detect, this is a bit expensive
1398 operation for php &lt; 4.3.0 so it is preffered to change this
1399 according to your server real possibilities
1400 </li>
1401 <li>yes - GD 2 functions can be used</li>
1402 <li>no - GD 2 function can not be used</li>
1403 </ul>
1404 Default is auto.
1405 <br /><br />
1406 </dd>
1408 <dt><b>$cfg['LeftWidth'] </b>integer</dt>
1409 <dd>
1410 Left frame width in pixel.
1411 <br /><br />
1412 </dd>
1414 <dt>
1415 <b>$cfg['LeftBgColor'] </b>string [HTML color]<br />
1416 <b>$cfg['RightBgColor'] </b>string [HTML color]
1417 </dt>
1418 <dd>
1419 The background colors (HTML) used for both the frames.
1420 <br /><br />
1421 </dd>
1423 <dt>
1424 <b>$cfg['RightBgImage'] </b>string
1425 </dt>
1426 <dd>
1427 The URI of the background image used for the right frame. It can be
1428 absolute as well as relative from your phpMyAdmin directory.
1429 </dd>
1431 <dt><b>$cfg['LeftPointerColor'] </b>string [HTML color]</dt>
1432 <dd>
1433 The color (HTML) used for the pointer in the left frame (does not work
1434 with Netscape 4).
1435 <br /><br />
1436 </dd>
1438 <dt><b>$cfg['Border'] </b>integer</dt>
1439 <dd>
1440 The size of a table's border.
1441 <br /><br />
1442 </dd>
1444 <dt><b>$cfg['ThBgcolor'] </b>string [HTML color]</dt>
1445 <dd>
1446 The color (HTML) used for table headers.
1447 <br /><br />
1448 </dd>
1450 <dt><b>$cfg['BgcolorOne'] </b>string [HTML color]</dt>
1451 <dd>
1452 The color (HTML) #1 for table rows.
1453 <br /><br />
1454 </dd>
1456 <dt><b>$cfg['BgcolorTwo'] </b>string [HTML color]</dt>
1457 <dd>
1458 The color (HTML) #2 for table rows.
1459 <br /><br />
1460 </dd>
1462 <dt>
1463 <b>$cfg['BrowsePointerColor'] </b>string [HTML color]<br />
1464 <b>$cfg['BrowseMarkerColor'] </b>string [HTML color]
1465 </dt>
1466 <dd>
1467 The colors (HTML) uses for the pointer and the marker in browse mode
1468 (does not work with Netscape 4).<br />
1469 The former feature highlights the row over which your mouse is passing
1470 and the latter lets you visually mark/unmark rows by clicking on
1471 them.<br />
1472 You can disable both of these features by emptying the respective
1473 directive.
1474 <br /><br />
1475 </dd>
1477 <dt>
1478 <b>$cfg['TextareaCols'] </b>integer<br />
1479 <b>$cfg['TextareaRows'] </b>integer<br />
1480 <b>$cfg['CharTextareaCols'] </b>integer<br />
1481 <b>$cfg['CharTextareaRows'] </b>integer
1482 </dt>
1483 <dd>
1484 Number of columns and rows for the textareas.<br />
1485 This value will be emphasized (*2) for SQL query textareas and (*1.25) for
1486 SQL textareas inside the query window.<br />
1487 The Char* values are used for CHAR and VARCHAR editing (if configured
1488 via $cfg['CharEditing']).
1489 <br /><br />
1490 </dd>
1492 <dt>
1493 <b>$cfg['LongtextDoubleTextarea'] </b>boolean<br />
1494 </dt>
1495 <dd>
1496 Defines whether textarea for LONGTEXT fields should have double size.
1497 <br /><br />
1498 </dd>
1500 <dt>
1501 <b>$cfg['TextareaAutoSelect'] </b>boolean<br />
1502 </dt>
1503 <dd>
1504 Defines if the whole textarea of the query box will be selected on
1505 click.
1506 <br /><br />
1507 </dd>
1509 <dt>
1510 <b>$cfg['CtrlArrowsMoving'] </b>boolean<br />
1511 </dt>
1512 <dd>
1513 Enable Ctrl+Arrows moving between fields when editing?
1514 <br /><br />
1515 </dd>
1517 <dt><b>$cfg['LimitChars'] </b>integer</dt>
1518 <dd>
1519 Maximal number of Chars showed in any non-numeric
1520 field on browse view. Can be turned off by a toggle button on the
1521 browse page.
1522 <br /><br />
1523 </dd>
1525 <dt>
1526 <b>$cfg['ModifyDeleteAtLeft'] </b>boolean<br />
1527 <b>$cfg['ModifyDeleteAtRight'] </b>boolean
1528 </dt>
1529 <dd>
1530 Defines the place where modify and delete links would be put when
1531 tables contents are displayed (you may have them displayed both at the
1532 left and at the right).
1533 &quot;Left&quot; and &quot;right&quot; are parsed as &quot;top&quot;
1534 and &quot;bottom&quot; with vertical display mode.
1535 <br /><br />
1536 </dd>
1538 <dt><b>$cfg['DefaultDisplay'] </b>string<br />
1539 <b>$cfg['HeaderFlipType'] </b>string
1540 </dt>
1541 <dd>
1542 There are 3 display modes: horizontal, horizontalflipped and vertical. Define
1543 which one is displayed by default. The first mode displays each row on a
1544 horizontal line, the second rotates the headers by 90 degrees, so you can use
1545 descriptive headers even though fields only contain small values and still
1546 print them out. The vertical mode sorts each row on a vertical lineup.<br /><br />
1547 The HeaderFlipType can be set to 'css' or 'faked'. When using 'css' the rotation
1548 of the header for horizontalflipped is done via CSS. If set to 'faked' PGP
1549 does the transformation for you, but of course this does not look as good as CSS.
1550 <br /><br />
1551 </dd>
1553 <dt><b>$cfg['DefaultPropDisplay'] </b>string</dt>
1554 <dd>
1555 When editing/creating new columns in a table all fields normally get lined up
1556 one field a line. (default: 'horizontal'). If you set this to 'vertical' you
1557 can have each field lined up vertically beneath each other. You can save up
1558 a lot of place on the horizontal direction and no longer have to scroll.
1559 <br /><br />
1560 </dd>
1562 <dt><b>$cfg['ShowBrowseComments'] </b>boolean<br />
1563 <b>$cfg['ShowPropertyComments'] </b>boolean<br />
1564 </dt>
1565 <dd>
1566 By setting the corresponding variable to TRUE you can enable the display of
1567 column comments in Browse or Property display. In browse mode, the comments
1568 are show inside the header. In property mode, comments are displayed using
1569 a CSS-formatted dashed-line below the name of the field. The comment is shown
1570 as a tool-tip for that field.
1571 <br /><br />
1572 </dd>
1574 <dt><b>$cfg['UploadDir'] </b>string</dt>
1575 <dd>
1576 The name of the directory, ending with a slash, where SQL files have
1577 been uploaded by other means than phpMyAdmin (for example, ftp).
1578 Those files are available under a drop-down box when you click the
1579 database name, then the SQL tab.
1580 <br /><br />
1581 Please note that the file names must have the suffix &quot;.sql&quot;.
1582 <br /><br />
1583 This feature is useful when your file is too big to be uploaded via
1584 HTTP, or when file uploads are disabled in PHP.
1585 <br /><br />
1586 Please note that if PHP is running in safe mode, this directory must
1587 be owned by the same user as the owner of the phpMyAdmin scripts.
1588 <br /><br />
1589 </dd>
1591 <dt><b>$cfg['SaveDir'] </b>string</dt>
1592 <dd>
1593 The name of the directory, ending with a slash, where dumps can
1594 be saved.
1595 <br /><br />
1596 Please note that the directory has to be writable for user running
1597 webserver.
1598 <br /><br />
1599 Please note that if PHP is running in safe mode, this directory must
1600 be owned by the same user as the owner of the phpMyAdmin scripts.
1601 <br /><br />
1602 </dd>
1604 <dt><b>$cfg['Export'] </b>array</dt>
1605 <dd>
1606 In this array are defined default parameters for export, names of
1607 items are simmilar to texts seen on export page, so you can easily
1608 identify what they mean.
1609 <br /><br />
1610 </dd>
1612 <dt><b>$cfg['RepeatCells'] </b>integer</dt>
1613 <dd>
1614 Repeat the headers every X cells, or 0 to deactivate.
1615 <br /><br />
1616 </dd>
1618 <dt><b>$cfg['QueryFrame'] </b>boolean<br />
1619 <b>$cfg['QueryFrameJS'] </b>boolean<br />
1620 <b>$cfg['QueryFrameDebug'] </b>boolean<br />
1621 <b>$cfg['QueryWindowWidth'] </b>integer<br />
1622 <b>$cfg['QueryWindowHeight'] </b>integer<br />
1623 <b>$cfg['QueryHistoryDB'] </b>boolean<br />
1624 <b>$cfg['QueryWindowDefTab'] </b>string<br />
1625 <b>$cfg['QueryHistoryMax'] </b>integer
1626 </dt>
1627 <dd>
1628 All those variables affect the new query frame/window. When $cfg['QueryFrame']
1629 is set to true a new frame is embedded on the left with a small area. Clicking
1630 on that results in opening a direct interface to enter SQL queries.<br /><br />
1631 When $cfg['QueryFrameJS'] is set to true, clicking on that link opens a new
1632 custom sized browser window ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] -
1633 both integers for the size in pixels). If set to false, clicking on the link
1634 only opens the SQL input in the mainframe.<br /><br />
1635 The usage of the JavaScript query window is recommended if you have a JavaScript
1636 enabled browser. Basic functions are used to exchange quite a few variables, so
1637 most 4th generation browsers should be capable to use that feature. It currently
1638 is only tested with Internet Explorer 6 and Mozilla 1.x.<br /><br />
1639 If $cfg['QueryHistoryDB'] is set to TRUE, all your Queries are logged to a table,
1640 which has to be created by you (see <a href="history">$cfg['Servers'][$i]['history']</a>).
1641 If set to FALSE, all your queries will be appended to the form, but only as long
1642 as your window is opened they remain saved.<br /><br />
1643 When using the JavaScript based query window, it will always get updated when you
1644 click on a new table/db to browse and will focus if you click on "Edit SQL" after
1645 using a query. You can suppress updating the query window by checking the box
1646 "Do not overwrite this query from outside the window" below the query textarea. Then
1647 you can browse tables/databases in the background without losing the contents of the
1648 textarea, so this is especially useful when composing a query with tables you first
1649 have to look in. The checkbox will get automatically checked whenever you change the
1650 contents of the textarea. Please uncheck the button whenever you definitely want the
1651 query window to get updated even though you have made alterations.<br /><br />
1652 If $cfg['QueryHistoryDB'] is set to TRUE you can specify the amount of saved
1653 history items using $cfg['QueryHistoryMax'].<br /><br />
1654 The query window also has a custom tabbed look to group the features. Using the
1655 variable $cfg['QueryWindowDefTab'] you can specify the default tab to be used
1656 when opening the query window. It can be set to either 'sql', 'files', 'history'
1657 or 'full'.<br /><br />
1658 The variable $cfg['QueryFrameDebug'] can be used by developers for easier future
1659 feature integration.
1660 <br /><br />
1661 </dd>
1663 <dt><b>$cfg['BrowseMIME'] </b>boolean</dt>
1664 <dd>
1665 Enable <a href="#transformations">MIME-transformations</a>.
1666 <br /><br />
1667 </dd>
1669 <dt><b>$cfg['MaxExactCount'] </b>integer</dt>
1670 <dd>
1671 Determines for how large tables phpMyAdmin should get exact row count by
1672 <code>SELECT COUNT</code>. If approximate row count is smaller than this
1673 value, <code>SELECT COUNT</code> will be used, otherwise only value
1674 returned by <code>SHOW TABLE STATUS</code>.
1675 <br /><br />
1676 </dd>
1678 <dt><b>$cfg['WYSIWYG-PDF'] </b>boolean</dt>
1679 <dd>
1680 Utilizes a WYSIWYG editing control to easily place elements of a PDF page.
1681 By clicking on the button 'toggle scratchboard' on the page where you
1682 edit x/y coordinates of those elements you can activate a scratchboard where
1683 all your elements are placed. By clicking on an element, you can move them
1684 around in the pre-defined area and the x/y coordinates will get updated
1685 dynamically. Likewise, when entering a new position directly into the
1686 input field, the new position in the scratchboard changes after your
1687 cursors leaves the input field.<br />
1688 You have to click on the 'OK'-button below the tables to save the new positions.
1689 If you want to place a new element, first add it to the table of elements and
1690 then you can drag the new element around.<br />
1691 By changing the paper size and the orientation you can change the size of the
1692 scratchboard as well. You can do so by just changing the dropdown field below,
1693 and the scratchboard will resize automatically, without interfering with the
1694 current placement of the elements.<br />
1695 If ever an element gets out of range you can either enlarge the paper size
1696 or click on the 'reset' button to place all elements below each other.<br />
1697 <b>NOTE:</b> You have to use a recent browser like IE6 or Mozilla to get this control
1698 to work. The basic Drag&amp;Drop script functionality was kindly borrowed from www.youngpup.net and
1699 is underlying so specific license.
1700 <br /><br />
1701 </dd>
1703 <dt><b>$cfg['SQP']['fmtType']</b> string [<tt>html</tt>|<tt>none</tt>]</dt>
1704 <dd>
1705 The main use of the new SQL Parser is to pretty-print SQL queries. By
1706 default we use HTML to format the query, but you can disable this by
1707 setting this variable to <tt>'none'</tt>
1708 <br /><br />
1709 </dd>
1711 <dt><b>$cfg['SQP']['fmtInd']</b> float<br />
1712 <b>$cfg['SQP']['fmtIndUnit']</b> string [<tt>em</tt>|<tt>px</tt>|<tt>pt</tt>|<tt>ex</tt>]</dt>
1713 <dd>
1714 For the pretty-printing of SQL queries, under some cases the part of a
1715 query inside a bracket is indented. By changing
1716 <tt>$cfg['SQP']['fmtInd']</tt> you can change the amount of this indent.
1717 <br />Related in purpose is <tt>$cfg['SQP']['fmtIndUnit']</tt> which
1718 specifies the units of the indent amount that you specified. This is
1719 used via stylesheets.
1720 <br /><br />
1721 </dd>
1723 <dt><b>$cfg['SQP']['fmtColor']</b> array of string tuples</dt>
1724 <dd>
1725 This array is used to define the colours for each type of element of
1726 the pretty-printed SQL queries. The tuple format is<br />
1727 <i>class</i> =&gt; [<i>HTML colour code</i> | <i>empty string</i>]<br />
1728 If you specify an empty string for the color of a class, it is ignored
1729 in creating the stylesheet.
1730 You should not alter the class names, only the colour strings.<br />
1731 <b>Class name key:</b><br />
1732 <ul>
1733 <li><b>comment</b> Applies to all comment sub-classes</li>
1734 <li><b>comment_mysql</b> Comments as <tt>"#...\n"</tt></li>
1735 <li><b>comment_ansi</b> Comments as <tt>"-- ...\n"</tt></li>
1736 <li><b>comment_c</b> Comments as <tt>"/*...*/"</tt></li>
1737 <li><b>digit</b> Applies to all digit sub-classes</li>
1738 <li><b>digit_hex</b> Hexadecimal numbers</li>
1739 <li><b>digit_integer</b> Integer numbers</li>
1740 <li><b>digit_float</b> Floating point numbers</li>
1741 <li><b>punct</b> Applies to all punctuation sub-classes</li>
1742 <li><b>punct_bracket_open_round</b> Opening brackets<tt>"("</tt></li>
1743 <li><b>punct_bracket_close_round</b> Closing brackets <tt>")"</tt></li>
1744 <li><b>punct_listsep</b> List item Separator <tt>","</tt></li>
1745 <li><b>punct_qualifier</b> Table/Column Qualifier <tt>"."</tt> </li>
1746 <li><b>punct_queryend</b> End of query marker <tt>";"</tt></li>
1747 <li><b>alpha</b> Applies to all alphabetic classes</li>
1748 <li><b>alpha_columnType</b> Identifiers matching a column type</li>
1749 <li><b>alpha_columnAttrib</b> Identifiers matching a database/table/column attribute</li>
1750 <li><b>alpha_functionName</b> Identifiers matching a MySQL function name</li>
1751 <li><b>alpha_reservedWord</b> Identifiers matching any other reserved word</li>
1752 <li><b>alpha_variable</b> Identifiers matching a SQL variable <tt>"@foo"</tt></li>
1753 <li><b>alpha_identifier</b> All other identifiers</li>
1754 <li><b>quote</b> Applies to all quotation mark classes</li>
1755 <li><b>quote_double</b> Double quotes <tt>"</tt></li>
1756 <li><b>quote_single</b> Single quotes <tt>'</tt></li>
1757 <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
1758 </ul><br />
1759 </dd>
1761 <dt><b>$cfg['SQLValidator']['use']</b> boolean</dt>
1762 <dd>
1763 phpMyAdmin now supports use of the <a href="http://developer.mimer.com/validator/index.htm">Mimer SQL Validator</a> service,
1764 as originally published on
1765 <a href="http://developers.slashdot.org/article.pl?sid=02/02/19/1720246">Slashdot</a>.
1766 <br />
1767 For help in setting up your system to use the service, see the
1768 <a href="#faqsqlvalidator">FAQ #6.14</a>.
1769 <br /><br />
1770 </dd>
1772 <dt><b>$cfg['SQLValidator']['username']</b> string<br />
1773 <b>$cfg['SQLValidator']['password']</b> string</dt>
1774 <dd>
1775 The SOAP service allows you to login with <tt>anonymous</tt>
1776 and any password, so we use those by default.. Instead, if
1777 you have an account with them, you can put your login details
1778 here, and it will be used in place of the anonymous login.
1779 <br /><br />
1780 </dd>
1782 <dt><b>$cfg['DBG']['enable']</b> boolean</dt>
1783 <dd>
1784 <b>DEVELOPERS ONLY!</b><br />
1785 Enable the DBG extension for debugging phpMyAdmin. Required for profiling
1786 the code.
1787 <br />
1788 For help in setting up your system to this, see the
1789 <a href="#developersdbg">Developers</a> section.
1790 </dd>
1792 <dt><b>$cfg['DBG']['profile']['enable']</b> boolean</dt>
1793 <dd>
1794 <b>DEVELOPERS ONLY!</b><br />
1795 Enable profiling support for phpMyAdmin. This will append a chunk of data
1796 to the end of every page displayed in the main window with profiling
1797 statistics for that page.<br />
1798 You may need need to increase the maximum execution time for this to
1799 complete successfully.
1800 </dd>
1802 <dt><b>$cfg['DBG']['profile']['threshold']</b> float (units in milliseconds)</dt>
1803 <dd>
1804 <b>DEVELOPERS ONLY!</b><br />
1805 When profiling data is displayed, this variable controls the threshold of
1806 display for any profiling data, based on the average time each time has
1807 taken. If it is over the threshold it is displayed, otherwise it is not
1808 displayed. This takes a value in milliseconds. In most cases you don't need
1809 to edit this.
1810 </dd>
1812 <dt><b>$cfg['ColumnTypes'] </b>array</dt>
1813 <dd>
1814 All possible types of a MySQL column. In most cases you don't need to
1815 edit this.
1816 <br /><br />
1817 </dd>
1819 <dt><b>$cfg['AttributeTypes'] </b>array</dt>
1820 <dd>
1821 Possible attributes for fields. In most cases you don't need to edit
1822 this.
1823 <br /><br />
1824 </dd>
1826 <dt><b>$cfg['Functions'] </b>array</dt>
1827 <dd>
1828 A list of functions MySQL supports. In most cases you don't need to
1829 edit this.
1830 <br /><br />
1831 </dd>
1833 </dl>
1835 <!-- TRANSFORMATIONS -->
1836 <a name="transformations"></a><br />
1837 <h2>Transformations</h2>
1840 <a href="#transformationsintro">Introduction</a> &nbsp;-&nbsp;
1841 <a href="#transformationshowto">Usage</a> &nbsp;-&nbsp;
1842 <a href="#transformationsfiles">File structure</a> &nbsp;-&nbsp;
1843 </p>
1845 <a name="transformationsintro"></a><br />
1846 <h3>[1. Introduction]</h3>
1848 <p>To enable transformations, you have to setup the column_info table and the proper
1849 directives. Please see the <a href="#config">Configuration section</a> on how to do so.</p>
1850 <br />
1852 <p>You can apply different transformations to the contents of each field. The
1853 transformation will take the content of each field and transform it with
1854 certain rules defined in the selected transformation.</p><br />
1856 <p>Say you have a field 'filename' which contains a filename. Normally you would see
1857 in phpMyAdmin only this filename. Using transformations you can transform that filename
1858 into a HTML link, so you can click inside of the phpMyAdmin structure on the field's
1859 link and will see the file displayed in a new browser window. Using transformation
1860 options you can also specify strings to append/prepend to a string or the format you
1861 want the output stored in.</p><br />
1863 <p>For a general overview of all available transformations and their options, you can
1864 consult your <i>&lt;www.your-host.com&gt;/&lt;your-install-dir&gt;/libraries/transformations/overview.php3</i>
1865 installation.</p>
1867 <p><br />For a tutorial on how to effectively use transformations, see our <a href="http://www.phpmyadmin.net/#links">Link section</a> on the official phpMyAdmin-homepage.</p>
1869 <a name="transformationshowto"></a><br />
1870 <h3>[2. Usage]</h3>
1872 <p>Go to your tbl_properties.inc.php3 page (i.e. reached through clicking on the
1873 'properties' link for a table). There you will see three new fields at the end of the
1874 line. They are called 'MIME-type', 'Browser transformation' and 'Transformation options'.</p>
1875 <br />
1877 <ul>
1878 <li>The field 'MIME-type' is a dropdown field. You have the options to leave that field
1879 empty or to use 'auto' [this feature is not yet available]. Please note that
1880 transformations are inactive as long as no mime-type is selected.</li>
1882 <li>The field 'Browser transformation' is a drop-down field. You can choose from a
1883 hopefully growing amount of pre-defined transformations. See below for information on
1884 how to build your own transformation.<br />
1886 There are global transformations and mimetype-bound transformations. Global transformations
1887 can be used for any mimetype. They will take the mimetype, if necessary, into regard.
1888 Mimetype-bound transformations usually only operate on a certain mimetype. There are
1889 transformations which operate on the main mimetype (like 'image'), which will most likely
1890 take the subtype into regard, and those who only operate on a
1891 specific subtype (like 'image/jpeg').<br />
1893 You can use transformations on mimetypes for which the function was not defined for. There
1894 is no security check for you selected the right transformation, so take care of what the
1895 output will be like.</li>
1897 <li>The field 'Transformation options' is a free-type textfield. You have to enter
1898 transform-function specific options here. Usually the transforms can operate with default
1899 options, but it is generally a good idea to look up the overview to see which options are
1900 necessary.<br />
1902 Much like the ENUM/SET-Fields, you have to split up several options using the format
1903 'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
1904 parsed as an array, leaving the first value the first element in the array, and so
1905 forth.<br />
1907 If you want to specify a MIME character set you can define it in the transformation_options.
1908 You have to put that outside of the pre-defined options of the specific mime-transform,
1909 as the last value of the set. Use the format "'; charset=XXX'". If you use a transform,
1910 for which you can specify 2 options and you want to append a character set, enter "'first
1911 parameter','second parameter','charset=us-ascii'". You can, however use the defaults for
1912 the parameters: "'','','charset=us-ascii'".</li>
1913 </ul>
1915 <a name="transformationsfiles"></a><br />
1916 <h3>[3. File structure]</h3>
1918 <p>All mimetypes and their transformations are defined through single files in
1919 the directory 'libraries/transformations/'.</p><br />
1921 <p>They are stored in files to ease up customization and easy adding of new
1922 transformations.</p><br />
1924 <p>Because the user cannot enter own mimetypes, it is kept sure that transformations
1925 always work. It makes no sense to apply a transformation to a mimetype, the
1926 transform-function doesn't know to handle.</p><br />
1928 <p>One can, however, use empty mime-types and global transformations which should work
1929 for many mimetypes. You can also use transforms on a different mimetype they where built
1930 for, but pay attention to option usage as well as what the transformation does to your
1931 field.</p><br />
1933 <p>There is a basic file called 'global.inc.php3'. This function can be included by
1934 any other transform function and provides some basic functions.</p><br />
1936 <p>There are 5 possible file names:</p>
1938 <ol>
1939 <li>A mimetype+subtype transform:<br /><br />
1941 [mimetype]_[subtype]__[transform].inc.php3<br /><br />
1943 Please not that mimetype and subtype are separated via '_', which shall not be
1944 contained in their names. The transform function/filename may contain only
1945 characters which cause no problems in the file system as well as the PHP function
1946 naming convention.<br /><br />
1948 The transform function will the be called 'PMA_transform_[mimetype]_[subtype]__[transform]()'.<br /><br />
1950 <b>Example:</b><br /><br />
1952 text_html__formatted.inc.php3<br />
1953 PMA_transform_text_html__formatted()</li>
1955 <li>A mimetype (w/o subtype) transform:<br /><br />
1957 [mimetype]__[transform].inc.php3<br /><br />
1959 Please note that there are no single '_' characters.
1960 The transform function/filename may contain only characters which cause no problems
1961 in the file system as well as the PHP function naming convention.<br /><br />
1963 The transform function will the be called 'PMA_transform_[mimetype]__[transform]()'.<br /><br />
1965 <b>Example:</b><br /><br />
1967 text__formatted.inc.php3<br />
1968 PMA_transform_text__formatted()</li>
1970 <li>A mimetype+subtype without specific transform function<br /><br />
1972 [mimetype]_[subtype].inc.php3<br /><br />
1974 Please note that there are no '__' characters in the filename. Do not use special
1975 characters in the filename causing problems with the file system.<br /><br />
1977 No transformation function is defined in the file itself.<br /><br />
1979 <b>Example:</b><br /><br />
1981 text_plain.inc.php3<br />
1982 (No function)</li>
1984 <li>A mimetype (w/o subtype) without specific transform function<br /><br />
1986 [mimetype].inc.php3<br /><br />
1988 Please note that there are no '_' characters in the filename. Do not use special
1989 characters in the filename causing problems with the file system.<br /><br />
1991 No transformation function is defined in the file itself.<br /><br />
1993 <b>Example:</b><br /><br />
1995 text.inc.php3<br />
1996 (No function)</li>
1998 <li>A global transform function with no specific mimetype<br /><br />
2000 global__[transform].inc.php3<br /><br />
2002 The transform function will the be called 'PMA_transform_global__[transform]()'.<br /><br />
2004 <b>Example:</b><br /><br />
2006 global__formatted<br />
2007 PMA_transform_global__formatted()</li>
2008 </ol>
2010 <br />
2011 <p>So generally use '_' to split up mimetype and subtype, and '__' to provide a
2012 transform function.</p><br />
2014 <p>All filenames containing no '__' in themselves are not shown as valid transform
2015 functions in the dropdown.</p><br />
2017 <p>Please see the libraries/transformations/TEMPLATE file for adding your own transform
2018 function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
2019 without a transform function. Also note the introduction of a function description in
2020 the language files. For each function a $strTransformation_[filename without .inc.php3]
2021 has to exist.</p><br />
2023 <p>You can use the template generator to generate new functions and entries in the
2024 language file.</p><br />
2026 <p>To create a new transform function please see libraries/transformations/template_generator.sh.
2027 To create a new, empty mimetype please see libraries/transformations/template_generator_mimetype.sh.</p><br />
2029 <!-- FAQ -->
2030 <a name="faq"></a><br />
2031 <h2>FAQ - Frequently Asked Questions</h2>
2034 <a href="#faqserver">Server</a> &nbsp;-&nbsp;
2035 <a href="#faqconfig">Configuration</a> &nbsp;-&nbsp;
2036 <a href="#faqlimitations">Limitations</a> &nbsp;-&nbsp;
2037 <a href="#faqmultiuser">Multi-user</a> &nbsp;-&nbsp;
2038 <a href="#faqbrowsers">Browsers</a> &nbsp;-&nbsp;
2039 <a href="#faqusing">Usage tips</a> &nbsp;-&nbsp;
2040 <a href="#faqproject">Project</a> &nbsp;-&nbsp;
2041 <a href="#faqsecurity">Security</a>
2042 </p>
2044 <p><br />
2045 Please have a look at our <a href="http://www.phpmyadmin.net/#links">Link section</a> on the official phpMyAdmin homepage for in-depth coverage of phpMyAdmin's features and/or interface.
2046 </p>
2048 <a name="faqserver"></a><br />
2049 <h3>[1. Server]</h3>
2051 <h4>
2052 [1.1] I'm running PHP 4+ and my server is crashing each time a specific
2053 action is required or phpMyAdmin sends a blank page or a page full of
2054 cryptic characters to my browser, what can I do?
2055 </h4>
2057 There are some known PHP bugs with output buffering and compression.<br />
2058 Try to set the <tt>$cfg['OBGzip']</tt> directive to <tt>FALSE</tt> in your
2059 <i>config.inc.php or .php3</i> file and the
2060 <tt>zlib.output_compression</tt> directive to <tt>Off</tt> in your php
2061 configuration file.<br />
2062 Furthermore, we know about such problems connected to the release
2063 candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together with
2064 MS Internet Explorer. Please upgrade to the release version PHP 4.2.0.
2065 </p>
2067 <h4>
2068 [1.2] My Apache server crashes when using phpMyAdmin.
2069 </h4>
2071 You should first try the latest versions of Apache (and possibly MySQL).
2072 <br />
2073 See also the other FAQ entry about PHP bugs with output buffering.
2074 <br />
2075 If your server keeps crashing, please ask for help in the various
2076 Apache support groups.
2077 </p>
2079 <h4>
2080 [1.3] I'm running phpMyAdmin with "cookie" authentication mode under
2081 PHP 4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the
2082 script: I'm always displayed the login screen.
2083 </h4>
2085 This is a known PHP bug (see this
2086 <a href="http://bugs.php.net/bug.php?id=16626">bug report</a>) from the
2087 official PHP bug database. It means there is and won't be any phpMyAdmin
2088 fix against it because there is no way to code a fix.
2089 </p>
2091 <h4>
2092 [1.4] Using phpMyAdmin on IIS, I'm displayed the error message:
2093 &quot;The specified CGI application misbehaved by not returning a
2094 complete set of HTTP headers...&quot;.
2095 </h4>
2097 You just forgot to read the <i>install.txt</i> file from the php
2098 distribution. Have a look at the last message in this
2099 <a href="http://bugs.php.net/bug.php?id=12061">bug report</a> from the
2100 official PHP bug database.
2101 </p>
2103 <h4>
2104 [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
2105 messages with the HTTP or advanced authentication mode.
2106 </h4>
2108 This is a known problem with the PHP ISAPI filter: it's not so stable. For
2109 some more information and complete testings see the messages posted by
2110 Andr&eacute; B. aka &quot;djdeluxe76&quot; in
2111 <a href="http://www.phpwizard.net/phorum/read.php?f=1&amp;i=6624&amp;t=6300">this&nbsp;thread</a>
2112 from the phpWizard forum.<br />
2113 Please use instead the cookie authentication mode.
2114 </p>
2116 <h4>
2117 [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!</h4>
2119 This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
2120 time there is no better fix): remove or comment the <tt>DOCTYPE</tt>
2121 declarations (2 lines) from the scripts <i>header.inc.php3</i>,
2122 <i>header_printview.inc.php3</i>, <i>index.php3</i>, <i>left.php3</i> and
2123 <i>libraries/common.lib.php3</i>.
2124 </p>
2126 <h4>
2127 [1.7] How can I GZip or Bzip a dump or a CSV export. It does not seem to
2128 work.
2129 </h4>
2131 These features are based on the <tt>gzencode()</tt> and
2132 <tt>bzcompress()</tt> PHP functions to be more independent of the platform
2133 (Unix/Windows, Safe Mode or not, and so on).
2134 So, you must have PHP4&nbsp;>=&nbsp;4.0.4 and Zlib/Bzip2 support
2135 (<tt>--with-zlib</tt> and <tt>--with-bz2</tt>).<br />
2136 We faced PHP crashes when trying to download a dump with MS Internet
2137 Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0. In
2138 this case you should switch to the release version of PHP 4.2.0.
2139 </p>
2141 <h4>
2142 [1.8] I cannot insert a text file in a table, and I get an error about
2143 safe mode being in effect.
2144 </h4>
2146 Your uploaded file is saved by PHP in the &quot;upload dir&quot;, as
2147 defined in <i>php.ini</i> by the variable <tt>upload_tmp_dir</tt> (usually
2148 the system default is <i>/tmp</i>).
2149 <br />
2150 We recommend the following setup for Apache servers running in safe mode,
2151 to enable uploads of files while being reasonably secure:
2152 </p>
2153 <ul>
2154 <li>create a separate directory for uploads:
2155 <tt>mkdir /tmp/php</tt></li>
2156 <li>give ownership to the Apache server's user.group:
2157 <tt>chown apache.apache /tmp/php</tt></li>
2158 <li>give proper permission: <tt>chmod 600 /tmp/php</tt></li>
2159 <li>put <tt>upload_tmp_dir = /tmp/php</tt> in php.ini</li>
2160 <li>restart Apache</li>
2161 </ul>
2163 <h4>
2164 [1.9] I'm having troubles when uploading files. In general file uploads
2165 don't work on my system and uploaded files have a <tt>Content-Type:</tt>
2166 header in the first line.
2167 </h4>
2169 It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat 7.0
2170 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't you?
2171 <br />
2172 So the problem is that this package has a serious bug that was corrected
2173 ages ago in PHP (2001-01-28: see
2174 <a href="http://www.php.net/bugs.php?id=8966">PHP's bug tracking system</a>
2175 for more details). The problem is that the bugged package is still
2176 available though it was corrected (see
2177 <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=24933">RedHat's BugZilla</a>
2178 for more details).
2179 <br />
2180 So please download
2181 <a href="http://www.redhat.com/swr/i386/php-4.0.4pl1-9.i386.html">the fixed package (4.0.4pl1-9)</a>
2182 and the problem should go away.
2183 <br />
2184 And that fixes the \r\n problem with file uploads!
2185 </p>
2187 <h4>
2188 [1.10] I'm having troubles when uploading files with phpMyAdmin running
2189 on a secure server. My browser is Internet Explorer and I'm using the
2190 Apache server.
2191 </h4>
2193 As suggested by &quot;Rob M&quot; in the phpWizard forum, add this line to
2194 your <i>httpd.conf</i>:<br />
2195 &nbsp;&nbsp;&nbsp;&nbsp;<tt>SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown</tt><br />
2196 It seems to clear up many problems between Internet Explorer and SSL.
2197 </p>
2199 <h4>
2200 [1.11] I get an 'open_basedir restriction' while uploading a file from
2201 the query box.
2202 </h4>
2204 Since version 2.2.4, phpMyAdmin supports servers with open_basedir
2205 restrictions. Assuming that the restriction allows you to open files in the
2206 current directory ('.'), all you have to do is create a 'tmp' directory
2207 under the phpMyAdmin install directory, with permissions 777 and the same
2208 owner as the owner of your phpMyAdmin directory. The uploaded files will
2209 be moved there, and after execution of your SQL commands, removed.
2210 </p>
2212 <h4>
2213 [1.12] I have lost my MySQL root password, what can I do?
2214 </h4>
2216 The MySQL manual explains how to
2217 <a href="http://www.mysql.com/doc/R/e/Resetting_permissions.html">
2218 reset the permissions</a>.
2219 </p>
2221 <h4>
2222 [1.13] I get an error 'No SQL query' when trying to execute a bookmark.
2223 </h4>
2225 If PHP does not have read/write access to its <tt>upload_tmp_dir</tt>, it
2226 cannot access the uploaded query.
2227 </p>
2229 <h4>
2230 [1.14] I get an error 'No SQL query' when trying to submit a query from
2231 the convenient text area.
2232 </h4>
2234 Check the <tt>post_max_size</tt> directive from your PHP configuration file
2235 and try to increase it.
2236 </p>
2238 <h4>
2239 [1.15] I have problems with <i>mysql.user</i> field names.
2240 </h4>
2242 In older MySQL versions, the <tt>User</tt> and <tt>Password</tt> fields
2243 were named <tt>user</tt> and <tt>password</tt>. Please modify your field
2244 names to align with current standards.
2245 </p>
2246 <h4>
2247 [1.16] I cannot upload big dump files (memory, http or timeout problems).
2248 </h4>
2250 The first things to check (or ask your host provider to check) are the
2251 values of <tt>upload_max_filesize</tt>, <tt>memory_limit</tt> and
2252 <tt>post_max_size</tt> in the <i>php.ini</i> configuration file.
2253 <br />
2254 All of these three settings limit the maximum size of data that can be
2255 submitted and handled by PHP. One user also said that post_max_size
2256 and memory_limit need to be larger than upload_max_filesize.
2257 <br />
2258 If you get a timeout problem, look at the <tt>$cfg['UploadDir']</tt>
2259 feature.
2260 </p>
2262 <h4>
2263 [1.17] Does phpMyAdmin support MySQL&nbsp;4.1 and 5.0?
2264 </h4>
2266 phpMyAdmin provides limited support for MySQL&nbsp;4.1. That means that you
2267 can neither assign character sets to a table or field on create nor change
2268 the (automatically) assigned character set.<br />
2269 When compiling php, we strongly recommend that you manually link it to a
2270 MySQL&nbsp;4.1 client library since the one that is currently bundled with
2271 php is rather old and might cause problems.<br />
2272 MySQL 5 is not yet supported.
2273 </p>
2275 <h4>
2276 [1.18] I'm running MySQL&nbsp;&lt;=&nbsp;4.0.1 having
2277 <tt>lower_case_table_names</tt> set to 1. If I create a new table with a
2278 capital letter in its name it is changed to lowercase as it should. But
2279 if I try to DROP this table MySQL is unable to find the corresponding
2280 file.
2281 </h4>
2283 This is a bug of MySQL&nbsp;&lt;=&nbsp;4.0.1. Please upgrade to at least
2284 MySQL&nbsp;4.0.2 or turn off your <tt>lower_case_table_names</tt>
2285 directive.
2286 </p>
2288 <h4>
2289 [1.19] I can't run the &quot;display relations&quot; feature because the
2290 script seems not to know the font face I'm using!
2291 </h4>
2293 The &quot;FPDF&quot; library we're using for this feature requires some
2294 special files to use font faces.<br />
2295 Please refers to the
2296 <a href="http://www.fpdf.org/" target="_blank">FPDF manual</a> to build
2297 these files.
2298 </p>
2300 <a name="faqmysql"></a><br />
2301 <h4>
2302 [1.20] I receive the error &quot;cannot load MySQL extension, please
2303 check PHP Configuration&quot;.
2304 </h4>
2306 To connect to a MySQL server, PHP needs a set of MySQL functions called
2307 &quot;MySQL extension&quot;.
2308 This extension may be part of the PHP server (compiled-in), otherwise it
2309 needs to be loaded dynamically. Its name is probably <i>mysql.so</i> or
2310 <i>mysql.dll</i>. phpMyAdmin tried to load the extension but failed.
2311 <br /><br />
2312 Usually, the problem is solved by installing a software package called
2313 &quot;PHP-MySQL&quot; or something similar.
2314 </p>
2316 <h4>
2317 [1.21] I am running the CGI version of PHP under Unix, and I cannot
2318 login using cookie auth.
2319 </h4>
2321 In <i>php.ini</i>, set <tt>mysql.max_links</tt> higher than 1.
2322 </p>
2324 <h4>
2325 [1.22] I don't see the &quot;Location of text file&quot; field, so
2326 I cannot upload.
2327 </h4>
2329 This is most likely because in <i>php.ini</i>, your <tt>file_uploads</tt>
2330 parameter is not set to &quot;on&quot;.
2331 </p>
2333 <h4>
2334 [1.23] I'm running MySQL on a Win32 machine. Each time I create a new
2335 table the table and field names are changed to lowercase!
2336 </h4>
2338 This happens because the MySQL directive <tt>lower_case_table_names</tt>
2339 defaults to 1 (<tt>ON</tt>) in the Win32 version of MySQL. You can change
2340 this behavior by simply changing the directive to 0 (<tt>OFF</tt>):<br />
2341 Just edit your <tt>my.ini</tt> file that should be located in your Windows
2342 directory and add the following line to the group [mysqld]:<br />
2343 <tt>set-variable = lower_case_table_names=0</tt><br />
2344 Next, save the file and restart the MySQL service. You can always check the
2345 value of this directive using the query<br />
2346 <tt>SHOW VARIABLES LIKE 'lower_case_table_names';</tt>
2347 </p>
2349 <h4>
2350 [1.24] Some characters are being truncated in my queries, or I get
2351 characters randomly added. I am running PHP 4.2.3.
2352 </h4>
2354 This is a
2355 <a href="http://bugs.php.net/bug.php?id=19404">PHP 4.2.3 bug</a>.
2356 </p>
2358 <h4>
2359 [1.25] I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
2360 and I get problems, such as undefined variables when I run a SQL query.
2361 </h4>
2363 A tip from Jose Fandos: put a comment on the following two lines
2364 in httpd.conf, like this:<br />
2365 <tt># mod_gzip_item_include file \.php$</tt><br />
2366 <tt># mod_gzip_item_include mime "application/x-httpd-php.*"</tt><br />
2367 as this version of mod_gzip on Apache (Windows) has problems handling
2368 PHP scripts. Of course you have to restart Apache.
2369 </p>
2371 <h4>
2372 [1.26] I just installed phpMyAdmin in my document root of IIS but
2373 I get the error &quot;No input file specified&quot; when trying to
2374 run phpMyAdmin.
2375 </h4>
2377 This is a permission problem. Right-click on the phpmyadmin folder
2378 and choose properties. Under the tab Security, click on &quot;Add&quot;
2379 and select the user &quot;IUSER_machine&quot; from the list. Now set his
2380 permissions and it should work.
2381 </p>
2383 <h4>
2384 [1.27] I get empty page when I want to view huge page (eg.
2385 db_details_structure.php3 with plenty of databases).
2386 </h4>
2388 This is a <a href="http://bugs.php.net/21079">PHP bug</a> that occur when
2389 GZIP output buffering enabled. If you turn off it (by <code>$cfg['OBGzip']
2390 = FALSE</code> in config.inc.php3), it should work. This bug will be fixed
2391 in PHP 5.0.0.
2392 </p>
2394 <h4>
2395 [1.28] My MySQL server sometimes refuses queries and returns the message
2396 'Errorcode: 13'. What does this mean?
2397 </h4>
2399 This can happen due to a MySQL bug when having database / table names with
2400 upper case characters although <tt>lower_case_table_names</tt> is set to 1.
2401 To fix this, turn off this directive, convert all database and table names
2402 to lower case and turn it on again. Alternatively, there's a bug-fix
2403 available starting with MySQL&nbsp;3.23.56 / 4.0.11-gamma.
2404 </p>
2406 <a name="faq-1-29"></a>
2407 <h4>
2408 [1.29] When I create a table or modify a field, I get an error
2409 and the fields are duplicated.
2410 </h4>
2412 It is possible to configure Apache in such a way that PHP has problems
2413 interpreting .php files.
2414 <br /><br />
2415 The problems occur when two different (and conflicting) set of directives
2416 are used:
2417 <br /><br />
2418 <tt>
2419 SetOutputFilter PHP<br />
2420 SetInputFilter PHP<br />
2421 </tt>
2422 &amp;
2423 <br />
2424 <tt>
2425 AddType application/x-httpd-php .php
2426 </tt>
2427 <br /><br />
2428 In the case we saw, one set of directives was in <tt>httpd.conf</tt>, while
2429 the other set was in <tt>php.conf</tt>.<br />
2430 The recommended way is with <tt>AddType</tt>, so just comment out
2431 the first set of lines and restart Apache:
2432 <br /><br />
2433 <tt><b>
2434 #SetOutputFilter PHP<br />
2435 #SetInputFilter PHP<br /></b>
2436 </tt>
2437 </p>
2439 <a name="faqconfig"></a><br />
2440 <h3>[2. Configuration]</h3>
2442 <h4>
2443 [2.1] The error message &quot;Warning: Cannot add header information -
2444 headers already sent by ...&quot; is displayed, what's the problem?
2445 </h4>
2447 Edit your <i>config.inc.php or .php3</i> file and ensure there is nothing
2448 (I.E. no blank lines, no spaces, no characters...) neither before the
2449 <tt>&lt;?php</tt> tag at the beginning, neither after the <tt>?&gt;</tt>
2450 tag at the end.
2451 </p>
2453 <h4>
2454 [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
2455 </h4>
2457 Either there is an error with your PHP setup or your username/password is
2458 wrong. Try to make a small script which uses mysql_connect and see if it
2459 works. If it doesn't, it may be you haven't even compiled MySQL support
2460 into PHP.
2461 </p>
2463 <h4>
2464 [2.3] The error message &quot;Warning: MySQL Connection Failed: Can't
2465 connect to local MySQL server through socket '/tmp/mysql.sock'
2466 (111)...&quot; is displayed. What can I do?
2467 </h4>
2468 <p><br />
2469 For RedHat users, Harald Legner suggests this on the mailing list:
2470 <br /><br />
2471 On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
2472 In your php.ini you will find a line
2473 <br />
2474 &nbsp;&nbsp;&nbsp;&nbsp;<tt>mysql.default_socket = /tmp/mysql.sock</tt>
2475 <br />
2476 change it to
2477 <br />
2478 &nbsp;&nbsp;&nbsp;&nbsp;<tt>mysql.default_socket = /var/lib/mysql/mysql.sock</tt>
2479 <br />
2480 Then restart apache and it will work.
2481 <br /><br />
2482 Here is a fix suggested by Brad Ummer in the phpwizard forum:
2483 </p>
2484 <ul>
2485 <li>
2486 First, you need to determine what socket is being used by MySQL.
2487 <br />
2488 To do this, telnet to your server and go to the MySQL bin directory. In
2489 this directory there should be a file named <i>mysqladmin</i>. Type
2490 <tt>./mysqladmin variables</tt>, and this should give you a bunch of
2491 info about your MySQL server, including the socket
2492 (<i>/tmp/mysql.sock</i>, for example).
2493 </li>
2494 <li>
2495 Then, you need to tell PHP to use this socket.<br />Assuming you are
2496 using PHP 3.0.10 or better, you can specify the socket to use when you
2497 open the connection. To do this in phpMyAdmin, you need to complete the
2498 socket information in the config.inc.php3.<br />
2499 For example:
2500 <tt>$cfg['Servers'][$i]['socket']&nbsp;=&nbsp;'/tmp/mysql.sock';</tt><br /><br />
2501 Please also make sure that the permissions of this file allow to be readable
2502 by your webserver (i.e. '0755').
2503 </li>
2504 </ul>
2506 Have also a look at the
2507 <a href="http://www.mysql.com/doc/C/a/Can_not_connect_to_server.html" target="_blank">
2508 corresponding section of the MySQL documentation</a>.
2509 </p>
2511 <h4>
2512 [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin,
2513 what can I do?
2514 </h4>
2516 Try to set the <tt>$cfg['OBGZip']</tt> directive to <tt>FALSE</tt> in the
2517 phpMyAdmin configuration file. It helps sometime.<br />
2518 Also have a look at your PHP version number: if it contains
2519 &quot;4.0b...&quot; it means you're running a beta version of PHP. That's
2520 not a so good idea, please upgrade to a plain revision.
2521 </p>
2523 <h4>
2524 [2.5] Each time I want to insert or change a record or drop a database
2525 or a table, an error 404 (page not found) is displayed or, with HTTP or
2526 cookie authentication, I'm asked to login again. What's wrong?
2527 </h4>
2529 Check the value you set for the <tt>$cfg['PmaAbsoluteUri']</tt> directive
2530 in the phpMyAdmin configuration file.
2531 </p>
2533 <h4>
2534 [2.6] I get an &quot;Access denied for user: 'root@localhost' (Using
2535 password: YES)&quot;-error when trying to access a MySQL-Server on a
2536 host which is port-forwarded for my localhost
2537 </h4>
2539 When you are using a port on your localhost, which you redirect via
2540 port-forwarding to another host, MySQL is not resolving the localhost
2541 as expected.<br />
2542 Erik Wasser explains: The solution is: if your host is &quot;localhost&quot;
2543 MySQL (the commandline tool 'mysql' as well) always tries to use the socket
2544 connection for speeding up things. And that doesn't work in this configuration
2545 with port forwarding.<br />
2546 If you enter "127.0.0.1" as hostname, everything is right and MySQL uses the
2547 TCP connection.
2548 </p>
2551 <a name="faqlimitations"></a><br />
2552 <h3>[3. Known limitations]</h3>
2553 <a name="login_bug"></a><br />
2554 <h4>
2555 [3.1] When using HTTP authentication, an user who logged out can not
2556 relogin in with the same nick.
2557 </h4>
2559 This is related to the authentication mechanism (protocol) used by
2560 phpMyAdmin. We plan to change it as soon as we may find enough free time
2561 to do it, but you can bypass this problem: just close all the opened
2562 browser windows and then go back to phpMyAdmin. You should be able to
2563 log in again.
2564 </p>
2566 <h4>
2567 [3.2] When dumping a large table in compressed mode, I get a memory
2568 limit error or a time limit error.
2569 </h4>
2571 As of version 2.2.4, we build the compressed dump in memory, so large
2572 tables dumps may hang. The only alternative we can think about (using
2573 system calls to mysqldump then gzip or bzip2) would not be applicable in
2574 environments where PHP is in safe mode: access to system programs is
2575 is limited by the system administrator, and time limit is enforced.
2576 </p>
2578 <h4>
2579 [3.3] With InnoDB tables, I lose foreign key relationships when I rename
2580 or alter a table.
2581 </h4>
2583 This seems to be a InnoDB bug (fixed in MySQL 3.23.50?). However, keep in
2584 mind that phpMyAdmin as of version 2.3.0 does not support InnoDB.
2585 </p>
2587 <h4>
2588 [3.4] I am unable to import dumps I created with the mysqldump tool
2589 bundled with the MySQL server distribution.
2590 </h4>
2592 The problem is that mysqldump creates invalid comments like this:
2593 </p>
2594 <pre>
2595 -- MySQL dump 8.22
2597 -- Host: localhost Database: database
2598 ---------------------------------------------------------
2599 -- Server version 3.23.54
2600 </pre>
2602 The invalid part of the code is the horizontal line made of dashes that
2603 appears once in every dump created with mysqldump. If you want to run your
2604 dump you have to turn it into valid MySQL. This means, you have to add a
2605 whitespace after the first to dashes of the line or add a # before it:
2606 <br />
2607 <code>
2608 -- -------------------------------------------------------<br />
2609 </code>
2610 or<br />
2611 <code>
2612 #---------------------------------------------------------
2613 </code>
2614 </p>
2616 <h4>
2617 [3.3] When using nested folders ($cfg['LeftFrameTableSeparator']) there
2618 are some multiple hierarchies displayed in a wrong manner?!
2619 </h4>
2621 Please note that you should not use the seperating string multiple times
2622 without any characters between them, or at the beginning/end of your table
2623 name. If you have to, think about using another TableSeparator or disabling
2624 that feature
2625 </p>
2627 <a name="faqmultiuser"></a><br />
2628 <h3>[4. ISPs, multi-user installations ]</h3>
2630 <h4>
2631 [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I
2632 need to install it for each customer.
2633 </h4>
2635 Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
2636 your users. The development of this feature was kindly sponsored by
2637 NetCologne GmbH.
2638 This requires a properly setup MySQL user management and phpMyAdmin
2639 HTTP or cookie authentication. See the install section on
2640 &quot;Using HTTP authentication&quot;.
2641 </p>
2643 <h4>
2644 [4.2] What's the preferred way of making phpMyAdmin secure against evil
2645 access.
2646 </h4>
2648 This depends on your system.<br />
2649 If you're running a server which cannot be accessed by other people, it's
2650 sufficient to use the directory protection bundled with your webserver
2651 (with Apache you can use <i>.htaccess</i> files, for example).<br />
2652 If other people have telnet access to your server, you should use
2653 phpMyAdmin's HTTP authentication feature.
2654 <br /><br />
2655 Suggestions:
2656 </p>
2657 <ul>
2658 <li>
2659 Your <i>config.inc.php3</i> file should be <tt>chmod 660</tt>.
2660 </li>
2661 <li>
2662 All your phpMyAdmin files should be chown phpmy.apache, where phpmy
2663 is a user whose password is only known to you, and apache is the
2664 group under which Apache runs.
2665 </li>
2666 <li>
2667 You should use PHP safe mode, to protect from other users that try
2668 to include your <i>config.inc.php3</i> in their scripts.
2669 </li>
2670 </ul>
2672 <h4>
2673 [4.3] I get errors about not being able to include a file in
2674 <i>/lang</i> or in <i>/libraries</i>.
2675 </h4>
2677 Check <i>php.ini</i>, or ask your sysadmin to check it. The
2678 <tt>include_path</tt> must contain &quot;.&quot; somewhere in it, and
2679 <tt>open_basedir</tt>, if used, must contain &quot;.&quot; and
2680 &quot;./lang&quot; to allow normal operation of phpMyAdmin.
2681 </p>
2682 <h4>
2683 [4.4] phpMyAdmin always gives &quot;Access denied&quot; when using HTTP
2684 authentication.
2685 </h4>
2687 This could happen for several reasons:
2688 </p>
2689 <ul>
2690 <li>
2691 <tt>$cfg['Servers'][$i]['controluser']</tt> and/or
2692 <tt>$cfg['Servers'][$i]['controlpass']</tt> are wrong.
2693 </li>
2694 <li>
2695 The username/password you specify in the login-dialog are invalid.
2696 </li>
2697 <li>
2698 You have already setup a security mechanism for the
2699 phpMyAdmin-directory, eg. a .htaccess file. This would interfere with
2700 phpMyAdmin's authentication, so remove it.
2701 </li>
2702 </ul>
2704 <h4>
2705 [4.5] Is it possible to let users create their own databases?
2706 </h4>
2708 Starting with 2.2.5, in the user management page, you can enter a wildcard
2709 database name for a user (for example &quot;joe%&quot;),
2710 and put the privileges you want. For example,
2711 adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
2712 would let a user create/manage his/her database(s).
2713 </p>
2715 <h4>
2716 [4.6] How can I use the Host-based authentication additions?
2717 </h4>
2719 If you have existing rules from an old .htaccess file, you can take them
2720 and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
2721 <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
2722 be a major benefit here if your installation is suited to using it. Then
2723 you can just add those updated lines into the
2724 <tt>$cfg['Servers'][$i]['AllowDeny']['rules']</tt> array.
2725 <br /><br />
2726 If you want a pre-made sample, you can try this fragment. It stops the
2727 'root' user from logging in from any networks other than the private
2728 network IP blocks.
2729 <br />
2730 <tt>
2731 &nbsp;&nbsp;&nbsp;&nbsp;//block root from logging in except from the private networks<br />
2732 &nbsp;&nbsp;&nbsp;&nbsp;$cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';<br />
2733 &nbsp;&nbsp;&nbsp;&nbsp;$cfg['Servers'][$i]['AllowDeny']['rules'] = array(<br />
2734 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'deny root from all',<br />
2735 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from localhost',<br />
2736 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from 10.0.0.0/8',<br />
2737 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from 192.168.0.0/16',<br />
2738 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from 172.16.0.0/12',<br />
2739 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;);
2740 </tt>
2741 </p>
2742 <h4>
2743 [4.7] Authentication window is displayed more than once, why?
2744 </h4>
2746 This happens if you are using a URL to start phpMyAdmin which is
2747 different than the one set in your <tt>$cfg['PmaAbsoluteUri']</tt>.
2748 For example, a missing &quot;www&quot;, or entering with an IP address
2749 while a domain name is defined in the config file.
2750 </p>
2752 <a name="faqbrowsers"></a><br />
2753 <h3>[5. Browsers or client OS]</h3>
2755 <h4>
2756 [5.1] I get an out of memory error, and my controls are non-functional,
2757 when trying to create a table with more than 14 fields.
2758 </h4>
2760 We could reproduce this problem only under Win98/98SE. Testing under
2761 WinNT4 or Win2K, we could easily create more than 60 fields.
2762 <br />
2763 A workaround is to create a smaller number of fields, then come back to
2764 your table properties and add the other fields.
2765 </p>
2767 <h4>
2768 [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
2769 </h4>
2771 This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
2772 with each script/website that use forms.<br />
2773 Upgrade or downgrade your Xitami server.
2774 </p>
2776 <h4>
2777 [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
2778 </h4>
2780 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
2781 the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
2782 don't seem to work.<br />
2784 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
2785 the user's temporary directory, so they must be moved before closing
2786 Konqueror, or else they disappear. GZip dumps give an error message.<br />
2788 Testing needs to be done for Konqueror 2.2.2.<br />
2789 </p>
2791 <h4>
2792 [5.4] I can't use the cookie authentication mode because Internet
2793 Explorer never stores the cookies.
2794 </h4>
2796 MS Internet Explorer seems to be really buggy about cookies, at least till
2797 version 6. And thanks to Andrew Zivolup we've traced also a PHP 4.1.1 bug
2798 in this area!
2799 <br />
2800 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it may
2801 work!
2802 </p>
2804 <h4>
2805 [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
2806 rows.
2807 </h4>
2809 Upgrade to at least Internet Explorer 5.5 SP2.<br />
2810 </p>
2812 <h4>
2813 [5.6] In Internet Explorer 5.0, 5.5 or 6.0, I get an error (like "Page not found")
2814 when trying to modify a row in a table with many fields, or with a text field
2815 </h4>
2817 Your table neither have a primary key nor an unique one, so we must use a
2818 long URL to identify this row. There is a limit on the length of the URL in
2819 those browsers, and this not happen in Netscape, for example. The
2820 workaround is to create a primary or unique key, or use another browser.
2821 <br />
2822 </p>
2824 <h4>
2825 [5.7] I refresh (reload) my browser, and come back to the welcome
2826 page.
2827 </h4>
2829 Some browsers support right-clicking into the frame you want to refresh,
2830 just do this in the right frame.<br />
2831 </p>
2833 <h4>
2834 [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
2835 query box.
2836 </h4>
2838 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
2839 Mozilla versions.<br />
2840 </p>
2842 <h4>
2843 [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
2844 whitespace in the SQL-Query edit area: the page scrolls down.
2845 </h4>
2847 This is a Mozilla bug (see bug #26882 at
2848 <a href="http://bugzilla.mozilla.org/" target="_blank">BugZilla</a>).<br />
2849 </p>
2851 <h4>
2852 [5.10] With Netscape 4.75 I get empty rows between each row of data in a
2853 CSV exported file.
2854 </h4>
2856 This is a known Netscape 4.75 bug: it adds some line feeds when exporting
2857 data in octet-stream mode. Since we can't detect the specific Netscape
2858 version, we cannot workaround this bug.
2859 </p>
2861 <h4>
2862 [5.11] Extended-ASCII characters like German umlauts are displayed
2863 wrong.
2864 </h4>
2866 Please ensure that you have set your browser's character set to the one of the
2867 language file you have selected on phpMyAdmin's start page.
2868 Alternatively, you can try the auto detection mode that is supported by the
2869 recent versions of the most browsers.
2870 </p>
2872 <h4>
2873 [5.12] Apple OS X: Safari browser changes special characters to
2874 &quot;?&quot;.
2875 </h4>
2877 This issue has been reported by a OS X user, who adds that Chimera,
2878 Netscape and Mozilla do not have this problem.
2879 </p>
2881 <h4>
2882 [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type,
2883 I cannot manage two servers: I login to the first one, then the other one,
2884 but if I switch back to the first, I have to login on each operation.
2885 </h4>
2887 This is a bug in Internet Explorer, other browsers do not behave this way.
2888 </p>
2890 <h4>
2891 [5.14] Using Opera6, I can manage to get to the authentification, but nothing
2892 happens after that, only a blank screen.
2893 </h4>
2895 Having $cfg['QueryFrameJS'] set to TRUE, this leads to a bug in Opera6, because it
2896 is not able to interpret frameset definitiions written by JavaScript. Please upgrade
2897 to Opera7 at least.
2898 </p>
2900 <a name="faqusing"></a><br />
2901 <h3>[6. Using phpMyAdmin]</h3>
2903 <h4>
2904 [6.1] I can't insert new rows into a table / I can't create a table
2905 - MySQL brings up a SQL-error.
2906 </h4>
2908 Examine the SQL error with care. Often the problem is caused by
2909 specifying a wrong field-type.<br />
2910 Common errors include:
2911 </p>
2912 <ul>
2913 <li>Using <tt>VARCHAR</tt> without a size argument</li>
2914 <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
2915 </ul>
2917 Also, look at the syntax chapter in the MySQL manual to confirm that your
2918 syntax is correct.
2919 </p>
2921 <h4>
2922 [6.2] When I create a table, I click the Index checkbox for 2 fields and
2923 phpMyAdmin generates only one index with those 2 fields.
2924 </h4>
2926 In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a multi-fields
2927 index. If you want two indexes, create the first one when creating the
2928 table, save, then display the table properties and click the Index link to
2929 create the other index.
2930 </p>
2932 <h4>
2933 [6.3] How can I insert a null value into my table?
2934 </h4>
2936 Since version 2.2.3, you have a checkbox for each field that can be null.
2937 Before 2.2.3, you had to enter &quot;null&quot;, without the quotes, as the
2938 field's value.
2939 </p>
2941 <h4>
2942 [6.4] How can I backup my database or table?
2943 </h4>
2945 Click on a database or table name in the left frame, the properties will be
2946 displayed. Then on the menu, click &quot;Export&quot;, you can dump
2947 the structure, the data, or both. This will generate standard SQL
2948 statements that can be used to recreate your database/table.
2949 <br /><br />
2950 You will need to choose &quot;Save as file&quot;, so that phpMyAdmin can
2951 transmit the resulting dump to your station. Depending on your PHP
2952 configuration, you will see options to compress the dump. See also the
2953 <tt>$cfg['ExecTimeLimit']</tt> configuration variable.
2954 <br /><br />
2955 For additional help on this subject, look for the word &quot;dump&quot; in
2956 this document.
2957 </p>
2959 <h4>
2960 [6.5] How can I restore (upload) my database or table using a dump?
2961 How can I run a &quot;.sql&quot; file.
2962 </h4>
2964 Click on a database name in the left frame, the properties will be
2965 local displayed. Then in the &quot;Run SQL query&quot; section, type in
2966 your dump filename, or use the Browse button. Then click Go.
2967 <br /><br />
2968 For additional help on this subject, look for the word &quot;upload&quot;
2969 in this document.
2970 </p>
2972 <h4>
2973 [6.6] How can I use the relation table in Query-by-example?
2974 </h4>
2976 Here is an example with the tables persons, towns and countries, all
2977 located in the database mydb. If you don't have a <tt>PMA_relation</tt>
2978 table, create it as explained in the configuration section. Then create the
2979 example tables:
2980 <br /><br />
2981 <tt>
2982 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE REL_countries (<br />
2983 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;country_code char(1) NOT NULL default '',<br />
2984 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;description varchar(10) NOT NULL default '',<br />
2985 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (country_code)<br />
2986 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM;<br />
2987 <br />
2988 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_countries VALUES ('C', 'Canada');<br />
2989 <br />
2990 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE REL_persons (<br />
2991 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id tinyint(4) NOT NULL auto_increment,<br />
2992 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;person_name varchar(32) NOT NULL default '',<br />
2993 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;town_code varchar(5) default '0',<br />
2994 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;country_code char(1) NOT NULL default '',<br />
2995 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (id)<br />
2996 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM;<br />
2997 <br />
2998 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');<br />
2999 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');<br />
3000 <br />
3001 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE REL_towns (<br />
3002 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;town_code varchar(5) NOT NULL default '0',<br />
3003 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;description varchar(30) NOT NULL default '',<br />
3004 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (town_code)<br />
3005 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM;<br />
3006 <br />
3007 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');<br />
3008 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_towns VALUES ('M', 'Montr&eacute;al');<br />
3009 <br />
3010 </tt>
3011 To setup appropriate links and display information:
3012 </p>
3013 <ul>
3014 <li>on table &quot;REL_persons&quot; click Structure, then Relation view</li>
3015 <li>in Links, for &quot;town_code&quot; choose &quot;REL_towns-&gt;code&quot;</li>
3016 <li>in Links, for &quot;country_code&quot; choose &quot;REL_countries-&gt;country_code&quot;</li>
3017 <li>on table &quot;REL_towns&quot; click Structure, then Relation view</li>
3018 <li>in &quot;Choose field to display&quot;, choose &quot;description&quot;</li>
3019 <li>repeat the two previous steps for table &quot;REL_countries&quot;</li>
3020 </ul>
3023 Then test like this:
3024 </p>
3025 <ul>
3026 <li>Click on your db name in the left frame</li>
3027 <li>Choose &quot;Query&quot;</li>
3028 <li>Use tables: persons, towns, countries</li>
3029 <li>Click &quot;Update query&quot;</li>
3030 <li>In the fields row, choose persons.person_name and click the
3031 &quot;Show&quot; tickbox </li>
3032 <li>Do the same for towns.description and countries.descriptions in the
3033 other 2 columns</li>
3034 <li>Click &quot;Update query&quot; and you will see in the query box that
3035 the correct joins have been generated</li>
3036 <li>Click &quot;Submit query&quot;</li>
3037 </ul>
3038 <br />
3040 <a name="faqdisplay"></a><br />
3041 <h4>
3042 [6.7] How can I use the &quot;display field&quot; feature?
3043 </h4>
3045 Starting from the previous example, create the PMA_table_info as explained
3046 in the configuration section, then browse your persons table,
3047 and move the mouse over a town code or country code.
3048 <br /><br />
3049 See also FAQ 6.21 for an additionnal feature that &quot;display field&quot;
3050 enables: drop-down list of possible values.
3051 </p>
3053 <a name="faqpdf"></a><br />
3054 <h4>
3055 [6.8] How can I produce a PDF schema of my database?
3056 </h4>
3058 First you have to fill the &quot;relation&quot;, &quot;table_coords&quot;
3059 and &quot;pdf_pages&quot; configuration variables.
3060 <br /><br />
3061 Then, think about your schema layout: which tables will go on which pages.
3062 </p>
3063 <ul>
3064 <li>Click on your db name in the left frame</li>
3065 <li>Choose &quot;Structure&quot; in the navigation on top</li>
3066 <li>Choose &quot;Edit PDF Pages&quot; which should be somewhere at the
3067 bottom of the page</li>
3068 <li>Enter the name for a first pdf page and submit</li>
3069 <li>Choose this page to edit</li>
3070 <li>Now add a table you want to show on this page and it's coordinates and
3071 submit<br />
3072 First you will have to guess this coordinates of course, so just expect
3073 to have an area of about 297 * 210 and put the tables coordinates
3074 somewhere in there, you will be able to have a look at what happened
3075 and change them later.<br />
3076 For example, x=100 and y=200 means that the table will be at 200 mm
3077 down and 100 mm right from the upper left corner.<br />
3078 Actually if you have a width of more than 300 or a height of more than
3079 200 than it will automatically be scaled but 300*100 is a good start to
3080 have an idea of what coordinates to use.</li>
3081 <li>After every table you submitted you will have the possibility to submit
3082 more tables</li>
3083 <li>When you have entered enough tables Click on your db name in the left
3084 frame again</li>
3085 <li>Now, again at the bottom of the page you should be able to choose
3086 &quot;Display PDF schema&quot;<br />
3087 For testing it might be useful to show the grid as well, so you can see
3088 the coordinates used.<br />
3089 Maybe also choose color and submit.</li>
3090 <li>Save the file he will offer you to something like <i>Schema.pdf</i>
3091 (Internet Explorer has some bug there which might make it offer it
3092 without an extension. Under Windows it is important to have the
3093 extension &quot;.pdf&quot;, under other OSes you should be fine just
3094 saving the file under the name it offers).</li>
3095 </ul>
3097 <h4>
3098 [6.9] phpMyAdmin is changing the type of one of my columns!
3099 </h4>
3101 No, it's MySQL that is doing
3102 <a href="http://www.mysql.com/doc/S/i/Silent_column_changes.html">silent column type changing</a>.
3103 </p>
3105 <a name="underscore"></a><br />
3106 <h4>
3107 [6.10] When creating a privilege, what happens with underscores in
3108 the database name?
3109 </h4>
3111 If you do not put a backslash before the underscore, this is a wildcard
3112 grant, and the underscore means &quot;any character&quot;. So, if the
3113 database name is &quot;john_db&quot;, the user would get rights to john1db,
3114 john2db...<br /><br />
3115 If you put a backslash before the underscore, it means that the database
3116 name will have a real underscore.
3117 </p>
3119 <h4>
3120 [6.11] What is the curious symbol &oslash; in the statistics pages?
3121 </h4>
3123 It means &quot;average&quot;.
3124 </p>
3126 <a name="faqexport"></a><br />
3127 <h4>
3128 [6.12] I want to understand some Export options.
3129 </h4>
3131 &quot;Complete inserts&quot; adds the column names on every INSERT command,
3132 for better documentation (but resulting file is bigger).<br />
3133 &quot;Extended inserts&quot; provides a shorter dump file by using only
3134 once the INSERT verb and the table name.<br />
3135 &quot;Enclose table and field names with backquotes&quot; ensures that
3136 field and table names formed with special characters are protected.<br />
3137 &quot;Include column comments as inline SQL-comments&quot; includes any
3138 column comments set in the PMA-DB in the dump as SQL comments (<i>/* xxx */</i>).<br /></p>
3140 <h4>
3141 [6.13] I would like to create a database with a dot in its name.
3142 </h4>
3144 This is a bad idea, because in MySQL the syntax &quot;database.table&quot;
3145 is the normal way to reference a database and table name. Worse, MySQL
3146 will usually let you create a database with a dot, but then you cannot
3147 work with it, nor delete it.<br />
3148 </p>
3150 <a name="faqsqlvalidator"></a><br />
3151 <h4>
3152 [6.14] How do I set up the SQL Validator?
3153 </h4>
3155 To use it, you need a very recent version of PHP, 4.3.0 recommended, with
3156 XML, PCRE and PEAR support. On your system command line, run
3157 <tt>"pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME
3158 SOAP"</tt> to get the necessary PEAR modules for usage.
3159 <br />
3160 If you use it, you should be aware that any SQL statement you
3161 submit will be stored anonymously (database/table/column names,
3162 strings, numbers replaced with generic values). The Mimer SQL
3163 Validator itself, is &copy; 2001 Upright Database Technology.
3164 We utilize it as free SOAP service.
3165 </p>
3167 <h4>
3168 [6.15] I want to add a BLOB field and put an index on it, but MySQL
3169 says &quot;BLOB column '...' used in key specification without a key
3170 length&quot;.
3171 </h4>
3173 The right way to do this, is to create the field without any indexes,
3174 then display the table structure and use the &quot;Create an index&quot;
3175 dialog. On this page, you will be able to choose your BLOB field, and
3176 set a size to the index, which is the condition to create an index on
3177 a BLOB field.
3178 <br />
3179 </p>
3181 <h4>
3182 [6.16] How can I simply move in page with plenty editing fields?
3183 </h4>
3185 You can use Ctrl+arrows for moving on most pages with plenty editing
3186 fields (table structure changes, row editing, etc.) (must be anabled in
3187 configuration - see. $cfg['CtrlArrowsMoving']). You can also have a look
3188 at the directive $cfg['DefaultPropDisplay'] ('vertical') and see if this
3189 eases up editing for you.
3190 <br />
3191 </p>
3193 <h4>
3194 [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
3195 then useful for?
3196 </h4>
3198 Slow down :). Defining mimetypes is of no use, if you can't put transformations on them.
3199 Otherwise you could just put a comment on the field. Because entering your own mimetype will
3200 cause serious syntax checking issues and validation, this introduces a high-risk false-user-input
3201 situation. Instead you have to initialize mimetypes using functions or empty mimetype definitions.
3202 <br />
3203 Plus, you have a whole overview of available mimetypes. Who knows all those mimetypes by heart so
3204 he/she can enter it at will?
3205 <br />
3206 </p>
3208 <a name="faqbookmark"></a>
3209 <h4>
3210 [6.18] Bookmarks: Where can I store bookmarks? Why can't I see any bookmarks below the query box?
3211 What is this variable for?
3212 </h4>
3214 Any query you have executed can be stored as a bookmark on the page where the results are displayed.
3215 You will find a button labeled 'Bookmark this query' just at the end of the page.<br />
3216 As soon as you have stored a bookmark, it is related to the database you run the query on. You can
3217 now access a bookmark dropdown on each page, the query box appears on for that database.<br />
3218 <br />
3219 Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks. Just use the string
3220 <b>/*[VARIABLE]*/</b> anywhere in your query. Everything which is put into the <i>value</i> input
3221 box on the query box page will replace the string &quot;/*[VARIABLE]*/&quot; in your stored query.
3222 Just be aware of that you HAVE to create a valid query, otherwise your query won't be even able to be
3223 stored in the database.<br />
3224 Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string for your query will remain
3225 the way it is, but will be stripped of the /**/ chars. So you can use:<br /><br />
3226 <code>/*, [VARIABLE] AS myname */</code><br /><br />
3227 which will be expanded to<br /><br />
3228 <code>, VARIABLE as myname</code><br /><br />
3229 in your query, where VARIABLE is the string you entered in the input box. If an empty string is
3230 provided, no replacements are made.<br />
3231 <br />
3232 A more complex example. Say you have stored this query:<br /><br />
3233 <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code><br /><br />
3234 Say, you now enter &quot;phpMyAdmin&quot; as the variable for the stored query, the full query will
3235 be:<br /><br />
3236 <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
3237 <br />
3238 <br />
3239 You can use multiple occurences of <b>/*[VARIABLE]*/</b> in a single query.<br />
3240 <b>NOTE THE ABSENCE OF SPACES</b> inside the &quot;/**/&quot; construct. Any spaces inserted there
3241 will be later also inserted as spaces in your query and may lead to unexpected results especially when
3242 using the variable expansion inside of a &quot;LIKE ''&quot; expression.<br />
3243 Your initial query which is going to be stored as a bookmark has to yield at least one result row so
3244 you can store the bookmark. You may have that to work around using well positioned &quot;/**/&quot;
3245 comments.
3246 </p>
3248 <h4>
3249 [6.19] How can I create simple LaTeX document to include exported table?
3250 </h4>
3252 You can simply include table in your LaTeX documents, minimal sample
3253 document should look like following one (assuming you have table
3254 exported in file <code>table.tex</code>):
3255 <br />
3256 <br />
3257 <pre>
3258 <font color="#a52a2a"><b>\documentclass</b></font><font color="#6a5acd">{</font><font color="#a020f0">article</font><font color="#6a5acd">}</font>
3259 <font color="#a52a2a"><b>\usepackage</b></font><font color="#6a5acd">{</font><font color="#6a5acd">longtable</font><font color="#6a5acd">}</font>
3261 <font color="#a52a2a"><b>\begin</b></font><font color="#6a5acd">{</font><font color="#a020f0">document</font><font color="#6a5acd">}</font>
3263 <font color="#a52a2a"><b>\include</b></font><font color="#6a5acd">{</font><font color="#6a5acd">table</font><font color="#6a5acd">}</font>
3265 <font color="#a52a2a"><b>\end</b></font><font color="#6a5acd">{</font><font color="#a020f0">document</font><font color="#6a5acd">}</font>
3266 </pre>
3267 </p>
3269 <h4>
3270 [6.20] In MySQL 4, I see a lot of databases which are not mine, and cannot
3271 access them.
3272 </h4>
3274 Upgrading to MySQL 4 usually gives users a global privilege: CREATE
3275 TEMPORARY TABLES. This privilege also enables users to see all the
3276 database names. See this <a href="http://bugs.mysql.com/179">bug report</a>. <br /><br />
3277 So if your users do not need this privilege, you can remove it and their
3278 databases list will shorten.
3279 </p>
3280 <h4>
3281 [6.21] In edit/insert mode, how can I see a list of possible values for
3282 a field, based on some foreign table?
3283 </h4>
3285 You have to setup appropriate links between the tables, and also
3286 setup the &quot;display field&quot; in the foreign table. See FAQ
3287 6.6 for an example. Then, if there are 200 values or less in the
3288 foreign table, a drop-down list of values will be available.
3289 </p>
3290 <a name="faqproject"></a><br />
3291 <h3>[7. phpMyAdmin project]</h3>
3293 <h4>
3294 [7.1] I have found a bug. How do I inform developers?
3295 </h4>
3297 Our Bug Tracker is located at
3298 <a href="http://sourceforge.net/projects/phpmyadmin/">http://sourceforge.net/projects/phpmyadmin/</a>
3299 under the Bugs section.
3300 <br /><br />
3301 But please first discuss your bug with other users:
3302 <br />
3303 <a href="http://sourceforge.net/projects/phpmyadmin/">
3304 http://sourceforge.net/projects/phpmyadmin/</a> (and choose Forums)
3305 </p>
3307 <h4>
3308 [7.2] I want to translate the messages to a new language or upgrade an
3309 existing language, where do I start?
3310 </h4>
3312 Always use the current CVS version of your language file.
3313 For a new language, start from <i>english-iso-8859-1.inc.php3</i>. If you
3314 don't know how to get the CVS version, please ask one of the developers.
3315 <br />
3316 Please note that we try not to use HTML entities like &amp;eacute; in
3317 the translations, since we define the right character set in the file.
3318 With HTML entities, the text on JavaScript messages would not
3319 display correctly.
3320 However there are some entities that need to be there, for quotes
3321 ,non-breakable spaces, ampersands, less than, greater than.
3322 <br />
3323 You can then put your translations, as a zip file to avoid losing special
3324 characters, on the sourceforge.net translation tracker.
3325 <br />
3326 It would be a good idea to subscribe to the phpmyadmin-translators mailing
3327 list, because this is where we ask for translations of new messages.
3328 <br />
3329 </p>
3331 <h4>
3332 [7.3] I would like to help out with the development of phpMyAdmin. How
3333 should I proceed?
3334 </h4>
3336 The following method is preferred for new developers:
3337 </p>
3338 <ol>
3339 <li>
3340 fetch the current CVS tree over anonymous CVS:<br />
3341 <tt>cvs -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin login</tt><br />
3342 [Password: simply press the Enter key]<br />
3343 <tt>cvs -z3 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin checkout phpMyAdmin</tt><br />
3344 [This will create a new sub-directory named phpMyAdmin]
3345 </li>
3346 <li>
3347 add your stuff
3348 </li>
3349 <li>
3350 put the modified files (tar'ed and gzip'ed) inside the patch tracker of
3352 <a href="http://sourceforge.net/projects/phpmyadmin/" target="_blank">phpMyAdmin SourceForge account</a>.
3353 </li>
3354 </ol>
3356 Write access to the CVS tree is granted only to experienced developers who
3357 have already contributed something useful to phpMyAdmin.<br />
3358 Also, have a look at the
3359 <a href="#developers">Developers section</a>.
3360 </p>
3361 <a name="faqsecurity"></a><br />
3362 <h3>[8. Security ]</h3>
3364 <h4>
3365 [8.1] Security alert, dated 2003-06-18.
3366 </h4>
3368 Last update of this FAQ: 2003-07-22.
3369 <br /><br />
3370 The phpMyAdmin development team received notice of this security alert:
3371 <a href="http://www.securityfocus.com/archive/1/325641" target="_blank">http://www.securityfocus.com/archive/1/325641.</a>
3372 <br /><br />
3374 The team regrets that the author did not communicate with us before
3375 sending this alert. However, here is our current reply to the points mentionned:
3376 <br /><br />
3377 <ul>
3378 <li>&quot;Directory transversal attack&quot;
3379 <br /><br />
3381 This problem had been fixed in version 2.5.0, even if the author reports
3382 the 2.5.2 development version as vulnerable, which we could not reproduce.
3383 <br /><br />
3384 </li>
3385 <li>&quot;Remote local file retrieving&quot;
3386 <br /><br />
3387 This is a misleading title, as the author tells in his text:
3388 &quot;Note that you can't request files ( only dirs )&quot;.
3389 <br /><br />
3390 </li>
3392 <li>&quot;Remote internal directory listing&quot;
3393 <br /><br />
3394 It was possible to retrieve the list of phpMyAdmin's directory (which we
3395 doubt can cause any damage), but we fixed this in the
3396 2.5.2 version.
3397 <br /><br />
3398 </li>
3400 <li>&quot;XSS and Path disclosures&quot;
3401 <br /><br />
3402 Most of the XSS problems have been fixed in version 2.5.0. The rest
3403 have been fixed in the 2.5.2 version.
3404 <br /><br />
3405 We believe that the Path disclosures problems have also been fixed
3406 in version 2.5.2.
3407 <br /><br />
3408 </li>
3409 <li>&quot;Information encoding weakness&quot;
3410 <br /><br />
3411 We believe that an exploit for this weakness would be difficult
3412 to achieve. However version 2.5.2 now encrypts the password
3413 with the well-known blowfish algorithm.
3414 <br /><br />
3415 </li>
3416 </ul>
3418 </p>
3420 <!-- DEVELOPERS -->
3421 <a name="developers"></a><br />
3422 <h2>Developers Information</h2>
3425 phpMyAdmin is Open Source, so you're invited to contribute to it. Many
3426 great features have been written by other people and you too can help to
3427 make phpMyAdmin a useful tool.
3428 </p>
3431 If you're planning to contribute source, please read the following
3432 information:
3433 </p>
3434 <ul>
3435 <li>
3436 All files include <i>header.inc.php3</i> (layout),
3437 <i>libraries/common.lib.php3</i> (common functions) and
3438 <i>config.inc.php3</i>.
3439 <br />
3440 All configuration data belongs in <i>config.inc.php3</i>. Please keep
3441 it free from other code.
3442 <br />
3443 Commonly used functions should be added to
3444 <i>libraries/common.lib.php3</i> and more specific ones may be added
3445 within a library stored into the <i>libraries</i> sub-directory.
3446 </li>
3447 <li>
3448 Obviously, you're free to use whatever coding style you want. But
3449 please try to keep your code as simple as possible: beginners are
3450 using phpMyAdmin as an example application.<br />
3451 As far as possible, we want the scripts to be XHTML1.0 and CSS2
3452 compliant on one hand, they fit the
3453 <a href="http://pear.php.net/" target="_blank">PEAR coding standards</a>
3454 on the other hand. Please pay attention to this.
3455 </li>
3456 <li>
3457 Please try to keep up the file-naming conventions. Table-related stuff
3458 goes to <i>tbl_*.php3</i>, db-related code to <i>db_*.php3</i>,
3459 server-related tools to <i>server_*.php3</i> and so on.
3460 </li>
3461 <li>
3462 Please don't use verbose strings in your code, instead add the string
3463 (at least) to <i>english-iso-8859-1.inc.php3</i> and print() it out.
3464 </li>
3465 <li>
3466 If you want to be really helpful, write an entry for the ChangeLog.
3467 </li>
3468 <li id="developersdbg">
3469 The DBG extension (<a href="http://dd.cron.ru/dbg/" target="_blank">PHP
3470 Debugger DBG</a>) is now supported by phpMyAdmin for developers to
3471 better debug and profile their code.<br />
3472 Please see the <tt>$cfg['DBG']*</tt> configuration options for more
3473 information.<br />
3474 This is in memoriam of the Space Shuttle Columbia (STS-107) which was
3475 lost during its re-entry into Earth's atmosphere and in memory of the
3476 brave men and women who gave their lives for the people of Earth.
3477 </li>
3479 </ul>
3481 <!-- CREDITS -->
3482 <a name="credits"></a><br />
3483 <h2>Credits</h2>
3485 <pre>
3487 phpMyAdmin - Credits
3488 ====================
3490 CREDITS, in chronological order
3491 -------------------------------
3493 - Tobias Ratschiller &lt;tobias.ratschiller_at_maguma.com&gt;
3494 * creator of the phpmyadmin project
3495 * maintainer from 1998 to summer 2000
3497 - Marc Delisle &lt;DelislMa_at_CollegeSherbrooke.qc.ca&gt;
3498 * multi-language version
3499 * various fixes and improvements
3500 * project co-administrator
3502 - Olivier M&uuml;ller &lt;om_at_omnis.ch&gt;
3503 * started SourceForge phpMyAdmin project in March 2001
3504 * sync'ed different existing CVS trees with new features and bugfixes
3505 * multi-language improvements, dynamic language selection
3506 * current project maintainer
3507 * many bugfixes and improvements
3509 - Lo&iuml;c Chapeaux &lt;lolo_at_phpheaven.net&gt;
3510 * rewrote and optimized javascript, DHTML and DOM stuff
3511 * rewrote the scripts so they fit the PEAR coding standards and
3512 generate XHTML1.0 and CSS2 compliant codes
3513 * improved the language detection system
3514 * many bugfixes and improvements
3516 - Robin Johnson &lt;robbat2_at_users.sourceforge.net&gt;
3517 * database maintence controls
3518 * table type code
3519 * Host authentication IP Allow/Deny
3520 * DB-based configuration (Not completed)
3521 * SQL parser
3522 * SQL validator
3523 * many bugfixes and improvements
3525 - Armel Fauveau &lt;armel.fauveau_at_globalis-ms.com&gt;
3526 * bookmarks feature
3527 * multiple dump feature
3528 * gzip dump feature
3529 * zip dump feature
3531 - Geert Lund &lt;glund_at_silversoft.dk&gt;
3532 * various fixes
3533 * moderator of the phpMyAdmin users forum at phpwizard.net
3535 - Korakot Chaovavanich &lt;korakot_at_iname.com&gt;
3536 * &quot;insert as new row&quot; feature
3538 - Pete Kelly &lt;webmaster_at_trafficg.com&gt;
3539 * rewrote and fix dump code
3540 * bugfixes
3542 - Steve Alberty &lt;alberty_at_neptunlabs.de&gt;
3543 * rewrote dump code for PHP4
3544 * mySQL table statistics
3545 * bugfixes
3547 - Benjamin Gandon &lt;gandon_at_isia.cma.fr&gt;
3548 * main author of the version 2.1.0.1
3549 * bugfixes
3551 - Alexander M. Turek &lt;derrabus_at_gmx.de&gt;
3552 * XML exports
3553 * MySQL 4 related features
3554 * various features and fixes
3555 * German language file updates
3557 - Mike Beck &lt;mike.beck_at_ibmiller.de&gt;
3558 * automatic joins in QBE
3559 * links column in printview
3560 * Relation view
3562 - Michal Cihar &lt;nijel_at_users.sourceforge.net&gt;
3563 * enhanced index creation/display feature
3564 * feature to use a different charset for HTML than for MySQL
3565 * Czech language file updates
3567 - Christophe Gesch&eacute; from the &quot;MySQL Form Generator for PHPMyAdmin&quot;
3568 (http://sourceforge.net/projects/phpmysqlformgen/)
3569 * suggested the patch for multiple table printviews
3571 - Garvin Hicking &lt;me_at_supergarv.de&gt;
3572 * built the patch for vertical display of table rows
3573 * built the Javascript based Query window + SQL history
3574 * Improvement of column/db comments
3575 * (MIME)-Transformations for columns
3576 * Use custom alias names for Databases in left frame
3577 * hierarchical/nested table display
3578 * PDF-scratchboard for WYSIWYG-distribution of PDF relations
3579 * new icon sets
3580 * vertical display of column properties page
3581 * some bugfixes, features, support, german language additions
3583 - Yukihiro Kawada &lt;kawada_at_den.fujifilm.co.jp&gt;
3584 * japanese kanji encoding conversion feature
3586 - Piotr Roszatycki &lt;d3xter_at_users.sourceforge.net&gt; and Dan Wilson
3587 * the Cookie authentication mode
3589 - Axel Sander &lt;n8falke_at_users.sourceforge.net&gt;
3590 * table relation-links feature
3592 - Maxime Delorme &lt;delorme.maxime_at_free.fr&gt;
3593 * PDF schema output, thanks also to Olivier Plathey for the
3594 &quot;FPDF&quot; library (see http://www.fpdf.org/).
3596 - Olof Edlund &lt;olof.edlund_at_upright.se&gt;
3597 * SQL validator server
3599 - Ivan R. Lanin &lt;ivanlanin_at_users.sourceforge.net&gt;
3600 * phpMyAdmin logo
3602 - Mike Cochrane &lt;mike_at_graftonhall.co.nz&gt;
3603 * blowfish library from the Horde project
3605 And also to the following people who have contributed minor changes,
3606 enhancements, bugfixes or support for a new language since version 2.1.0:
3608 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
3609 P&eacute;ter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
3610 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kl&auml;ger,
3611 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
3612 Bernard M. Piller, Laurent Haas, &quot;Sakamoto&quot;, Yuval Sarna,
3613 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
3614 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
3615 Luís V., Martijn W. van der Lee,
3616 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
3617 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, &quot;Manuzhai&quot;.
3620 Original Credits of Version 2.1.0
3621 ---------------------------------
3623 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
3624 to create a web-based interface to MySQL using PHP3. Although I have not
3625 used any of his source-code, there are some concepts I've borrowed from
3626 him. phpMyAdmin was created because Peter told me he wasn't going to
3627 further develop his (great) tool.
3628 Thanks go to
3629 - Amalesh Kempf &lt;ak-lsml_at_living-source.com&gt; who contributed the
3630 code for the check when dropping a table or database. He also suggested
3631 that you should be able to specify the primary key on tbl_create.php3. To
3632 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
3633 well as a bug-report. Plus many smaller improvements.
3634 - Jan Legenhausen &lt;jan_at_nrw.net&gt;: He made many of the changes that
3635 were introduced in 1.3.0 (including quite significant ones like the
3636 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
3637 bug-fixes and help.
3638 - Marc Delisle &lt;DelislMa_at_CollegeSherbrooke.qc.ca&gt; made phpMyAdmin
3639 language-independent by outsourcing the strings to a separate file. He
3640 also contributed the French translation.
3641 - Alexandr Bravo &lt;abravo_at_hq.admiral.ru&gt; who contributed
3642 tbl_select.php3, a feature to display only some fields from a table.
3643 - Chris Jackson &lt;chrisj_at_ctel.net&gt; added support for MySQL
3644 functions in tbl_change.php3. He also added the
3645 &quot;Query by Example&quot; feature in 2.0.
3646 - Dave Walton &lt;walton_at_nordicdms.com&gt; added support for multiple
3647 servers and is a regular contributor for bug-fixes.
3648 - Gabriel Ash &lt;ga244_at_is8.nyu.edu&gt; contributed the random access
3649 features for 2.0.6.
3650 The following people have contributed minor changes, enhancements, bugfixes
3651 or support for a new language:
3652 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
3653 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
3654 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
3655 G. Wieggers.
3657 And thanks to everyone else who sent me email with suggestions, bug-reports
3658 and or just some feedback.
3659 </pre>
3663 <a name="bottom"></a><br />
3664 <p align="right">
3665 <a href="http://validator.w3.org/check/referer" target="w3c">
3666 <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" border="0" height="31" width="88" /></a>
3667 &nbsp;&nbsp;&nbsp;&nbsp;
3668 <a href="http://jigsaw.w3.org/css-validator/" target="w3c">
3669 <img src="http://www.w3.org/Icons/valid-css" alt="Valid CSS!" border="0" width="88" height="31" /></a>
3670 </p>
3672 </body>
3673 </html>