aspect ratio
[phpmyadmin/crack.git] / Documentation.html
blob2970bc3b27195d049cb706e2f51f6abbc67e290d
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.2-rc3 - 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.2-rc3 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 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['DefaultTabServer'] </b>string</dt>
1253 <dd>
1254 Defines the tab displayed by default on server view. Possible
1255 values: &quot;main.php3&quot; (recommended for multi-user setups),
1256 &quot;server_databases.php3&quot;, &quot;server_status.php3&quot;,
1257 &quot;server_variables.php3&quot;, &quot;server_privileges.php3&quot; or
1258 &quot;server_processlist.php3&quot;.
1259 <br /><br />
1260 </dd>
1262 <dt><b>$cfg['DefaultTabDatabase'] </b>string</dt>
1263 <dd>
1264 Defines the tab displayed by default on database view. Possible
1265 values: &quot;db_details_structure.php3&quot;,
1266 &quot;db_details.php3&quot; or &quot;db_search.php3&quot;.
1267 <br /><br />
1268 </dd>
1270 <dt><b>$cfg['DefaultTabTable'] </b>string</dt>
1271 <dd>
1272 Defines the tab displayed by default on table view. Possible
1273 values: &quot;tbl_properties_structure.php3&quot;,
1274 &quot;tbl_properties.php3&quot;, &quot;tbl_select.php3&quot; or
1275 &quot;tbl_change.php3&quot;.
1276 <br /><br />
1277 </dd>
1279 <dt><b>$cfg['MySQLManualBase']</b> string</dt>
1280 <dd>
1281 If set to an URL which points to the MySQL documentation (type depends
1282 on <tt>$cfg['MySQLManualType']</tt>), appropriate help links are
1283 generated.
1284 <br />
1285 See <a href="http://www.mysql.com/documentation/index.html">MySQL
1286 Documentation page</a> for more information about MySQL manuals and
1287 their types.
1288 <br /><br />
1289 </dd>
1291 <dt><b>$cfg['MySQLManualType']</b> string</dt>
1292 <dd>
1293 Type of MySQL documentation:
1294 <ul>
1295 <li>old - old style used in phpMyAdmin 2.3.0 and sooner</li>
1296 <li>searchable - &quot;Searchable, with user comments&quot;</li>
1297 <li>chapters - &quot;HTML, one page per chapter&quot;</li>
1298 <li>big - &quot;HTML, all on one page&quot;</li>
1299 <li>none - do not show documentation links</li>
1300 </ul>
1301 <br /><br />
1302 </dd>
1304 <dt><b>$cfg['DefaultLang'] </b>string</dt>
1305 <dd>
1306 Defines the default language to use, if not browser-defined or
1307 user-defined.<br />
1308 See the <i>select_lang.inc.php3</i> script to know the valid values for
1309 this setting.
1310 <br /><br />
1311 </dd>
1313 <dt><b>$cfg['Lang'] </b>string</dt>
1314 <dd>
1315 Force: always use this language (must be defined in the
1316 <i>select_lang.inc.php3</i> script).
1317 <br /><br />
1318 </dd>
1320 <dt><b>$cfg['DefaultCharset'] </b>string</dt>
1321 <dd>
1322 Default character set to use for recoding of MySQL queries. This must be
1323 enabled and it's described by <tt>$cfg['AllowAnywhereRecoding']</tt>
1324 option.<br />
1325 You can give here any character set which is in
1326 <tt>$cfg['AvailableCharsets']</tt> array and this is just default
1327 choice, user can select any of them.
1328 <br /><br />
1329 </dd>
1331 <dt><b>$cfg['AllowAnywhereRecoding'] </b>boolean</dt>
1332 <dd>
1333 Allow character set recoding of MySQL queries. You need recode or iconv
1334 support (compiled in or module) in PHP to allow MySQL queries recoding
1335 and used language file must have it enabled (by default only these
1336 which are in Unicode, just to avoid losing some characters).
1337 <br /><br />
1338 </dd>
1340 <dt><b>$cfg['RecodingEngine'] </b>string</dt>
1341 <dd>
1342 You can select here which functions will be used for character set
1343 conversion.
1344 Possible values are:<br />
1345 <ul>
1346 <li>auto - automatically use available one (first is tested
1347 iconv, then recode)</li>
1348 <li>iconv - use iconv or libiconv functions</li>
1349 <li>recode - use recode_string function</li>
1350 </ul>
1351 Default is auto.
1352 <br /><br />
1353 </dd>
1355 <dt><b>$cfg['IconvExtraParams'] </b>string</dt>
1356 <dd>
1357 Specify some parameters for iconv used in charset conversion. See
1359 href="http://www.gnu.org/software/libiconv/documentation/libiconv/iconv_open.3.html">iconv
1360 documentation</a> for details.
1361 <br /><br />
1362 </dd>
1364 <dt><b>$cfg['AvailableCharsets'] </b>array</dt>
1365 <dd>
1366 Available character sets for MySQL conversion. You can add your own (any of
1367 supported by recode/iconv) or remove these which you don't use.
1368 Character sets will be shown in same order as here listed, so if you
1369 frequently use some of these move them to the top.
1370 <br /><br />
1371 </dd>
1373 <dt><b>$cfg['GD2Available'] </b>string</dt>
1374 <dd>
1375 Specifies whether GD &gt;= 2 is available. If yes it can be used for
1376 MIME transformations.<br />
1377 Possible values are:<br />
1378 <ul>
1379 <li>
1380 auto - automatically detect, this is a bit expensive
1381 operation for php &lt; 4.3.0 so it is preffered to change this
1382 according to your server real possibilities
1383 </li>
1384 <li>yes - GD 2 functions can be used</li>
1385 <li>no - GD 2 function can not be used</li>
1386 </ul>
1387 Default is auto.
1388 <br /><br />
1389 </dd>
1391 <dt><b>$cfg['LeftWidth'] </b>integer</dt>
1392 <dd>
1393 Left frame width in pixel.
1394 <br /><br />
1395 </dd>
1397 <dt>
1398 <b>$cfg['LeftBgColor'] </b>string [HTML color]<br />
1399 <b>$cfg['RightBgColor'] </b>string [HTML color]
1400 </dt>
1401 <dd>
1402 The background colors (HTML) used for both the frames.
1403 <br /><br />
1404 </dd>
1406 <dt>
1407 <b>$cfg['RightBgImage'] </b>string
1408 </dt>
1409 <dd>
1410 The URI of the background image used for the right frame. It can be
1411 absolute as well as relative from your phpMyAdmin directory.
1412 </dd>
1414 <dt><b>$cfg['LeftPointerColor'] </b>string [HTML color]</dt>
1415 <dd>
1416 The color (HTML) used for the pointer in the left frame (does not work
1417 with Netscape 4).
1418 <br /><br />
1419 </dd>
1421 <dt><b>$cfg['Border'] </b>integer</dt>
1422 <dd>
1423 The size of a table's border.
1424 <br /><br />
1425 </dd>
1427 <dt><b>$cfg['ThBgcolor'] </b>string [HTML color]</dt>
1428 <dd>
1429 The color (HTML) used for table headers.
1430 <br /><br />
1431 </dd>
1433 <dt><b>$cfg['BgcolorOne'] </b>string [HTML color]</dt>
1434 <dd>
1435 The color (HTML) #1 for table rows.
1436 <br /><br />
1437 </dd>
1439 <dt><b>$cfg['BgcolorTwo'] </b>string [HTML color]</dt>
1440 <dd>
1441 The color (HTML) #2 for table rows.
1442 <br /><br />
1443 </dd>
1445 <dt>
1446 <b>$cfg['BrowsePointerColor'] </b>string [HTML color]<br />
1447 <b>$cfg['BrowseMarkerColor'] </b>string [HTML color]
1448 </dt>
1449 <dd>
1450 The colors (HTML) uses for the pointer and the marker in browse mode
1451 (does not work with Netscape 4).<br />
1452 The former feature highlights the row over which your mouse is passing
1453 and the latter lets you visually mark/unmark rows by clicking on
1454 them.<br />
1455 You can disable both of these features by emptying the respective
1456 directive.
1457 <br /><br />
1458 </dd>
1460 <dt>
1461 <b>$cfg['TextareaCols'] </b>integer<br />
1462 <b>$cfg['TextareaRows'] </b>integer<br />
1463 <b>$cfg['CharTextareaCols'] </b>integer<br />
1464 <b>$cfg['CharTextareaRows'] </b>integer
1465 </dt>
1466 <dd>
1467 Number of columns and rows for the textareas.<br />
1468 This value will be emphasized (*2) for SQL query textareas and (*1.25) for
1469 SQL textareas inside the query window.<br />
1470 The Char* values are used for CHAR and VARCHAR editing (if configured
1471 via $cfg['CharEditing']).
1472 <br /><br />
1473 </dd>
1475 <dt>
1476 <b>$cfg['LongtextDoubleTextarea'] </b>boolean<br />
1477 </dt>
1478 <dd>
1479 Defines whether textarea for LONGTEXT fields should have double size.
1480 <br /><br />
1481 </dd>
1483 <dt>
1484 <b>$cfg['TextareaAutoSelect'] </b>boolean<br />
1485 </dt>
1486 <dd>
1487 Defines if the whole textarea of the query box will be selected on
1488 click.
1489 <br /><br />
1490 </dd>
1492 <dt>
1493 <b>$cfg['CtrlArrowsMoving'] </b>boolean<br />
1494 </dt>
1495 <dd>
1496 Enable Ctrl+Arrows moving between fields when editing?
1497 <br /><br />
1498 </dd>
1500 <dt><b>$cfg['LimitChars'] </b>integer</dt>
1501 <dd>
1502 Maximal number of Chars showed in any non-numeric
1503 field on browse view. Can be turned off by a toggle button on the
1504 browse page.
1505 <br /><br />
1506 </dd>
1508 <dt>
1509 <b>$cfg['ModifyDeleteAtLeft'] </b>boolean<br />
1510 <b>$cfg['ModifyDeleteAtRight'] </b>boolean
1511 </dt>
1512 <dd>
1513 Defines the place where modify and delete links would be put when
1514 tables contents are displayed (you may have them displayed both at the
1515 left and at the right).
1516 &quot;Left&quot; and &quot;right&quot; are parsed as &quot;top&quot;
1517 and &quot;bottom&quot; with vertical display mode.
1518 <br /><br />
1519 </dd>
1521 <dt><b>$cfg['DefaultDisplay'] </b>string<br />
1522 <b>$cfg['HeaderFlipType'] </b>string
1523 </dt>
1524 <dd>
1525 There are 3 display modes: horizontal, horizontalflipped and vertical. Define
1526 which one is displayed by default. The first mode displays each row on a
1527 horizontal line, the second rotates the headers by 90 degrees, so you can use
1528 descriptive headers even though fields only contain small values and still
1529 print them out. The vertical mode sorts each row on a vertical lineup.<br /><br />
1530 The HeaderFlipType can be set to 'css' or 'faked'. When using 'css' the rotation
1531 of the header for horizontalflipped is done via CSS. If set to 'faked' PGP
1532 does the transformation for you, but of course this does not look as good as CSS.
1533 <br /><br />
1534 </dd>
1536 <dt><b>$cfg['DefaultPropDisplay'] </b>string</dt>
1537 <dd>
1538 When editing/creating new columns in a table all fields normally get lined up
1539 one field a line. (default: 'horizontal'). If you set this to 'vertical' you
1540 can have each field lined up vertically beneath each other. You can save up
1541 a lot of place on the horizontal direction and no longer have to scroll.
1542 <br /><br />
1543 </dd>
1545 <dt><b>$cfg['ShowBrowseComments'] </b>boolean<br />
1546 <b>$cfg['ShowPropertyComments'] </b>boolean<br />
1547 </dt>
1548 <dd>
1549 By setting the corresponding variable to TRUE you can enable the display of
1550 column comments in Browse or Property display. In browse mode, the comments
1551 are show inside the header. In property mode, comments are displayed using
1552 a CSS-formatted dashed-line below the name of the field. The comment is shown
1553 as a tool-tip for that field.
1554 <br /><br />
1555 </dd>
1557 <dt><b>$cfg['UploadDir'] </b>string</dt>
1558 <dd>
1559 The name of the directory, ending with a slash, where SQL files have
1560 been uploaded by other means than phpMyAdmin (for example, ftp).
1561 Those files are available under a drop-down box when you click the
1562 database name, then the SQL tab.
1563 <br /><br />
1564 Please note that the file names must have the suffix &quot;.sql&quot;.
1565 <br /><br />
1566 This feature is useful when your file is too big to be uploaded via
1567 HTTP, or when file uploads are disabled in PHP.
1568 <br /><br />
1569 Please note that if PHP is running in safe mode, this directory must
1570 be owned by the same user as the owner of the phpMyAdmin scripts.
1571 <br /><br />
1572 </dd>
1574 <dt><b>$cfg['SaveDir'] </b>string</dt>
1575 <dd>
1576 The name of the directory, ending with a slash, where dumps can
1577 be saved.
1578 <br /><br />
1579 Please note that the directory has to be writable for user running
1580 webserver.
1581 <br /><br />
1582 Please note that if PHP is running in safe mode, this directory must
1583 be owned by the same user as the owner of the phpMyAdmin scripts.
1584 <br /><br />
1585 </dd>
1587 <dt><b>$cfg['Export'] </b>array</dt>
1588 <dd>
1589 In this array are defined default parameters for export, names of
1590 items are simmilar to texts seen on export page, so you can easily
1591 identify what they mean.
1592 <br /><br />
1593 </dd>
1595 <dt><b>$cfg['RepeatCells'] </b>integer</dt>
1596 <dd>
1597 Repeat the headers every X cells, or 0 to deactivate.
1598 <br /><br />
1599 </dd>
1601 <dt><b>$cfg['QueryFrame'] </b>boolean<br />
1602 <b>$cfg['QueryFrameJS'] </b>boolean<br />
1603 <b>$cfg['QueryFrameDebug'] </b>boolean<br />
1604 <b>$cfg['QueryWindowWidth'] </b>integer<br />
1605 <b>$cfg['QueryWindowHeight'] </b>integer<br />
1606 <b>$cfg['QueryHistoryDB'] </b>boolean<br />
1607 <b>$cfg['QueryWindowDefTab'] </b>string<br />
1608 <b>$cfg['QueryHistoryMax'] </b>integer
1609 </dt>
1610 <dd>
1611 All those variables affect the new query frame/window. When $cfg['QueryFrame']
1612 is set to true a new frame is embedded on the left with a small area. Clicking
1613 on that results in opening a direct interface to enter SQL queries.<br /><br />
1614 When $cfg['QueryFrameJS'] is set to true, clicking on that link opens a new
1615 custom sized browser window ($cfg['QueryWindowWidth'], $cfg['QueryWindowWidth'] -
1616 both integers for the size in pixels). If set to false, clicking on the link
1617 only opens the SQL input in the mainframe.<br /><br />
1618 The usage of the JavaScript query window is recommended if you have a JavaScript
1619 enabled browser. Basic functions are used to exchange quite a few variables, so
1620 most 4th generation browsers should be capable to use that feature. It currently
1621 is only tested with Internet Explorer 6 and Mozilla 1.x.<br /><br />
1622 If $cfg['QueryHistoryDB'] is set to TRUE, all your Queries are logged to a table,
1623 which has to be created by you (see <a href="history">$cfg['Servers'][$i]['history']</a>).
1624 If set to FALSE, all your queries will be appended to the form, but only as long
1625 as your window is opened they remain saved.<br /><br />
1626 When using the JavaScript based query window, it will always get updated when you
1627 click on a new table/db to browse and will focus if you click on "Edit SQL" after
1628 using a query. You can suppress updating the query window by checking the box
1629 "Do not overwrite this query from outside the window" below the query textarea. Then
1630 you can browse tables/databases in the background without losing the contents of the
1631 textarea, so this is especially useful when composing a query with tables you first
1632 have to look in. The checkbox will get automatically checked whenever you change the
1633 contents of the textarea. Please uncheck the button whenever you definitely want the
1634 query window to get updated even though you have made alterations.<br /><br />
1635 If $cfg['QueryHistoryDB'] is set to TRUE you can specify the amount of saved
1636 history items using $cfg['QueryHistoryMax'].<br /><br />
1637 The query window also has a custom tabbed look to group the features. Using the
1638 variable $cfg['QueryWindowDefTab'] you can specify the default tab to be used
1639 when opening the query window. It can be set to either 'sql', 'files', 'history'
1640 or 'full'.<br /><br />
1641 The variable $cfg['QueryFrameDebug'] can be used by developers for easier future
1642 feature integration.
1643 <br /><br />
1644 </dd>
1646 <dt><b>$cfg['BrowseMIME'] </b>boolean</dt>
1647 <dd>
1648 Enable <a href="#transformations">MIME-transformations</a>.
1649 <br /><br />
1650 </dd>
1652 <dt><b>$cfg['MaxExactCount'] </b>integer</dt>
1653 <dd>
1654 Determines for how large tables phpMyAdmin should get exact row count by
1655 <code>SELECT COUNT</code>. If approximate row count is smaller than this
1656 value, <code>SELECT COUNT</code> will be used, otherwise only value
1657 returned by <code>SHOW TABLE STATUS</code>.
1658 <br /><br />
1659 </dd>
1661 <dt><b>$cfg['WYSIWYG-PDF'] </b>boolean</dt>
1662 <dd>
1663 Utilizes a WYSIWYG editing control to easily place elements of a PDF page.
1664 By clicking on the button 'toggle scratchboard' on the page where you
1665 edit x/y coordinates of those elements you can activate a scratchboard where
1666 all your elements are placed. By clicking on an element, you can move them
1667 around in the pre-defined area and the x/y coordinates will get updated
1668 dynamically. Likewise, when entering a new position directly into the
1669 input field, the new position in the scratchboard changes after your
1670 cursors leaves the input field.<br />
1671 You have to click on the 'OK'-button below the tables to save the new positions.
1672 If you want to place a new element, first add it to the table of elements and
1673 then you can drag the new element around.<br />
1674 By changing the paper size and the orientation you can change the size of the
1675 scratchboard as well. You can do so by just changing the dropdown field below,
1676 and the scratchboard will resize automatically, without interfering with the
1677 current placement of the elements.<br />
1678 If ever an element gets out of range you can either enlarge the paper size
1679 or click on the 'reset' button to place all elements below each other.<br />
1680 <b>NOTE:</b> You have to use a recent browser like IE6 or Mozilla to get this control
1681 to work. The basic Drag&amp;Drop script functionality was kindly borrowed from www.youngpup.net and
1682 is underlying so specific license.
1683 <br /><br />
1684 </dd>
1686 <dt><b>$cfg['SQP']['fmtType']</b> string [<tt>html</tt>|<tt>none</tt>]</dt>
1687 <dd>
1688 The main use of the new SQL Parser is to pretty-print SQL queries. By
1689 default we use HTML to format the query, but you can disable this by
1690 setting this variable to <tt>'none'</tt>
1691 <br /><br />
1692 </dd>
1694 <dt><b>$cfg['SQP']['fmtInd']</b> float<br />
1695 <b>$cfg['SQP']['fmtIndUnit']</b> string [<tt>em</tt>|<tt>px</tt>|<tt>pt</tt>|<tt>ex</tt>]</dt>
1696 <dd>
1697 For the pretty-printing of SQL queries, under some cases the part of a
1698 query inside a bracket is indented. By changing
1699 <tt>$cfg['SQP']['fmtInd']</tt> you can change the amount of this indent.
1700 <br />Related in purpose is <tt>$cfg['SQP']['fmtIndUnit']</tt> which
1701 specifies the units of the indent amount that you specified. This is
1702 used via stylesheets.
1703 <br /><br />
1704 </dd>
1706 <dt><b>$cfg['SQP']['fmtColor']</b> array of string tuples</dt>
1707 <dd>
1708 This array is used to define the colours for each type of element of
1709 the pretty-printed SQL queries. The tuple format is<br />
1710 <i>class</i> =&gt; [<i>HTML colour code</i> | <i>empty string</i>]<br />
1711 If you specify an empty string for the color of a class, it is ignored
1712 in creating the stylesheet.
1713 You should not alter the class names, only the colour strings.<br />
1714 <b>Class name key:</b><br />
1715 <ul>
1716 <li><b>comment</b> Applies to all comment sub-classes</li>
1717 <li><b>comment_mysql</b> Comments as <tt>"#...\n"</tt></li>
1718 <li><b>comment_ansi</b> Comments as <tt>"-- ...\n"</tt></li>
1719 <li><b>comment_c</b> Comments as <tt>"/*...*/"</tt></li>
1720 <li><b>digit</b> Applies to all digit sub-classes</li>
1721 <li><b>digit_hex</b> Hexadecimal numbers</li>
1722 <li><b>digit_integer</b> Integer numbers</li>
1723 <li><b>digit_float</b> Floating point numbers</li>
1724 <li><b>punct</b> Applies to all punctuation sub-classes</li>
1725 <li><b>punct_bracket_open_round</b> Opening brackets<tt>"("</tt></li>
1726 <li><b>punct_bracket_close_round</b> Closing brackets <tt>")"</tt></li>
1727 <li><b>punct_listsep</b> List item Separator <tt>","</tt></li>
1728 <li><b>punct_qualifier</b> Table/Column Qualifier <tt>"."</tt> </li>
1729 <li><b>punct_queryend</b> End of query marker <tt>";"</tt></li>
1730 <li><b>alpha</b> Applies to all alphabetic classes</li>
1731 <li><b>alpha_columnType</b> Identifiers matching a column type</li>
1732 <li><b>alpha_columnAttrib</b> Identifiers matching a database/table/column attribute</li>
1733 <li><b>alpha_functionName</b> Identifiers matching a MySQL function name</li>
1734 <li><b>alpha_reservedWord</b> Identifiers matching any other reserved word</li>
1735 <li><b>alpha_variable</b> Identifiers matching a SQL variable <tt>"@foo"</tt></li>
1736 <li><b>alpha_identifier</b> All other identifiers</li>
1737 <li><b>quote</b> Applies to all quotation mark classes</li>
1738 <li><b>quote_double</b> Double quotes <tt>"</tt></li>
1739 <li><b>quote_single</b> Single quotes <tt>'</tt></li>
1740 <li><b>quote_backtick</b> Backtick quotes <tt>`</tt></li>
1741 </ul><br />
1742 </dd>
1744 <dt><b>$cfg['SQLValidator']['use']</b> boolean</dt>
1745 <dd>
1746 phpMyAdmin now supports use of the <a href="http://developer.mimer.com/validator/index.htm">Mimer SQL Validator</a> service,
1747 as originally published on
1748 <a href="http://developers.slashdot.org/article.pl?sid=02/02/19/1720246">Slashdot</a>.
1749 <br />
1750 For help in setting up your system to use the service, see the
1751 <a href="#faqsqlvalidator">FAQ #6.14</a>.
1752 <br /><br />
1753 </dd>
1755 <dt><b>$cfg['SQLValidator']['username']</b> string<br />
1756 <b>$cfg['SQLValidator']['password']</b> string</dt>
1757 <dd>
1758 The SOAP service allows you to login with <tt>anonymous</tt>
1759 and any password, so we use those by default.. Instead, if
1760 you have an account with them, you can put your login details
1761 here, and it will be used in place of the anonymous login.
1762 <br /><br />
1763 </dd>
1765 <dt><b>$cfg['DBG']['enable']</b> boolean</dt>
1766 <dd>
1767 <b>DEVELOPERS ONLY!</b><br />
1768 Enable the DBG extension for debugging phpMyAdmin. Required for profiling
1769 the code.
1770 <br />
1771 For help in setting up your system to this, see the
1772 <a href="#developersdbg">Developers</a> section.
1773 </dd>
1775 <dt><b>$cfg['DBG']['profile']['enable']</b> boolean</dt>
1776 <dd>
1777 <b>DEVELOPERS ONLY!</b><br />
1778 Enable profiling support for phpMyAdmin. This will append a chunk of data
1779 to the end of every page displayed in the main window with profiling
1780 statistics for that page.<br />
1781 You may need need to increase the maximum execution time for this to
1782 complete successfully.
1783 </dd>
1785 <dt><b>$cfg['DBG']['profile']['threshold']</b> float (units in milliseconds)</dt>
1786 <dd>
1787 <b>DEVELOPERS ONLY!</b><br />
1788 When profiling data is displayed, this variable controls the threshold of
1789 display for any profiling data, based on the average time each time has
1790 taken. If it is over the threshold it is displayed, otherwise it is not
1791 displayed. This takes a value in milliseconds. In most cases you don't need
1792 to edit this.
1793 </dd>
1795 <dt><b>$cfg['ColumnTypes'] </b>array</dt>
1796 <dd>
1797 All possible types of a MySQL column. In most cases you don't need to
1798 edit this.
1799 <br /><br />
1800 </dd>
1802 <dt><b>$cfg['AttributeTypes'] </b>array</dt>
1803 <dd>
1804 Possible attributes for fields. In most cases you don't need to edit
1805 this.
1806 <br /><br />
1807 </dd>
1809 <dt><b>$cfg['Functions'] </b>array</dt>
1810 <dd>
1811 A list of functions MySQL supports. In most cases you don't need to
1812 edit this.
1813 <br /><br />
1814 </dd>
1816 </dl>
1818 <!-- TRANSFORMATIONS -->
1819 <a name="transformations"></a><br />
1820 <h2>Transformations</h2>
1823 <a href="#transformationsintro">Introduction</a> &nbsp;-&nbsp;
1824 <a href="#transformationshowto">Usage</a> &nbsp;-&nbsp;
1825 <a href="#transformationsfiles">File structure</a> &nbsp;-&nbsp;
1826 </p>
1828 <a name="transformationsintro"></a><br />
1829 <h3>[1. Introduction]</h3>
1831 <p>To enable transformations, you have to setup the column_info table and the proper
1832 directives. Please see the <a href="#config">Configuration section</a> on how to do so.</p>
1833 <br />
1835 <p>You can apply different transformations to the contents of each field. The
1836 transformation will take the content of each field and transform it with
1837 certain rules defined in the selected transformation.</p><br />
1839 <p>Say you have a field 'filename' which contains a filename. Normally you would see
1840 in phpMyAdmin only this filename. Using transformations you can transform that filename
1841 into a HTML link, so you can click inside of the phpMyAdmin structure on the field's
1842 link and will see the file displayed in a new browser window. Using transformation
1843 options you can also specify strings to append/prepend to a string or the format you
1844 want the output stored in.</p><br />
1846 <p>For a general overview of all available transformations and their options, you can
1847 consult your <i>&lt;www.your-host.com&gt;/&lt;your-install-dir&gt;/libraries/transformations/overview.php3</i>
1848 installation.</p>
1850 <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>
1852 <a name="transformationshowto"></a><br />
1853 <h3>[2. Usage]</h3>
1855 <p>Go to your tbl_properties.inc.php3 page (i.e. reached through clicking on the
1856 'properties' link for a table). There you will see three new fields at the end of the
1857 line. They are called 'MIME-type', 'Browser transformation' and 'Transformation options'.</p>
1858 <br />
1860 <ul>
1861 <li>The field 'MIME-type' is a dropdown field. You have the options to leave that field
1862 empty or to use 'auto' [this feature is not yet available]. Please note that
1863 transformations are inactive as long as no mime-type is selected.</li>
1865 <li>The field 'Browser transformation' is a drop-down field. You can choose from a
1866 hopefully growing amount of pre-defined transformations. See below for information on
1867 how to build your own transformation.<br />
1869 There are global transformations and mimetype-bound transformations. Global transformations
1870 can be used for any mimetype. They will take the mimetype, if necessary, into regard.
1871 Mimetype-bound transformations usually only operate on a certain mimetype. There are
1872 transformations which operate on the main mimetype (like 'image'), which will most likely
1873 take the subtype into regard, and those who only operate on a
1874 specific subtype (like 'image/jpeg').<br />
1876 You can use transformations on mimetypes for which the function was not defined for. There
1877 is no security check for you selected the right transformation, so take care of what the
1878 output will be like.</li>
1880 <li>The field 'Transformation options' is a free-type textfield. You have to enter
1881 transform-function specific options here. Usually the transforms can operate with default
1882 options, but it is generally a good idea to look up the overview to see which options are
1883 necessary.<br />
1885 Much like the ENUM/SET-Fields, you have to split up several options using the format
1886 'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
1887 parsed as an array, leaving the first value the first element in the array, and so
1888 forth.<br />
1890 If you want to specify a MIME character set you can define it in the transformation_options.
1891 You have to put that outside of the pre-defined options of the specific mime-transform,
1892 as the last value of the set. Use the format "'; charset=XXX'". If you use a transform,
1893 for which you can specify 2 options and you want to append a character set, enter "'first
1894 parameter','second parameter','charset=us-ascii'". You can, however use the defaults for
1895 the parameters: "'','','charset=us-ascii'".</li>
1896 </ul>
1898 <a name="transformationsfiles"></a><br />
1899 <h3>[3. File structure]</h3>
1901 <p>All mimetypes and their transformations are defined through single files in
1902 the directory 'libraries/transformations/'.</p><br />
1904 <p>They are stored in files to ease up customization and easy adding of new
1905 transformations.</p><br />
1907 <p>Because the user cannot enter own mimetypes, it is kept sure that transformations
1908 always work. It makes no sense to apply a transformation to a mimetype, the
1909 transform-function doesn't know to handle.</p><br />
1911 <p>One can, however, use empty mime-types and global transformations which should work
1912 for many mimetypes. You can also use transforms on a different mimetype they where built
1913 for, but pay attention to option usage as well as what the transformation does to your
1914 field.</p><br />
1916 <p>There is a basic file called 'global.inc.php3'. This function can be included by
1917 any other transform function and provides some basic functions.</p><br />
1919 <p>There are 5 possible file names:</p>
1921 <ol>
1922 <li>A mimetype+subtype transform:<br /><br />
1924 [mimetype]_[subtype]__[transform].inc.php3<br /><br />
1926 Please not that mimetype and subtype are separated via '_', which shall not be
1927 contained in their names. The transform function/filename may contain only
1928 characters which cause no problems in the file system as well as the PHP function
1929 naming convention.<br /><br />
1931 The transform function will the be called 'PMA_transform_[mimetype]_[subtype]__[transform]()'.<br /><br />
1933 <b>Example:</b><br /><br />
1935 text_html__formatted.inc.php3<br />
1936 PMA_transform_text_html__formatted()</li>
1938 <li>A mimetype (w/o subtype) transform:<br /><br />
1940 [mimetype]__[transform].inc.php3<br /><br />
1942 Please note that there are no single '_' characters.
1943 The transform function/filename may contain only characters which cause no problems
1944 in the file system as well as the PHP function naming convention.<br /><br />
1946 The transform function will the be called 'PMA_transform_[mimetype]__[transform]()'.<br /><br />
1948 <b>Example:</b><br /><br />
1950 text__formatted.inc.php3<br />
1951 PMA_transform_text__formatted()</li>
1953 <li>A mimetype+subtype without specific transform function<br /><br />
1955 [mimetype]_[subtype].inc.php3<br /><br />
1957 Please note that there are no '__' characters in the filename. Do not use special
1958 characters in the filename causing problems with the file system.<br /><br />
1960 No transformation function is defined in the file itself.<br /><br />
1962 <b>Example:</b><br /><br />
1964 text_plain.inc.php3<br />
1965 (No function)</li>
1967 <li>A mimetype (w/o subtype) without specific transform function<br /><br />
1969 [mimetype].inc.php3<br /><br />
1971 Please note that there are no '_' characters in the filename. Do not use special
1972 characters in the filename causing problems with the file system.<br /><br />
1974 No transformation function is defined in the file itself.<br /><br />
1976 <b>Example:</b><br /><br />
1978 text.inc.php3<br />
1979 (No function)</li>
1981 <li>A global transform function with no specific mimetype<br /><br />
1983 global__[transform].inc.php3<br /><br />
1985 The transform function will the be called 'PMA_transform_global__[transform]()'.<br /><br />
1987 <b>Example:</b><br /><br />
1989 global__formatted<br />
1990 PMA_transform_global__formatted()</li>
1991 </ol>
1993 <br />
1994 <p>So generally use '_' to split up mimetype and subtype, and '__' to provide a
1995 transform function.</p><br />
1997 <p>All filenames containing no '__' in themselves are not shown as valid transform
1998 functions in the dropdown.</p><br />
2000 <p>Please see the libraries/transformations/TEMPLATE file for adding your own transform
2001 function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
2002 without a transform function. Also note the introduction of a function description in
2003 the language files. For each function a $strTransformation_[filename without .inc.php3]
2004 has to exist.</p><br />
2006 <p>You can use the template generator to generate new functions and entries in the
2007 language file.</p><br />
2009 <p>To create a new transform function please see libraries/transformations/template_generator.sh.
2010 To create a new, empty mimetype please see libraries/transformations/template_generator_mimetype.sh.</p><br />
2012 <!-- FAQ -->
2013 <a name="faq"></a><br />
2014 <h2>FAQ - Frequently Asked Questions</h2>
2017 <a href="#faqserver">Server</a> &nbsp;-&nbsp;
2018 <a href="#faqconfig">Configuration</a> &nbsp;-&nbsp;
2019 <a href="#faqlimitations">Limitations</a> &nbsp;-&nbsp;
2020 <a href="#faqmultiuser">Multi-user</a> &nbsp;-&nbsp;
2021 <a href="#faqbrowsers">Browsers</a> &nbsp;-&nbsp;
2022 <a href="#faqusing">Usage tips</a> &nbsp;-&nbsp;
2023 <a href="#faqproject">Project</a> &nbsp;-&nbsp;
2024 <a href="#faqsecurity">Security</a>
2025 </p>
2027 <p><br />
2028 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.
2029 </p>
2031 <a name="faqserver"></a><br />
2032 <h3>[1. Server]</h3>
2034 <h4>
2035 [1.1] I'm running PHP 4+ and my server is crashing each time a specific
2036 action is required or phpMyAdmin sends a blank page or a page full of
2037 cryptic characters to my browser, what can I do?
2038 </h4>
2040 There are some known PHP bugs with output buffering and compression.<br />
2041 Try to set the <tt>$cfg['OBGzip']</tt> directive to <tt>FALSE</tt> in your
2042 <i>config.inc.php or .php3</i> file and the
2043 <tt>zlib.output_compression</tt> directive to <tt>Off</tt> in your php
2044 configuration file.<br />
2045 Furthermore, we know about such problems connected to the release
2046 candidates of PHP 4.2.0 (tested with PHP 4.2.0 RC1 to RC4) together with
2047 MS Internet Explorer. Please upgrade to the release version PHP 4.2.0.
2048 </p>
2050 <h4>
2051 [1.2] My Apache server crashes when using phpMyAdmin.
2052 </h4>
2054 You should first try the latest versions of Apache (and possibly MySQL).
2055 <br />
2056 See also the other FAQ entry about PHP bugs with output buffering.
2057 <br />
2058 If your server keeps crashing, please ask for help in the various
2059 Apache support groups.
2060 </p>
2062 <h4>
2063 [1.3] I'm running phpMyAdmin with "cookie" authentication mode under
2064 PHP 4.2.0 or 4.2.1 loaded as an Apache 2+ module but can't enter the
2065 script: I'm always displayed the login screen.
2066 </h4>
2068 This is a known PHP bug (see this
2069 <a href="http://bugs.php.net/bug.php?id=16626">bug report</a>) from the
2070 official PHP bug database. It means there is and won't be any phpMyAdmin
2071 fix against it because there is no way to code a fix.
2072 </p>
2074 <h4>
2075 [1.4] Using phpMyAdmin on IIS, I'm displayed the error message:
2076 &quot;The specified CGI application misbehaved by not returning a
2077 complete set of HTTP headers...&quot;.
2078 </h4>
2080 You just forgot to read the <i>install.txt</i> file from the php
2081 distribution. Have a look at the last message in this
2082 <a href="http://bugs.php.net/bug.php?id=12061">bug report</a> from the
2083 official PHP bug database.
2084 </p>
2086 <h4>
2087 [1.5] Using phpMyAdmin on IIS, I'm facing crashes and/or many error
2088 messages with the HTTP or advanced authentication mode.
2089 </h4>
2091 This is a known problem with the PHP ISAPI filter: it's not so stable. For
2092 some more information and complete testings see the messages posted by
2093 Andr&eacute; B. aka &quot;djdeluxe76&quot; in
2094 <a href="http://www.phpwizard.net/phorum/read.php?f=1&amp;i=6624&amp;t=6300">this&nbsp;thread</a>
2095 from the phpWizard forum.<br />
2096 Please use instead the cookie authentication mode.
2097 </p>
2099 <h4>
2100 [1.6] I can't use phpMyAdmin on PWS: nothing is displayed!</h4>
2102 This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
2103 time there is no better fix): remove or comment the <tt>DOCTYPE</tt>
2104 declarations (2 lines) from the scripts <i>header.inc.php3</i>,
2105 <i>header_printview.inc.php3</i>, <i>index.php3</i>, <i>left.php3</i> and
2106 <i>libraries/common.lib.php3</i>.
2107 </p>
2109 <h4>
2110 [1.7] How can I GZip or Bzip a dump or a CSV export. It does not seem to
2111 work.
2112 </h4>
2114 These features are based on the <tt>gzencode()</tt> and
2115 <tt>bzcompress()</tt> PHP functions to be more independent of the platform
2116 (Unix/Windows, Safe Mode or not, and so on).
2117 So, you must have PHP4&nbsp;>=&nbsp;4.0.4 and Zlib/Bzip2 support
2118 (<tt>--with-zlib</tt> and <tt>--with-bz2</tt>).<br />
2119 We faced PHP crashes when trying to download a dump with MS Internet
2120 Explorer when phpMyAdmin is run with a release candidate of PHP 4.2.0. In
2121 this case you should switch to the release version of PHP 4.2.0.
2122 </p>
2124 <h4>
2125 [1.8] I cannot insert a text file in a table, and I get an error about
2126 safe mode being in effect.
2127 </h4>
2129 Your uploaded file is saved by PHP in the &quot;upload dir&quot;, as
2130 defined in <i>php.ini</i> by the variable <tt>upload_tmp_dir</tt> (usually
2131 the system default is <i>/tmp</i>).
2132 <br />
2133 We recommend the following setup for Apache servers running in safe mode,
2134 to enable uploads of files while being reasonably secure:
2135 </p>
2136 <ul>
2137 <li>create a separate directory for uploads:
2138 <tt>mkdir /tmp/php</tt></li>
2139 <li>give ownership to the Apache server's user.group:
2140 <tt>chown apache.apache /tmp/php</tt></li>
2141 <li>give proper permission: <tt>chmod 600 /tmp/php</tt></li>
2142 <li>put <tt>upload_tmp_dir = /tmp/php</tt> in php.ini</li>
2143 <li>restart Apache</li>
2144 </ul>
2146 <h4>
2147 [1.9] I'm having troubles when uploading files. In general file uploads
2148 don't work on my system and uploaded files have a <tt>Content-Type:</tt>
2149 header in the first line.
2150 </h4>
2152 It's not really phpMyAdmin related but RedHat 7.0. You have a RedHat 7.0
2153 and you updated your PHP RPM to php-4.0.4pl1-3.i386.rpm, didn't you?
2154 <br />
2155 So the problem is that this package has a serious bug that was corrected
2156 ages ago in PHP (2001-01-28: see
2157 <a href="http://www.php.net/bugs.php?id=8966">PHP's bug tracking system</a>
2158 for more details). The problem is that the bugged package is still
2159 available though it was corrected (see
2160 <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=24933">RedHat's BugZilla</a>
2161 for more details).
2162 <br />
2163 So please download
2164 <a href="http://www.redhat.com/swr/i386/php-4.0.4pl1-9.i386.html">the fixed package (4.0.4pl1-9)</a>
2165 and the problem should go away.
2166 <br />
2167 And that fixes the \r\n problem with file uploads!
2168 </p>
2170 <h4>
2171 [1.10] I'm having troubles when uploading files with phpMyAdmin running
2172 on a secure server. My browser is Internet Explorer and I'm using the
2173 Apache server.
2174 </h4>
2176 As suggested by &quot;Rob M&quot; in the phpWizard forum, add this line to
2177 your <i>httpd.conf</i>:<br />
2178 &nbsp;&nbsp;&nbsp;&nbsp;<tt>SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown</tt><br />
2179 It seems to clear up many problems between Internet Explorer and SSL.
2180 </p>
2182 <h4>
2183 [1.11] I get an 'open_basedir restriction' while uploading a file from
2184 the query box.
2185 </h4>
2187 Since version 2.2.4, phpMyAdmin supports servers with open_basedir
2188 restrictions. Assuming that the restriction allows you to open files in the
2189 current directory ('.'), all you have to do is create a 'tmp' directory
2190 under the phpMyAdmin install directory, with permissions 777 and the same
2191 owner as the owner of your phpMyAdmin directory. The uploaded files will
2192 be moved there, and after execution of your SQL commands, removed.
2193 </p>
2195 <h4>
2196 [1.12] I have lost my MySQL root password, what can I do?
2197 </h4>
2199 The MySQL manual explains how to
2200 <a href="http://www.mysql.com/doc/R/e/Resetting_permissions.html">
2201 reset the permissions</a>.
2202 </p>
2204 <h4>
2205 [1.13] I get an error 'No SQL query' when trying to execute a bookmark.
2206 </h4>
2208 If PHP does not have read/write access to its <tt>upload_tmp_dir</tt>, it
2209 cannot access the uploaded query.
2210 </p>
2212 <h4>
2213 [1.14] I get an error 'No SQL query' when trying to submit a query from
2214 the convenient text area.
2215 </h4>
2217 Check the <tt>post_max_size</tt> directive from your PHP configuration file
2218 and try to increase it.
2219 </p>
2221 <h4>
2222 [1.15] I have problems with <i>mysql.user</i> field names.
2223 </h4>
2225 In older MySQL versions, the <tt>User</tt> and <tt>Password</tt> fields
2226 were named <tt>user</tt> and <tt>password</tt>. Please modify your field
2227 names to align with current standards.
2228 </p>
2229 <h4>
2230 [1.16] I cannot upload big dump files (memory, http or timeout problems).
2231 </h4>
2233 The first things to check (or ask your host provider to check) are the
2234 values of <tt>upload_max_filesize</tt>, <tt>memory_limit</tt> and
2235 <tt>post_max_size</tt> in the <i>php.ini</i> configuration file.
2236 <br />
2237 All of these three settings limit the maximum size of data that can be
2238 submitted and handled by PHP. One user also said that post_max_size
2239 and memory_limit need to be larger than upload_max_filesize.
2240 <br />
2241 If you get a timeout problem, look at the <tt>$cfg['UploadDir']</tt>
2242 feature.
2243 </p>
2245 <h4>
2246 [1.17] Does phpMyAdmin support MySQL&nbsp;4.1 and 5.0?
2247 </h4>
2249 phpMyAdmin provides limited support for MySQL&nbsp;4.1. That means that you
2250 can neither assign character sets to a table or field on create nor change
2251 the (automatically) assigned character set.<br />
2252 When compiling php, we strongly recommend that you manually link it to a
2253 MySQL&nbsp;4.1 client library since the one that is currently bundled with
2254 php is rather old and might cause problems.<br />
2255 MySQL 5 is not yet supported.
2256 </p>
2258 <h4>
2259 [1.18] I'm running MySQL&nbsp;&lt;=&nbsp;4.0.1 having
2260 <tt>lower_case_table_names</tt> set to 1. If I create a new table with a
2261 capital letter in its name it is changed to lowercase as it should. But
2262 if I try to DROP this table MySQL is unable to find the corresponding
2263 file.
2264 </h4>
2266 This is a bug of MySQL&nbsp;&lt;=&nbsp;4.0.1. Please upgrade to at least
2267 MySQL&nbsp;4.0.2 or turn off your <tt>lower_case_table_names</tt>
2268 directive.
2269 </p>
2271 <h4>
2272 [1.19] I can't run the &quot;display relations&quot; feature because the
2273 script seems not to know the font face I'm using!
2274 </h4>
2276 The &quot;FPDF&quot; library we're using for this feature requires some
2277 special files to use font faces.<br />
2278 Please refers to the
2279 <a href="http://www.fpdf.org/" target="_blank">FPDF manual</a> to build
2280 these files.
2281 </p>
2283 <a name="faqmysql"></a><br />
2284 <h4>
2285 [1.20] I receive the error &quot;cannot load MySQL extension, please
2286 check PHP Configuration&quot;.
2287 </h4>
2289 To connect to a MySQL server, PHP needs a set of MySQL functions called
2290 &quot;MySQL extension&quot;.
2291 This extension may be part of the PHP server (compiled-in), otherwise it
2292 needs to be loaded dynamically. Its name is probably <i>mysql.so</i> or
2293 <i>mysql.dll</i>. phpMyAdmin tried to load the extension but failed.
2294 <br /><br />
2295 Usually, the problem is solved by installing a software package called
2296 &quot;PHP-MySQL&quot; or something similar.
2297 </p>
2299 <h4>
2300 [1.21] I am running the CGI version of PHP under Unix, and I cannot
2301 login using cookie auth.
2302 </h4>
2304 In <i>php.ini</i>, set <tt>mysql.max_links</tt> higher than 1.
2305 </p>
2307 <h4>
2308 [1.22] I don't see the &quot;Location of text file&quot; field, so
2309 I cannot upload.
2310 </h4>
2312 This is most likely because in <i>php.ini</i>, your <tt>file_uploads</tt>
2313 parameter is not set to &quot;on&quot;.
2314 </p>
2316 <h4>
2317 [1.23] I'm running MySQL on a Win32 machine. Each time I create a new
2318 table the table and field names are changed to lowercase!
2319 </h4>
2321 This happens because the MySQL directive <tt>lower_case_table_names</tt>
2322 defaults to 1 (<tt>ON</tt>) in the Win32 version of MySQL. You can change
2323 this behavior by simply changing the directive to 0 (<tt>OFF</tt>):<br />
2324 Just edit your <tt>my.ini</tt> file that should be located in your Windows
2325 directory and add the following line to the group [mysqld]:<br />
2326 <tt>set-variable = lower_case_table_names=0</tt><br />
2327 Next, save the file and restart the MySQL service. You can always check the
2328 value of this directive using the query<br />
2329 <tt>SHOW VARIABLES LIKE 'lower_case_table_names';</tt>
2330 </p>
2332 <h4>
2333 [1.24] Some characters are being truncated in my queries, or I get
2334 characters randomly added. I am running PHP 4.2.3.
2335 </h4>
2337 This is a
2338 <a href="http://bugs.php.net/bug.php?id=19404">PHP 4.2.3 bug</a>.
2339 </p>
2341 <h4>
2342 [1.25] I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
2343 and I get problems, such as undefined variables when I run a SQL query.
2344 </h4>
2346 A tip from Jose Fandos: put a comment on the following two lines
2347 in httpd.conf, like this:<br />
2348 <tt># mod_gzip_item_include file \.php$</tt><br />
2349 <tt># mod_gzip_item_include mime "application/x-httpd-php.*"</tt><br />
2350 as this version of mod_gzip on Apache (Windows) has problems handling
2351 PHP scripts. Of course you have to restart Apache.
2352 </p>
2354 <h4>
2355 [1.26] I just installed phpMyAdmin in my document root of IIS but
2356 I get the error &quot;No input file specified&quot; when trying to
2357 run phpMyAdmin.
2358 </h4>
2360 This is a permission problem. Right-click on the phpmyadmin folder
2361 and choose properties. Under the tab Security, click on &quot;Add&quot;
2362 and select the user &quot;IUSER_machine&quot; from the list. Now set his
2363 permissions and it should work.
2364 </p>
2366 <h4>
2367 [1.27] I get empty page when I want to view huge page (eg.
2368 db_details_structure.php3 with plenty of dabases).
2369 </h4>
2371 This is a <a href="http://bugs.php.net/21079">PHP bug</a> that occur when
2372 GZIP output buffering enabled. If you turn off it (by <code>$cfg['OBGzip']
2373 = FALSE</code> in config.inc.php3), it should work. This bug will be fixed
2374 in PHP 5.0.0.
2375 </p>
2377 <h4>
2378 [1.28] My MySQL server sometimes refuses queries and returns the message
2379 'Errorcode: 13'. What does this mean?
2380 </h4>
2382 This can happen due to a MySQL bug when having database / table names with
2383 upper case characters although <tt>lower_case_table_names</tt> is set to 1.
2384 To fix this, turn off this directive, convert all database and table names
2385 to lower case and turn it on again. Alternatively, there's a bug-fix
2386 available starting with MySQL&nbsp;3.23.56 / 4.0.11-gamma.
2387 </p>
2389 <a name="faq-1-29"></a>
2390 <h4>
2391 [1.29] When I create a table or modify a field, I get an error
2392 and the fields are duplicated.
2393 </h4>
2395 It is possible to configure Apache in such a way that PHP has problems
2396 interpreting .php files.
2397 <br /><br />
2398 The problems occur when two different (and conflicting) set of directives
2399 are used:
2400 <br /><br />
2401 <tt>
2402 SetOutputFilter PHP<br />
2403 SetInputFilter PHP<br />
2404 </tt>
2405 &amp;
2406 <br />
2407 <tt>
2408 AddType application/x-httpd-php .php
2409 </tt>
2410 <br /><br />
2411 In the case we saw, one set of directives was in <tt>httpd.conf</tt>, while
2412 the other set was in <tt>php.conf</tt>.<br />
2413 The recommended way is with <tt>AddType</tt>, so just comment out
2414 the first set of lines and restart Apache:
2415 <br /><br />
2416 <tt><b>
2417 #SetOutputFilter PHP<br />
2418 #SetInputFilter PHP<br /></b>
2419 </tt>
2420 </p>
2422 <a name="faqconfig"></a><br />
2423 <h3>[2. Configuration]</h3>
2425 <h4>
2426 [2.1] The error message &quot;Warning: Cannot add header information -
2427 headers already sent by ...&quot; is displayed, what's the problem?
2428 </h4>
2430 Edit your <i>config.inc.php or .php3</i> file and ensure there is nothing
2431 (I.E. no blank lines, no spaces, no characters...) neither before the
2432 <tt>&lt;?php</tt> tag at the beginning, neither after the <tt>?&gt;</tt>
2433 tag at the end.
2434 </p>
2436 <h4>
2437 [2.2] phpMyAdmin can't connect to MySQL. What's wrong?
2438 </h4>
2440 Either there is an error with your PHP setup or your username/password is
2441 wrong. Try to make a small script which uses mysql_connect and see if it
2442 works. If it doesn't, it may be you haven't even compiled MySQL support
2443 into PHP.
2444 </p>
2446 <h4>
2447 [2.3] The error message &quot;Warning: MySQL Connection Failed: Can't
2448 connect to local MySQL server through socket '/tmp/mysql.sock'
2449 (111)...&quot; is displayed. What can I do?
2450 </h4>
2451 <p><br />
2452 For RedHat users, Harald Legner suggests this on the mailing list:
2453 <br /><br />
2454 On my RedHat-Box the socket of MySQL is <i>/var/lib/mysql/mysql.sock</i>.
2455 In your php.ini you will find a line
2456 <br />
2457 &nbsp;&nbsp;&nbsp;&nbsp;<tt>mysql.default_socket = /tmp/mysql.sock</tt>
2458 <br />
2459 change it to
2460 <br />
2461 &nbsp;&nbsp;&nbsp;&nbsp;<tt>mysql.default_socket = /var/lib/mysql/mysql.sock</tt>
2462 <br />
2463 Then restart apache and it will work.
2464 <br /><br />
2465 Here is a fix suggested by Brad Ummer in the phpwizard forum:
2466 </p>
2467 <ul>
2468 <li>
2469 First, you need to determine what socket is being used by MySQL.
2470 <br />
2471 To do this, telnet to your server and go to the MySQL bin directory. In
2472 this directory there should be a file named <i>mysqladmin</i>. Type
2473 <tt>./mysqladmin variables</tt>, and this should give you a bunch of
2474 info about your MySQL server, including the socket
2475 (<i>/tmp/mysql.sock</i>, for example).
2476 </li>
2477 <li>
2478 Then, you need to tell PHP to use this socket.<br />Assuming you are
2479 using PHP 3.0.10 or better, you can specify the socket to use when you
2480 open the connection. To do this in phpMyAdmin, you need to complete the
2481 socket information in the config.inc.php3.<br />
2482 For example:
2483 <tt>$cfg['Servers'][$i]['socket']&nbsp;=&nbsp;'/tmp/mysql.sock';</tt><br /><br />
2484 Please also make sure that the permissions of this file allow to be readable
2485 by your webserver (i.e. '0755').
2486 </li>
2487 </ul>
2489 Have also a look at the
2490 <a href="http://www.mysql.com/doc/C/a/Can_not_connect_to_server.html" target="_blank">
2491 corresponding section of the MySQL documentation</a>.
2492 </p>
2494 <h4>
2495 [2.4] Nothing is displayed by my browser when I try to run phpMyAdmin,
2496 what can I do?
2497 </h4>
2499 Try to set the <tt>$cfg['OBGZip']</tt> directive to <tt>FALSE</tt> in the
2500 phpMyAdmin configuration file. It helps sometime.<br />
2501 Also have a look at your PHP version number: if it contains
2502 &quot;4.0b...&quot; it means you're running a beta version of PHP. That's
2503 not a so good idea, please upgrade to a plain revision.
2504 </p>
2506 <h4>
2507 [2.5] Each time I want to insert or change a record or drop a database
2508 or a table, an error 404 (page not found) is displayed or, with HTTP or
2509 cookie authentication, I'm asked to login again. What's wrong?
2510 </h4>
2512 Check the value you set for the <tt>$cfg['PmaAbsoluteUri']</tt> directive
2513 in the phpMyAdmin configuration file.
2514 </p>
2516 <h4>
2517 [2.6] I get an &quot;Access denied for user: 'root@localhost' (Using
2518 password: YES)&quot;-error when trying to access a MySQL-Server on a
2519 host which is port-forwarded for my localhost
2520 </h4>
2522 When you are using a port on your localhost, which you redirect via
2523 port-forwarding to another host, MySQL is not resolving the localhost
2524 as expected.<br />
2525 Erik Wasser explains: The solution is: if your host is &quot;localhost&quot;
2526 MySQL (the commandline tool 'mysql' as well) always tries to use the socket
2527 connection for speeding up things. And that doesn't work in this configuration
2528 with port forwarding.<br />
2529 If you enter "127.0.0.1" as hostname, everything is right and MySQL uses the
2530 TCP connection.
2531 </p>
2534 <a name="faqlimitations"></a><br />
2535 <h3>[3. Known limitations]</h3>
2536 <a name="login_bug"></a><br />
2537 <h4>
2538 [3.1] When using HTTP authentication, an user who logged out can not
2539 relogin in with the same nick.
2540 </h4>
2542 This is related to the authentication mechanism (protocol) used by
2543 phpMyAdmin. We plan to change it as soon as we may find enough free time
2544 to do it, but you can bypass this problem: just close all the opened
2545 browser windows and then go back to phpMyAdmin. You should be able to
2546 log in again.
2547 </p>
2549 <h4>
2550 [3.2] When dumping a large table in compressed mode, I get a memory
2551 limit error or a time limit error.
2552 </h4>
2554 As of version 2.2.4, we build the compressed dump in memory, so large
2555 tables dumps may hang. The only alternative we can think about (using
2556 system calls to mysqldump then gzip or bzip2) would not be applicable in
2557 environments where PHP is in safe mode: access to system programs is
2558 is limited by the system administrator, and time limit is enforced.
2559 </p>
2561 <h4>
2562 [3.3] With InnoDB tables, I lose foreign key relationships when I rename
2563 or alter a table.
2564 </h4>
2566 This seems to be a InnoDB bug (fixed in MySQL 3.23.50?). However, keep in
2567 mind that phpMyAdmin as of version 2.3.0 does not support InnoDB.
2568 </p>
2570 <h4>
2571 [3.4] I am unable to import dumps I created with the mysqldump tool
2572 bundled with the MySQL server distribution.
2573 </h4>
2575 The problem is that mysqldump creates invalid comments like this:
2576 </p>
2577 <pre>
2578 -- MySQL dump 8.22
2580 -- Host: localhost Database: database
2581 ---------------------------------------------------------
2582 -- Server version 3.23.54
2583 </pre>
2585 The invalid part of the code is the horizontal line made of dashes that
2586 appears once in every dump created with mysqldump. If you want to run your
2587 dump you have to turn it into valid MySQL. This means, you have to add a
2588 whitespace after the first to dashes of the line or add a # before it:
2589 <br />
2590 <code>
2591 -- -------------------------------------------------------<br />
2592 </code>
2593 or<br />
2594 <code>
2595 #---------------------------------------------------------
2596 </code>
2597 </p>
2599 <h4>
2600 [3.3] When using nested folders ($cfg['LeftFrameTableSeparator']) there
2601 are some multiple hierarchies displayed in a wrong manner?!
2602 </h4>
2604 Please note that you should not use the seperating string multiple times
2605 without any characters between them, or at the beginning/end of your table
2606 name. If you have to, think about using another TableSeparator or disabling
2607 that feature
2608 </p>
2610 <a name="faqmultiuser"></a><br />
2611 <h3>[4. ISPs, multi-user installations ]</h3>
2613 <h4>
2614 [4.1] I'm an ISP. Can I setup one central copy of phpMyAdmin or do I
2615 need to install it for each customer.
2616 </h4>
2618 Since version 2.0.3, you can setup a central copy of phpMyAdmin for all
2619 your users. The development of this feature was kindly sponsored by
2620 NetCologne GmbH.
2621 This requires a properly setup MySQL user management and phpMyAdmin
2622 HTTP or cookie authentication. See the install section on
2623 &quot;Using HTTP authentication&quot;.
2624 </p>
2626 <h4>
2627 [4.2] What's the preferred way of making phpMyAdmin secure against evil
2628 access.
2629 </h4>
2631 This depends on your system.<br />
2632 If you're running a server which cannot be accessed by other people, it's
2633 sufficient to use the directory protection bundled with your webserver
2634 (with Apache you can use <i>.htaccess</i> files, for example).<br />
2635 If other people have telnet access to your server, you should use
2636 phpMyAdmin's HTTP authentication feature.
2637 <br /><br />
2638 Suggestions:
2639 </p>
2640 <ul>
2641 <li>
2642 Your <i>config.inc.php3</i> file should be <tt>chmod 660</tt>.
2643 </li>
2644 <li>
2645 All your phpMyAdmin files should be chown phpmy.apache, where phpmy
2646 is a user whose password is only known to you, and apache is the
2647 group under which Apache runs.
2648 </li>
2649 <li>
2650 You should use PHP safe mode, to protect from other users that try
2651 to include your <i>config.inc.php3</i> in their scripts.
2652 </li>
2653 </ul>
2655 <h4>
2656 [4.3] I get errors about not being able to include a file in
2657 <i>/lang</i> or in <i>/libraries</i>.
2658 </h4>
2660 Check <i>php.ini</i>, or ask your sysadmin to check it. The
2661 <tt>include_path</tt> must contain &quot;.&quot; somewhere in it, and
2662 <tt>open_basedir</tt>, if used, must contain &quot;.&quot; and
2663 &quot;./lang&quot; to allow normal operation of phpMyAdmin.
2664 </p>
2665 <h4>
2666 [4.4] phpMyAdmin always gives &quot;Access denied&quot; when using HTTP
2667 authentication.
2668 </h4>
2670 This could happen for several reasons:
2671 </p>
2672 <ul>
2673 <li>
2674 <tt>$cfg['Servers'][$i]['controluser']</tt> and/or
2675 <tt>$cfg['Servers'][$i]['controlpass']</tt> are wrong.
2676 </li>
2677 <li>
2678 The username/password you specify in the login-dialog are invalid.
2679 </li>
2680 <li>
2681 You have already setup a security mechanism for the
2682 phpMyAdmin-directory, eg. a .htaccess file. This would interfere with
2683 phpMyAdmin's authentication, so remove it.
2684 </li>
2685 </ul>
2687 <h4>
2688 [4.5] Is it possible to let users create their own databases?
2689 </h4>
2691 Starting with 2.2.5, in the user management page, you can enter a wildcard
2692 database name for a user (for example &quot;joe%&quot;),
2693 and put the privileges you want. For example,
2694 adding <tt>SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER</tt>
2695 would let a user create/manage his/her database(s).
2696 </p>
2698 <h4>
2699 [4.6] How can I use the Host-based authentication additions?
2700 </h4>
2702 If you have existing rules from an old .htaccess file, you can take them
2703 and add a username between the <tt>'deny'</tt>/<tt>'allow'</tt> and
2704 <tt>'from'</tt> strings. Using the username wildcard of <tt>'%'</tt> would
2705 be a major benefit here if your installation is suited to using it. Then
2706 you can just add those updated lines into the
2707 <tt>$cfg['Servers'][$i]['AllowDeny']['rules']</tt> array.
2708 <br /><br />
2709 If you want a pre-made sample, you can try this fragment. It stops the
2710 'root' user from logging in from any networks other than the private
2711 network IP blocks.
2712 <br />
2713 <tt>
2714 &nbsp;&nbsp;&nbsp;&nbsp;//block root from logging in except from the private networks<br />
2715 &nbsp;&nbsp;&nbsp;&nbsp;$cfg['Servers'][$i]['AllowDeny']['order'] = 'deny,allow';<br />
2716 &nbsp;&nbsp;&nbsp;&nbsp;$cfg['Servers'][$i]['AllowDeny']['rules'] = array(<br />
2717 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'deny root from all',<br />
2718 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from localhost',<br />
2719 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from 10.0.0.0/8',<br />
2720 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from 192.168.0.0/16',<br />
2721 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'allow root from 172.16.0.0/12',<br />
2722 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;);
2723 </tt>
2724 </p>
2725 <h4>
2726 [4.7] Authentication window is displayed more than once, why?
2727 </h4>
2729 This happens if you are using a URL to start phpMyAdmin which is
2730 different than the one set in your <tt>$cfg['PmaAbsoluteUri']</tt>.
2731 For example, a missing &quot;www&quot;, or entering with an IP address
2732 while a domain name is defined in the config file.
2733 </p>
2735 <a name="faqbrowsers"></a><br />
2736 <h3>[5. Browsers or client OS]</h3>
2738 <h4>
2739 [5.1] I get an out of memory error, and my controls are non-functional,
2740 when trying to create a table with more than 14 fields.
2741 </h4>
2743 We could reproduce this problem only under Win98/98SE. Testing under
2744 WinNT4 or Win2K, we could easily create more than 60 fields.
2745 <br />
2746 A workaround is to create a smaller number of fields, then come back to
2747 your table properties and add the other fields.
2748 </p>
2750 <h4>
2751 [5.2] With Xitami 2.5b4, phpMyAdmin won't process form fields.
2752 </h4>
2754 This is not a phpMyAdmin problem but a Xitami known bug: you'll face it
2755 with each script/website that use forms.<br />
2756 Upgrade or downgrade your Xitami server.
2757 </p>
2759 <h4>
2760 [5.3] I have problems dumping tables with Konqueror (phpMyAdmin 2.2.2).
2761 </h4>
2763 With Konqueror 2.1.1: plain dumps, zip and GZip dumps work ok, except that
2764 the proposed file name for the dump is always 'tbl_dump.php'. Bzip2 dumps
2765 don't seem to work.<br />
2767 With Konqueror 2.2.1: plain dumps work; zip dumps are placed into
2768 the user's temporary directory, so they must be moved before closing
2769 Konqueror, or else they disappear. GZip dumps give an error message.<br />
2771 Testing needs to be done for Konqueror 2.2.2.<br />
2772 </p>
2774 <h4>
2775 [5.4] I can't use the cookie authentication mode because Internet
2776 Explorer never stores the cookies.
2777 </h4>
2779 MS Internet Explorer seems to be really buggy about cookies, at least till
2780 version 6. And thanks to Andrew Zivolup we've traced also a PHP 4.1.1 bug
2781 in this area!
2782 <br />
2783 Then, if you're running PHP 4.1.1, try to upgrade or downgrade... it may
2784 work!
2785 </p>
2787 <h4>
2788 [5.5] In Internet Explorer 5.0, I get JavaScript errors when browsing my
2789 rows.
2790 </h4>
2792 Upgrade to at least Internet Explorer 5.5 SP2.<br />
2793 </p>
2795 <h4>
2796 [5.6] In Internet Explorer 5.0, 5.5 or 6.0, I get an error (like "Page not found")
2797 when trying to modify a row in a table with many fields, or with a text field
2798 </h4>
2800 Your table neither have a primary key nor an unique one, so we must use a
2801 long URL to identify this row. There is a limit on the length of the URL in
2802 those browsers, and this not happen in Netscape, for example. The
2803 workaround is to create a primary or unique key, or use another browser.
2804 <br />
2805 </p>
2807 <h4>
2808 [5.7] I refresh (reload) my browser, and come back to the welcome
2809 page.
2810 </h4>
2812 Some browsers support right-clicking into the frame you want to refresh,
2813 just do this in the right frame.<br />
2814 </p>
2816 <h4>
2817 [5.8] With Mozilla 0.9.7 I have problems sending a query modified in the
2818 query box.
2819 </h4>
2821 Looks like a Mozilla bug: 0.9.6 was OK. We will keep an eye on future
2822 Mozilla versions.<br />
2823 </p>
2825 <h4>
2826 [5.9] With Mozilla 0.9.? to 1.0 and Netscape 7.0-PR1 I can't type a
2827 whitespace in the SQL-Query edit area: the page scrolls down.
2828 </h4>
2830 This is a Mozilla bug (see bug #26882 at
2831 <a href="http://bugzilla.mozilla.org/" target="_blank">BugZilla</a>).<br />
2832 </p>
2834 <h4>
2835 [5.10] With Netscape 4.75 I get empty rows between each row of data in a
2836 CSV exported file.
2837 </h4>
2839 This is a known Netscape 4.75 bug: it adds some line feeds when exporting
2840 data in octet-stream mode. Since we can't detect the specific Netscape
2841 version, we cannot workaround this bug.
2842 </p>
2844 <h4>
2845 [5.11] Extended-ASCII characters like German umlauts are displayed
2846 wrong.
2847 </h4>
2849 Please ensure that you have set your browser's character set to the one of the
2850 language file you have selected on phpMyAdmin's start page.
2851 Alternatively, you can try the auto detection mode that is supported by the
2852 recent versions of the most browsers.
2853 </p>
2855 <h4>
2856 [5.12] Apple OS X: Safari browser changes special characters to
2857 &quot;?&quot;.
2858 </h4>
2860 This issue has been reported by a OS X user, who adds that Chimera,
2861 Netscape and Mozilla do not have this problem.
2862 </p>
2864 <h4>
2865 [5.13] With Internet Explorer 5.5 or 6, and HTTP authentication type,
2866 I cannot manage two servers: I login to the first one, then the other one,
2867 but if I switch back to the first, I have to login on each operation.
2868 </h4>
2870 This is a bug in Internet Explorer, other browsers do not behave this way.
2871 </p>
2873 <h4>
2874 [5.14] Using Opera6, I can manage to get to the authentification, but nothing
2875 happens after that, only a blank screen.
2876 </h4>
2878 Having $cfg['QueryFrameJS'] set to TRUE, this leads to a bug in Opera6, because it
2879 is not able to interpret frameset definitiions written by JavaScript. Please upgrade
2880 to Opera7 at least.
2881 </p>
2883 <a name="faqusing"></a><br />
2884 <h3>[6. Using phpMyAdmin]</h3>
2886 <h4>
2887 [6.1] I can't insert new rows into a table / I can't create a table
2888 - MySQL brings up a SQL-error.
2889 </h4>
2891 Examine the SQL error with care. Often the problem is caused by
2892 specifying a wrong field-type.<br />
2893 Common errors include:
2894 </p>
2895 <ul>
2896 <li>Using <tt>VARCHAR</tt> without a size argument</li>
2897 <li>Using <tt>TEXT</tt> or <tt>BLOB</tt> with a size argument</li>
2898 </ul>
2900 Also, look at the syntax chapter in the MySQL manual to confirm that your
2901 syntax is correct.
2902 </p>
2904 <h4>
2905 [6.2] When I create a table, I click the Index checkbox for 2 fields and
2906 phpMyAdmin generates only one index with those 2 fields.
2907 </h4>
2909 In phpMyAdmin 2.2.0 and 2.2.1, this is the way to create a multi-fields
2910 index. If you want two indexes, create the first one when creating the
2911 table, save, then display the table properties and click the Index link to
2912 create the other index.
2913 </p>
2915 <h4>
2916 [6.3] How can I insert a null value into my table?
2917 </h4>
2919 Since version 2.2.3, you have a checkbox for each field that can be null.
2920 Before 2.2.3, you had to enter &quot;null&quot;, without the quotes, as the
2921 field's value.
2922 </p>
2924 <h4>
2925 [6.4] How can I backup my database or table?
2926 </h4>
2928 Click on a database or table name in the left frame, the properties will be
2929 displayed. Then on the menu, click &quot;Export&quot;, you can dump
2930 the structure, the data, or both. This will generate standard SQL
2931 statements that can be used to recreate your database/table.
2932 <br /><br />
2933 You will need to choose &quot;Save as file&quot;, so that phpMyAdmin can
2934 transmit the resulting dump to your station. Depending on your PHP
2935 configuration, you will see options to compress the dump. See also the
2936 <tt>$cfg['ExecTimeLimit']</tt> configuration variable.
2937 <br /><br />
2938 For additional help on this subject, look for the word &quot;dump&quot; in
2939 this document.
2940 </p>
2942 <h4>
2943 [6.5] How can I restore (upload) my database or table using a dump?
2944 How can I run a &quot;.sql&quot; file.
2945 </h4>
2947 Click on a database name in the left frame, the properties will be
2948 local displayed. Then in the &quot;Run SQL query&quot; section, type in
2949 your dump filename, or use the Browse button. Then click Go.
2950 <br /><br />
2951 For additional help on this subject, look for the word &quot;upload&quot;
2952 in this document.
2953 </p>
2955 <h4>
2956 [6.6] How can I use the relation table in Query-by-example?
2957 </h4>
2959 Here is an example with the tables persons, towns and countries, all
2960 located in the database mydb. If you don't have a <tt>PMA_relation</tt>
2961 table, create it as explained in the configuration section. Then create the
2962 example tables:
2963 <br /><br />
2964 <tt>
2965 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE REL_countries (<br />
2966 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;country_code char(1) NOT NULL default '',<br />
2967 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;description varchar(10) NOT NULL default '',<br />
2968 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (country_code)<br />
2969 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM;<br />
2970 <br />
2971 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_countries VALUES ('C', 'Canada');<br />
2972 <br />
2973 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE REL_persons (<br />
2974 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id tinyint(4) NOT NULL auto_increment,<br />
2975 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;person_name varchar(32) NOT NULL default '',<br />
2976 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;town_code varchar(5) default '0',<br />
2977 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;country_code char(1) NOT NULL default '',<br />
2978 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (id)<br />
2979 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM;<br />
2980 <br />
2981 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_persons VALUES (11, 'Marc', 'S', '');<br />
2982 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_persons VALUES (15, 'Paul', 'S', 'C');<br />
2983 <br />
2984 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CREATE TABLE REL_towns (<br />
2985 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;town_code varchar(5) NOT NULL default '0',<br />
2986 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;description varchar(30) NOT NULL default '',<br />
2987 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PRIMARY KEY (town_code)<br />
2988 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;) TYPE=MyISAM;<br />
2989 <br />
2990 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_towns VALUES ('S', 'Sherbrooke');<br />
2991 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INSERT INTO REL_towns VALUES ('M', 'Montr&eacute;al');<br />
2992 <br />
2993 </tt>
2994 To setup appropriate links and display information:
2995 </p>
2996 <ul>
2997 <li>on table &quot;REL_persons&quot; click Structure, then Relation view</li>
2998 <li>in Links, for &quot;town_code&quot; choose &quot;REL_towns-&gt;code&quot;</li>
2999 <li>in Links, for &quot;country_code&quot; choose &quot;REL_countries-&gt;country_code&quot;</li>
3000 <li>on table &quot;REL_towns&quot; click Structure, then Relation view</li>
3001 <li>in &quot;Choose field to display&quot;, choose &quot;description&quot;</li>
3002 <li>repeat the two previous steps for table &quot;REL_countries&quot;</li>
3003 </ul>
3006 Then test like this:
3007 </p>
3008 <ul>
3009 <li>Click on your db name in the left frame</li>
3010 <li>Choose &quot;Query&quot;</li>
3011 <li>Use tables: persons, towns, countries</li>
3012 <li>Click &quot;Update query&quot;</li>
3013 <li>In the fields row, choose persons.person_name and click the
3014 &quot;Show&quot; tickbox </li>
3015 <li>Do the same for towns.description and countries.descriptions in the
3016 other 2 columns</li>
3017 <li>Click &quot;Update query&quot; and you will see in the query box that
3018 the correct joins have been generated</li>
3019 <li>Click &quot;Submit query&quot;</li>
3020 </ul>
3021 <br />
3023 <a name="faqdisplay"></a><br />
3024 <h4>
3025 [6.7] How can I use the &quot;display field&quot; feature?
3026 </h4>
3028 Starting from the previous example, create the PMA_table_info as explained
3029 in the configuration section, then browse your persons table,
3030 and move the mouse over a town code or country code.
3031 <br /><br />
3032 See also FAQ 6.21 for an additionnal feature that &quot;display field&quot;
3033 enables: drop-down list of possible values.
3034 </p>
3036 <a name="faqpdf"></a><br />
3037 <h4>
3038 [6.8] How can I produce a PDF schema of my database?
3039 </h4>
3041 First you have to fill the &quot;relation&quot;, &quot;table_coords&quot;
3042 and &quot;pdf_pages&quot; configuration variables.
3043 <br /><br />
3044 Then, think about your schema layout: which tables will go on which pages.
3045 </p>
3046 <ul>
3047 <li>Click on your db name in the left frame</li>
3048 <li>Choose &quot;Structure&quot; in the navigation on top</li>
3049 <li>Choose &quot;Edit PDF Pages&quot; which should be somewhere at the
3050 bottom of the page</li>
3051 <li>Enter the name for a first pdf page and submit</li>
3052 <li>Choose this page to edit</li>
3053 <li>Now add a table you want to show on this page and it's coordinates and
3054 submit<br />
3055 First you will have to guess this coordinates of course, so just expect
3056 to have an area of about 297 * 210 and put the tables coordinates
3057 somewhere in there, you will be able to have a look at what happened
3058 and change them later.<br />
3059 For example, x=100 and y=200 means that the table will be at 200 mm
3060 down and 100 mm right from the upper left corner.<br />
3061 Actually if you have a width of more than 300 or a height of more than
3062 200 than it will automatically be scaled but 300*100 is a good start to
3063 have an idea of what coordinates to use.</li>
3064 <li>After every table you submitted you will have the possibility to submit
3065 more tables</li>
3066 <li>When you have entered enough tables Click on your db name in the left
3067 frame again</li>
3068 <li>Now, again at the bottom of the page you should be able to choose
3069 &quot;Display PDF schema&quot;<br />
3070 For testing it might be useful to show the grid as well, so you can see
3071 the coordinates used.<br />
3072 Maybe also choose color and submit.</li>
3073 <li>Save the file he will offer you to something like <i>Schema.pdf</i>
3074 (Internet Explorer has some bug there which might make it offer it
3075 without an extension. Under Windows it is important to have the
3076 extension &quot;.pdf&quot;, under other OSes you should be fine just
3077 saving the file under the name it offers).</li>
3078 </ul>
3080 <h4>
3081 [6.9] phpMyAdmin is changing the type of one of my columns!
3082 </h4>
3084 No, it's MySQL that is doing
3085 <a href="http://www.mysql.com/doc/S/i/Silent_column_changes.html">silent column type changing</a>.
3086 </p>
3088 <a name="underscore"></a><br />
3089 <h4>
3090 [6.10] When creating a privilege, what happens with underscores in
3091 the database name?
3092 </h4>
3094 If you do not put a backslash before the underscore, this is a wildcard
3095 grant, and the underscore means &quot;any character&quot;. So, if the
3096 database name is &quot;john_db&quot;, the user would get rights to john1db,
3097 john2db...<br /><br />
3098 If you put a backslash before the underscore, it means that the database
3099 name will have a real underscore.
3100 </p>
3102 <h4>
3103 [6.11] What is the curious symbol &oslash; in the statistics pages?
3104 </h4>
3106 It means &quot;average&quot;.
3107 </p>
3109 <a name="faqexport"></a><br />
3110 <h4>
3111 [6.12] I want to understand some Export options.
3112 </h4>
3114 &quot;Complete inserts&quot; adds the column names on every INSERT command,
3115 for better documentation (but resulting file is bigger).<br />
3116 &quot;Extended inserts&quot; provides a shorter dump file by using only
3117 once the INSERT verb and the table name.<br />
3118 &quot;Enclose table and field names with backquotes&quot; ensures that
3119 field and table names formed with special characters are protected.<br />
3120 &quot;Include column comments as inline SQL-comments&quot; includes any
3121 column comments set in the PMA-DB in the dump as SQL comments (<i>/* xxx */</i>).<br /></p>
3123 <h4>
3124 [6.13] I would like to create a database with a dot in its name.
3125 </h4>
3127 This is a bad idea, because in MySQL the syntax &quot;database.table&quot;
3128 is the normal way to reference a database and table name. Worse, MySQL
3129 will usually let you create a database with a dot, but then you cannot
3130 work with it, nor delete it.<br />
3131 </p>
3133 <a name="faqsqlvalidator"></a><br />
3134 <h4>
3135 [6.14] How do I set up the SQL Validator?
3136 </h4>
3138 To use it, you need a very recent version of PHP, 4.3.0 recommended, with
3139 XML, PCRE and PEAR support. On your system command line, run
3140 <tt>"pear install Net_Socket Net_URL HTTP_Request Mail_Mime Net_DIME
3141 SOAP"</tt> to get the necessary PEAR modules for usage.
3142 <br />
3143 If you use it, you should be aware that any SQL statement you
3144 submit will be stored anonymously (database/table/column names,
3145 strings, numbers replaced with generic values). The Mimer SQL
3146 Validator itself, is &copy; 2001 Upright Database Technology.
3147 We utilize it as free SOAP service.
3148 </p>
3150 <h4>
3151 [6.15] I want to add a BLOB field and put an index on it, but MySQL
3152 says &quot;BLOB column '...' used in key specification without a key
3153 length&quot;.
3154 </h4>
3156 The right way to do this, is to create the field without any indexes,
3157 then display the table structure and use the &quot;Create an index&quot;
3158 dialog. On this page, you will be able to choose your BLOB field, and
3159 set a size to the index, which is the condition to create an index on
3160 a BLOB field.
3161 <br />
3162 </p>
3164 <h4>
3165 [6.16] How can I simply move in page with plenty editing fields?
3166 </h4>
3168 You can use Ctrl+arrows for moving on most pages with plenty editing
3169 fields (table structure changes, row editing, etc.) (must be anabled in
3170 configuration - see. $cfg['CtrlArrowsMoving']). You can also have a look
3171 at the directive $cfg['DefaultPropDisplay'] ('vertical') and see if this
3172 eases up editing for you.
3173 <br />
3174 </p>
3176 <h4>
3177 [6.17] Transformations: I can't enter my own mimetype! WTF is this feature
3178 then useful for?
3179 </h4>
3181 Slow down :). Defining mimetypes is of no use, if you can't put transformations on them.
3182 Otherwise you could just put a comment on the field. Because entering your own mimetype will
3183 cause serious syntax checking issues and validation, this introduces a high-risk false-user-input
3184 situation. Instead you have to initialize mimetypes using functions or empty mimetype definitions.
3185 <br />
3186 Plus, you have a whole overview of available mimetypes. Who knows all those mimetypes by heart so
3187 he/she can enter it at will?
3188 <br />
3189 </p>
3191 <a name="faqbookmark"></a>
3192 <h4>
3193 [6.18] Bookmarks: Where can I store bookmarks? Why can't I see any bookmarks below the query box?
3194 What is this variable for?
3195 </h4>
3197 Any query you have executed can be stored as a bookmark on the page where the results are displayed.
3198 You will find a button labeled 'Bookmark this query' just at the end of the page.<br />
3199 As soon as you have stored a bookmark, it is related to the database you run the query on. You can
3200 now access a bookmark dropdown on each page, the query box appears on for that database.<br />
3201 <br />
3202 Since phpMyAdmin 2.5.0 you are also able to store variables for the bookmarks. Just use the string
3203 <b>/*[VARIABLE]*/</b> anywhere in your query. Everything which is put into the <i>value</i> input
3204 box on the query box page will replace the string &quot;/*[VARIABLE]*/&quot; in your stored query.
3205 Just be aware of that you HAVE to create a valid query, otherwise your query won't be even able to be
3206 stored in the database.<br />
3207 Also remember, that everything else inside the <b>/*[VARIABLE]*/</b> string for your query will remain
3208 the way it is, but will be stripped of the /**/ chars. So you can use:<br /><br />
3209 <code>/*, [VARIABLE] AS myname */</code><br /><br />
3210 which will be expanded to<br /><br />
3211 <code>, VARIABLE as myname</code><br /><br />
3212 in your query, where VARIABLE is the string you entered in the input box. If an empty string is
3213 provided, no replacements are made.<br />
3214 <br />
3215 A more complex example. Say you have stored this query:<br /><br />
3216 <code>SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE]%' */</code><br /><br />
3217 Say, you now enter &quot;phpMyAdmin&quot; as the variable for the stored query, the full query will
3218 be:<br /><br />
3219 <code>SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%'</code>
3220 <br />
3221 <br />
3222 You can use multiple occurences of <b>/*[VARIABLE]*/</b> in a single query.<br />
3223 <b>NOTE THE ABSENCE OF SPACES</b> inside the &quot;/**/&quot; construct. Any spaces inserted there
3224 will be later also inserted as spaces in your query and may lead to unexpected results especially when
3225 using the variable expansion inside of a &quot;LIKE ''&quot; expression.<br />
3226 Your initial query which is going to be stored as a bookmark has to yield at least one result row so
3227 you can store the bookmark. You may have that to work around using well positioned &quot;/**/&quot;
3228 comments.
3229 </p>
3231 <h4>
3232 [6.19] How can I create simple LaTeX document to include exported table?
3233 </h4>
3235 You can simply include table in your LaTeX documents, minimal sample
3236 document should look like following one (assuming you have table
3237 exported in file <code>table.tex</code>):
3238 <br />
3239 <br />
3240 <pre>
3241 <font color="#a52a2a"><b>\documentclass</b></font><font color="#6a5acd">{</font><font color="#a020f0">article</font><font color="#6a5acd">}</font>
3242 <font color="#a52a2a"><b>\usepackage</b></font><font color="#6a5acd">{</font><font color="#6a5acd">longtable</font><font color="#6a5acd">}</font>
3244 <font color="#a52a2a"><b>\begin</b></font><font color="#6a5acd">{</font><font color="#a020f0">document</font><font color="#6a5acd">}</font>
3246 <font color="#a52a2a"><b>\include</b></font><font color="#6a5acd">{</font><font color="#6a5acd">table</font><font color="#6a5acd">}</font>
3248 <font color="#a52a2a"><b>\end</b></font><font color="#6a5acd">{</font><font color="#a020f0">document</font><font color="#6a5acd">}</font>
3249 </pre>
3250 </p>
3252 <h4>
3253 [6.20] In MySQL 4, I see a lot of databases which are not mine, and cannot
3254 access them.
3255 </h4>
3257 Upgrading to MySQL 4 usually gives users a global privilege: CREATE
3258 TEMPORARY TABLES. This privilege also enables users to see all the
3259 database names. See this <a href="http://bugs.mysql.com/179">bug report</a>. <br /><br />
3260 So if your users do not need this privilege, you can remove it and their
3261 databases list will shorten.
3262 </p>
3263 <h4>
3264 [6.21] In edit/insert mode, how can I see a list of possible values for
3265 a field, based on some foreign table?
3266 </h4>
3268 You have to setup appropriate links between the tables, and also
3269 setup the &quot;display field&quot; in the foreign table. See FAQ
3270 6.6 for an example. Then, if there are 200 values or less in the
3271 foreign table, a drop-down list of values will be available.
3272 </p>
3273 <a name="faqproject"></a><br />
3274 <h3>[7. phpMyAdmin project]</h3>
3276 <h4>
3277 [7.1] I have found a bug. How do I inform developers?
3278 </h4>
3280 Our Bug Tracker is located at
3281 <a href="http://sourceforge.net/projects/phpmyadmin/">http://sourceforge.net/projects/phpmyadmin/</a>
3282 under the Bugs section.
3283 <br /><br />
3284 But please first discuss your bug with other users:
3285 <br />
3286 <a href="http://sourceforge.net/projects/phpmyadmin/">
3287 http://sourceforge.net/projects/phpmyadmin/</a> (and choose Forums)
3288 </p>
3290 <h4>
3291 [7.2] I want to translate the messages to a new language or upgrade an
3292 existing language, where do I start?
3293 </h4>
3295 Always use the current CVS version of your language file.
3296 For a new language, start from <i>english-iso-8859-1.inc.php3</i>. If you
3297 don't know how to get the CVS version, please ask one of the developers.
3298 <br />
3299 Please note that we try not to use HTML entities like &amp;eacute; in
3300 the translations, since we define the right character set in the file.
3301 With HTML entities, the text on JavaScript messages would not
3302 display correctly.
3303 However there are some entities that need to be there, for quotes
3304 ,non-breakable spaces, ampersands, less than, greater than.
3305 <br />
3306 You can then put your translations, as a zip file to avoid losing special
3307 characters, on the sourceforge.net translation tracker.
3308 <br />
3309 It would be a good idea to subscribe to the phpmyadmin-translators mailing
3310 list, because this is where we ask for translations of new messages.
3311 <br />
3312 </p>
3314 <h4>
3315 [7.3] I would like to help out with the development of phpMyAdmin. How
3316 should I proceed?
3317 </h4>
3319 The following method is preferred for new developers:
3320 </p>
3321 <ol>
3322 <li>
3323 fetch the current CVS tree over anonymous CVS:<br />
3324 <tt>cvs -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin login</tt><br />
3325 [Password: simply press the Enter key]<br />
3326 <tt>cvs -z3 -d:pserver:anonymous@cvs.phpmyadmin.sourceforge.net:/cvsroot/phpmyadmin checkout phpMyAdmin</tt><br />
3327 [This will create a new sub-directory named phpMyAdmin]
3328 </li>
3329 <li>
3330 add your stuff
3331 </li>
3332 <li>
3333 put the modified files (tar'ed and gzip'ed) inside the patch tracker of
3335 <a href="http://sourceforge.net/projects/phpmyadmin/" target="_blank">phpMyAdmin SourceForge account</a>.
3336 </li>
3337 </ol>
3339 Write access to the CVS tree is granted only to experienced developers who
3340 have already contributed something useful to phpMyAdmin.<br />
3341 Also, have a look at the
3342 <a href="#developers">Developers section</a>.
3343 </p>
3344 <a name="faqsecurity"></a><br />
3345 <h3>[8. Security ]</h3>
3347 <h4>
3348 [8.1] Security alert, dated 2003-06-18.
3349 </h4>
3351 Last update of this FAQ: 2003-07-02.
3352 <br /><br />
3353 The phpMyAdmin development team received notice of this security alert:
3354 <a href="http://www.securityfocus.com/archive/1/325641" target="_blank">http://www.securityfocus.com/archive/1/325641.</a>
3355 <br /><br />
3357 The team regrets that the author did not communicate with us before
3358 sending this alert. However, here is our current reply to the points mentionned:
3359 <br /><br />
3360 <ul>
3361 <li>&quot;Directory transversal attack&quot;
3362 <br /><br />
3364 This problem had been fixed in version 2.5.0, even if the author reports
3365 the 2.5.2 development version as vulnerable, which we could not reproduce.
3366 <br /><br />
3367 </li>
3368 <li>&quot;Remote local file retrieving&quot;
3369 <br /><br />
3370 This is a misleading title, as the author tells in his text:
3371 &quot;Note that you can't request files ( only dirs )&quot;.
3372 <br /><br />
3373 </li>
3375 <li>&quot;Remote internal directory listing&quot;
3376 <br /><br />
3377 It was possible to retrieve the list of phpMyAdmin's directory (which we
3378 doubt can cause any damage), but we fixed this in the upcoming
3379 2.5.2 version.
3380 <br /><br />
3381 </li>
3383 <li>&quot;XSS and Path disclosures&quot;
3384 <br /><br />
3385 Most of the XSS problems have been fixed in version 2.5.0. The rest
3386 have been fixed in the upcoming 2.5.2 version.
3387 <br /><br />
3388 We are currently looking at the Path disclosure issue.
3389 <br /><br />
3390 </li>
3391 <li>&quot;Information encoding weakness&quot;
3392 <br /><br />
3393 We believe that an exploit for this weakness would be difficult
3394 to achieve. However version 2.5.2-dev now encrypts the password
3395 with the well-known blowfish algorithm.
3396 <br /><br />
3397 </li>
3398 </ul>
3400 </p>
3402 <!-- DEVELOPERS -->
3403 <a name="developers"></a><br />
3404 <h2>Developers Information</h2>
3407 phpMyAdmin is Open Source, so you're invited to contribute to it. Many
3408 great features have been written by other people and you too can help to
3409 make phpMyAdmin a useful tool.
3410 </p>
3413 If you're planning to contribute source, please read the following
3414 information:
3415 </p>
3416 <ul>
3417 <li>
3418 All files include <i>header.inc.php3</i> (layout),
3419 <i>libraries/common.lib.php3</i> (common functions) and
3420 <i>config.inc.php3</i>.
3421 <br />
3422 All configuration data belongs in <i>config.inc.php3</i>. Please keep
3423 it free from other code.
3424 <br />
3425 Commonly used functions should be added to
3426 <i>libraries/common.lib.php3</i> and more specific ones may be added
3427 within a library stored into the <i>libraries</i> sub-directory.
3428 </li>
3429 <li>
3430 Obviously, you're free to use whatever coding style you want. But
3431 please try to keep your code as simple as possible: beginners are
3432 using phpMyAdmin as an example application.<br />
3433 As far as possible, we want the scripts to be XHTML1.0 and CSS2
3434 compliant on one hand, they fit the
3435 <a href="http://pear.php.net/" target="_blank">PEAR coding standards</a>
3436 on the other hand. Please pay attention to this.
3437 </li>
3438 <li>
3439 Please try to keep up the file-naming conventions. Table-related stuff
3440 goes to <i>tbl_*.php3</i>, db-related code to <i>db_*.php3</i>,
3441 server-related tools to <i>server_*.php3</i> and so on.
3442 </li>
3443 <li>
3444 Please don't use verbose strings in your code, instead add the string
3445 (at least) to <i>english-iso-8859-1.inc.php3</i> and print() it out.
3446 </li>
3447 <li>
3448 If you want to be really helpful, write an entry for the ChangeLog.
3449 </li>
3450 <li id="developersdbg">
3451 The DBG extension (<a href="http://dd.cron.ru/dbg/" target="_blank">PHP
3452 Debugger DBG</a>) is now supported by phpMyAdmin for developers to
3453 better debug and profile their code.<br />
3454 Please see the <tt>$cfg['DBG']*</tt> configuration options for more
3455 information.<br />
3456 This is in memoriam of the Space Shuttle Columbia (STS-107) which was
3457 lost during its re-entry into Earth's atmosphere and in memory of the
3458 brave men and women who gave their lives for the people of Earth.
3459 </li>
3461 </ul>
3463 <!-- CREDITS -->
3464 <a name="credits"></a><br />
3465 <h2>Credits</h2>
3467 <pre>
3469 phpMyAdmin - Credits
3470 ====================
3472 CREDITS, in chronological order
3473 -------------------------------
3475 - Tobias Ratschiller &lt;tobias.ratschiller_at_maguma.com&gt;
3476 * creator of the phpmyadmin project
3477 * maintainer from 1998 to summer 2000
3479 - Marc Delisle &lt;DelislMa_at_CollegeSherbrooke.qc.ca&gt;
3480 * multi-language version
3481 * various fixes and improvements
3482 * project co-administrator
3484 - Olivier M&uuml;ller &lt;om_at_omnis.ch&gt;
3485 * started SourceForge phpMyAdmin project in March 2001
3486 * sync'ed different existing CVS trees with new features and bugfixes
3487 * multi-language improvements, dynamic language selection
3488 * current project maintainer
3489 * many bugfixes and improvements
3491 - Lo&iuml;c Chapeaux &lt;lolo_at_phpheaven.net&gt;
3492 * rewrote and optimized javascript, DHTML and DOM stuff
3493 * rewrote the scripts so they fit the PEAR coding standards and
3494 generate XHTML1.0 and CSS2 compliant codes
3495 * improved the language detection system
3496 * many bugfixes and improvements
3498 - Robin Johnson &lt;robbat2_at_users.sourceforge.net&gt;
3499 * database maintence controls
3500 * table type code
3501 * Host authentication IP Allow/Deny
3502 * DB-based configuration (Not completed)
3503 * SQL parser
3504 * SQL validator
3505 * many bugfixes and improvements
3507 - Armel Fauveau &lt;armel.fauveau_at_globalis-ms.com&gt;
3508 * bookmarks feature
3509 * multiple dump feature
3510 * gzip dump feature
3511 * zip dump feature
3513 - Geert Lund &lt;glund_at_silversoft.dk&gt;
3514 * various fixes
3515 * moderator of the phpMyAdmin users forum at phpwizard.net
3517 - Korakot Chaovavanich &lt;korakot_at_iname.com&gt;
3518 * &quot;insert as new row&quot; feature
3520 - Pete Kelly &lt;webmaster_at_trafficg.com&gt;
3521 * rewrote and fix dump code
3522 * bugfixes
3524 - Steve Alberty &lt;alberty_at_neptunlabs.de&gt;
3525 * rewrote dump code for PHP4
3526 * mySQL table statistics
3527 * bugfixes
3529 - Benjamin Gandon &lt;gandon_at_isia.cma.fr&gt;
3530 * main author of the version 2.1.0.1
3531 * bugfixes
3533 - Alexander M. Turek &lt;derrabus_at_gmx.de&gt;
3534 * XML exports
3535 * MySQL 4 related features
3536 * various features and fixes
3537 * German language file updates
3539 - Mike Beck &lt;mike.beck_at_ibmiller.de&gt;
3540 * automatic joins in QBE
3541 * links column in printview
3542 * Relation view
3544 - Michal Cihar &lt;nijel_at_users.sourceforge.net&gt;
3545 * enhanced index creation/display feature
3546 * feature to use a different charset for HTML than for MySQL
3547 * Czech language file updates
3549 - Christophe Gesch&eacute; from the &quot;MySQL Form Generator for PHPMyAdmin&quot;
3550 (http://sourceforge.net/projects/phpmysqlformgen/)
3551 * suggested the patch for multiple table printviews
3553 - Garvin Hicking &lt;hicking_at_faktor-e.de&gt;
3554 * built the patch for vertical display of table rows
3555 * built the Javascript based Query window + SQL history
3556 * Improvement of column/db comments
3557 * (MIME)-Transformations for columns
3558 * Use custom alias names for Databases in left frame
3559 * vertical display of column properties page
3560 * some bugfixes, smaller features
3562 - Yukihiro Kawada &lt;kawada_at_den.fujifilm.co.jp&gt;
3563 * japanese kanji encoding conversion feature
3565 - Piotr Roszatycki &lt;d3xter_at_users.sourceforge.net&gt; and Dan Wilson
3566 * the Cookie authentication mode
3568 - Axel Sander &lt;n8falke_at_users.sourceforge.net&gt;
3569 * table relation-links feature
3571 - Maxime Delorme &lt;delorme.maxime_at_free.fr&gt;
3572 * PDF schema output, thanks also to Olivier Plathey for the
3573 &quot;FPDF&quot; library (see http://www.fpdf.org/).
3575 - Olof Edlund &lt;olof.edlund_at_upright.se&gt;
3576 * SQL validator server
3578 - Ivan R. Lanin &lt;ivanlanin_at_users.sourceforge.net&gt;
3579 * phpMyAdmin logo
3581 - Mike Cochrane &lt;mike_at_graftonhall.co.nz&gt;
3582 * blowfish library from the Horde project
3584 And also to the following people who have contributed minor changes,
3585 enhancements, bugfixes or support for a new language since version 2.1.0:
3587 Bora Alioglu, Ricardo ?, Sven-Erik Andersen, Alessandro Astarita,
3588 P&eacute;ter Bakondy, Borges Botelho, Olivier Bussier, Neil Darlow,
3589 Mats Engstrom, Ian Davidson, Laurent Dhima, Kristof Hamann, Thomas Kl&auml;ger,
3590 Lubos Klokner, Martin Marconcini, Girish Nair, David Nordenberg, Andreas Pauley,
3591 Bernard M. Piller, Laurent Haas, &quot;Sakamoto&quot;, Yuval Sarna,
3592 www.securereality.com.au, Alexis Soulard, Alvar Soome, Siu Sun, Peter Svec,
3593 Michael Tacelosky, Rachim Tamsjadi, Kositer Uros,
3594 Luís V., Martijn W. van der Lee,
3595 Algis Vainauskas, Daniel Villanueva, Vinay, Ignacio Vazquez-Abrams, Chee Wai,
3596 Jakub Wilk, Thomas Michael Winningham, Vilius Zigmantas, &quot;Manuzhai&quot;.
3599 Original Credits of Version 2.1.0
3600 ---------------------------------
3602 This work is based on Peter Kuppelwieser's MySQL-Webadmin. It was his idea
3603 to create a web-based interface to MySQL using PHP3. Although I have not
3604 used any of his source-code, there are some concepts I've borrowed from
3605 him. phpMyAdmin was created because Peter told me he wasn't going to
3606 further develop his (great) tool.
3607 Thanks go to
3608 - Amalesh Kempf &lt;ak-lsml_at_living-source.com&gt; who contributed the
3609 code for the check when dropping a table or database. He also suggested
3610 that you should be able to specify the primary key on tbl_create.php3. To
3611 version 1.1.1 he contributed the ldi_*.php3-set (Import text-files) as
3612 well as a bug-report. Plus many smaller improvements.
3613 - Jan Legenhausen &lt;jan_at_nrw.net&gt;: He made many of the changes that
3614 were introduced in 1.3.0 (including quite significant ones like the
3615 authentication). For 1.4.1 he enhanced the table-dump feature. Plus
3616 bug-fixes and help.
3617 - Marc Delisle &lt;DelislMa_at_CollegeSherbrooke.qc.ca&gt; made phpMyAdmin
3618 language-independent by outsourcing the strings to a separate file. He
3619 also contributed the French translation.
3620 - Alexandr Bravo &lt;abravo_at_hq.admiral.ru&gt; who contributed
3621 tbl_select.php3, a feature to display only some fields from a table.
3622 - Chris Jackson &lt;chrisj_at_ctel.net&gt; added support for MySQL
3623 functions in tbl_change.php3. He also added the
3624 &quot;Query by Example&quot; feature in 2.0.
3625 - Dave Walton &lt;walton_at_nordicdms.com&gt; added support for multiple
3626 servers and is a regular contributor for bug-fixes.
3627 - Gabriel Ash &lt;ga244_at_is8.nyu.edu&gt; contributed the random access
3628 features for 2.0.6.
3629 The following people have contributed minor changes, enhancements, bugfixes
3630 or support for a new language:
3631 Jim Kraai, Jordi Bruguera, Miquel Obrador, Geert Lund, Thomas Kleemann,
3632 Alexander Leidinger, Kiko Albiol, Daniel C. Chao, Pavel Piankov,
3633 Sascha Kettler, Joe Pruett, Renato Lins, Mark Kronsbein, Jannis Hermanns,
3634 G. Wieggers.
3636 And thanks to everyone else who sent me email with suggestions, bug-reports
3637 and or just some feedback.
3638 </pre>
3642 <a name="bottom"></a><br />
3643 <p align="right">
3644 <a href="http://validator.w3.org/check/referer" target="w3c">
3645 <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" border="0" height="31" width="88" /></a>
3646 &nbsp;&nbsp;&nbsp;&nbsp;
3647 <a href="http://jigsaw.w3.org/css-validator/" target="w3c">
3648 <img src="http://www.w3.org/Icons/valid-css" alt="Valid CSS!" border="0" width="88" height="31" /></a>
3649 </p>
3651 </body>
3652 </html>