Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 2a66742a00
Fetching contributors…

Cannot retrieve contributors at this time

5207 lines (4409 sloc) 256.952 kb
<!DOCTYPE HTML>
<!--
vim: expandtab ts=4 sw=4 sts=4 tw=78
-->
<html lang="en-US" dir="ltr">
<head>
<link rel="icon" href="favicon.ico" type="image/x-icon" />
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon" />
<meta charset="utf-8" />
<title>phpMyAdmin 4.0.0-dev - Documentation</title>
<link rel="stylesheet" type="text/css" href="docs.css" />
</head>
<body id="top">
<div id="header">
<h1>
<a href="http://www.phpmyadmin.net/">php<span class="myadmin">MyAdmin</span></a>
4.0.0-dev
Documentation
</h1>
</div>
<!-- TOP MENU -->
<ul class="header">
<li><a href="Documentation.html#top">Top</a></li>
<li><a href="Documentation.html#require">Requirements</a></li>
<li><a href="Documentation.html#intro">Introduction</a></li>
<li><a href="Documentation.html#setup">Installation</a></li>
<li><a href="Documentation.html#setup_script">Setup script</a></li>
<li><a href="Documentation.html#config">Configuration</a></li>
<li><a href="Documentation.html#transformations">Transformations</a></li>
<li><a href="Documentation.html#faq"><abbr title="Frequently Asked Questions"> FAQ</abbr></a></li>
<li><a href="Documentation.html#developers">Developers</a></li>
<li><a href="Documentation.html#copyright">Copyright</a></li>
<li><a href="Documentation.html#credits">Credits</a></li>
<li><a href="Documentation.html#glossary">Glossary</a></li>
</ul>
<div id="body">
<ul><li><a href="http://www.phpmyadmin.net/">
phpMyAdmin homepage</a></li>
<li><a href="https://sourceforge.net/projects/phpmyadmin/">
SourceForge phpMyAdmin project page</a></li>
<li><a href="http://wiki.phpmyadmin.net">
Official phpMyAdmin wiki</a></li>
<li><a href="https://github.com/phpmyadmin">
Git repositories on Github</a></li>
<li>Local documents:
<ul><li>Version history: <a href="changelog.php">ChangeLog</a></li>
<li>License: <a href="license.php">LICENSE</a></li>
</ul>
</li>
</ul>
<!-- REQUIREMENTS -->
<h2 id="require">Requirements</h2>
<ul><li><strong>PHP</strong>
<ul><li>You need PHP 5.2.0 or newer, with <code>session</code> support
(<a href="#faq1_31">see
<abbr title="Frequently Asked Questions">FAQ</abbr> 1.31</a>)
, the Standard PHP Library (SPL) extension and JSON support.
</li>
<li>To support uploading of ZIP files, you need the PHP <code>zip</code> extension.</li>
<li>For proper support of multibyte strings (eg. UTF-8, which is
currently the default), you should install the mbstring and ctype
extensions.
</li>
<li>You need GD2 support in PHP to display inline
thumbnails of JPEGs (&quot;image/jpeg: inline&quot;) with their
original aspect ratio.</li>
<li>When using the &quot;cookie&quot;
<a href="#authentication_modes">authentication method</a>, the
<a href="http://www.php.net/mcrypt"><code>mcrypt</code></a> extension
is strongly suggested for most users and is <strong>required</strong> for
64&#8211;bit machines. Not using mcrypt will cause phpMyAdmin to
load pages significantly slower.
</li>
<li>To support upload progress bars, see <a href="#faq2_9">
<abbr title="Frequently Asked Questions">FAQ</abbr> 2.9</a>.</li>
<li>To support XML and Open Document Spreadsheet importing,
you need PHP 5.2.17 or newer and the
<a href="http://www.php.net/libxml"><code>libxml</code></a> extension.</li>
</ul>
</li>
<li><strong>MySQL</strong> 5.0 or newer (<a href="#faq1_17">details</a>);</li>
<li><strong>Web browser</strong> with cookies enabled.</li>
</ul>
<!-- INTRODUCTION -->
<h2 id="intro">Introduction</h2>
<p> phpMyAdmin can manage a whole MySQL server (needs a super-user) as well as
a single database. To accomplish the latter you'll need a properly set up
MySQL user who can read/write only the desired database. It's up to you to
look up the appropriate part in the MySQL manual.
</p>
<h3>Currently phpMyAdmin can:</h3>
<ul><li>browse and drop databases, tables, views, columns and indexes</li>
<li>create, copy, drop, rename and alter databases, tables, columns and
indexes</li>
<li>maintenance server, databases and tables, with proposals on server
configuration</li>
<li>execute, edit and bookmark any
<abbr title="structured query language">SQL</abbr>-statement, even
batch-queries</li>
<li>load text files into tables</li>
<li>create<a href="#footnote_1"><sup>1</sup></a> and read dumps of tables
</li>
<li>export<a href="#footnote_1"><sup>1</sup></a> data to various formats:
<abbr title="Comma Separated Values">CSV</abbr>,
<abbr title="Extensible Markup Language">XML</abbr>,
<abbr title="Portable Document Format">PDF</abbr>,
<abbr title="International Standards Organisation">ISO</abbr>/<abbr
title="International Electrotechnical Commission">IEC</abbr> 26300 -
OpenDocument Text and Spreadsheet,
<abbr title="Microsoft Word 2000">Word</abbr>,
and L<sup>A</sup>T<sub><em class="big">E</em></sub>X formats
</li>
<li>import data and MySQL structures from OpenDocument spreadsheets, as well as <abbr title="Extensible Markup Language">XML</abbr>, <abbr title="Comma Separated Values">CSV</abbr>, and <abbr title="Server Query Language">SQL</abbr> files</li>
<li>administer multiple servers</li>
<li>manage MySQL users and privileges</li>
<li>check referential integrity in MyISAM tables</li>
<li>using Query-by-example (QBE), create complex queries automatically
connecting required tables</li>
<li>create <abbr title="Portable Document Format">PDF</abbr> graphics of
your Database layout</li>
<li>search globally in a database or a subset of it</li>
<li>transform stored data into any format using a set of predefined
functions, like displaying BLOB-data as image or download-link
</li>
<li>track changes on databases, tables and views</li>
<li>support InnoDB tables and foreign keys <a href="#faq3_6">(see
<abbr title="Frequently Asked Questions">FAQ</abbr> 3.6)</a></li>
<li>support mysqli, the improved MySQL extension <a href="#faq1_17">
(see <abbr title="Frequently Asked Questions">FAQ</abbr> 1.17)</a></li>
<li>create, edit, call, export and drop stored procedures and functions</li>
<li>create, edit, export and drop events and triggers</li>
<li>communicate in <a href="http://www.phpmyadmin.net/home_page/translations.php">62 different languages</a>
</li>
<li>synchronize two databases residing on the same as well as remote servers
<a href="#faq9_1">(see <abbr title="Frequently Asked Questions">FAQ</abbr> 9.1)</a>
</li>
</ul>
<h4>A word about users:</h4>
<p> Many people have difficulty
understanding the concept of user management with regards to phpMyAdmin. When
a user logs in to phpMyAdmin, that username and password are passed directly
to MySQL. phpMyAdmin does no account management on its own (other than
allowing one to manipulate the MySQL user account information); all users
must be valid MySQL users.</p>
<p class="footnote" id="footnote_1">
<sup>1)</sup> phpMyAdmin can compress (Zip, GZip -RFC 1952- or Bzip2 formats)
dumps and <abbr title="comma separated values">CSV</abbr> exports if you use
PHP with Zlib support (<code>--with-zlib</code>) and/or Bzip2 support
(<code>--with-bz2</code>). Proper support may also need changes in
<code>php.ini</code>.</p>
<!-- INSTALLATION -->
<h2 id="setup">Installation</h2>
<ol><li><a href="#quick_install">Quick Install</a></li>
<li><a href="#setup_script">Setup script usage</a></li>
<li><a href="#linked-tables">phpMyAdmin configuration storage</a></li>
<li><a href="#upgrading">Upgrading from an older version</a></li>
<li><a href="#authentication_modes">Using authentication modes</a></li>
</ol>
<p class="important">
phpMyAdmin does not apply any special security methods to the MySQL database
server. It is still the system administrator's job to grant permissions on
the MySQL databases properly. phpMyAdmin's &quot;Privileges&quot; page can
be used for this.
</p>
<p class="important">
Warning for <abbr title="Apple Macintosh">Mac</abbr> users:<br />
if you are on a <abbr title="Apple Macintosh">Mac</abbr>
<abbr title="operating system">OS</abbr> version before
<abbr title="operating system">OS</abbr> X, StuffIt unstuffs with
<abbr title="Apple Macintosh">Mac</abbr> formats.<br />
So you'll have to resave as in BBEdit to Unix style ALL phpMyAdmin scripts
before uploading them to your server, as PHP seems not to like
<abbr title="Apple Macintosh">Mac</abbr>-style end of lines character
(&quot;<code>\r</code>&quot;).</p>
<h3 id="quick_install">Quick Install</h3>
<ol><li>Choose an appropriate distribution kit from the phpmyadmin.net
Downloads page. Some kits contain only the English messages,
others contain all languages in UTF-8 format (this should be fine
in most situations), others contain all
languages and all character sets. We'll assume you chose a kit whose
name looks like <code>phpMyAdmin-x.x.x-all-languages.tar.gz</code>.
</li>
<li>Untar or unzip the distribution (be sure to unzip the subdirectories):
<code>tar -xzvf phpMyAdmin_x.x.x-all-languages.tar.gz</code> in your webserver's
document root. If you don't have direct access to your document root,
put the files in a directory on your local machine, and, after step 4,
transfer the directory on your web server using, for example, ftp.</li>
<li>Ensure that all the scripts have the appropriate owner (if PHP is
running in safe mode, having some scripts with an owner different
from the owner of other scripts will be a
problem). See <a href="#faq4_2">
<abbr title="Frequently Asked Questions">FAQ</abbr> 4.2</a> and
<a href="#faq1_26"><abbr title="Frequently Asked Questions">FAQ</abbr>
1.26</a> for suggestions.</li>
<li>Now you must configure your installation. There are two methods that
can be used. Traditionally, users have hand-edited a copy of
<code>config.inc.php</code>, but now a wizard-style setup script is
provided for those who prefer a graphical installation. Creating a
<code>config.inc.php</code> is still a quick way to get started and needed for some advanced features.
<ul><li>To manually create the file, simply use your text editor to
create the file <code>config.inc.php</code> (you can copy
<code>config.sample.inc.php</code> to get minimal configuration
file) in the main (top-level) phpMyAdmin directory (the one
that contains <code>index.php</code>). phpMyAdmin first loads
<code>libraries/config.default.php</code> and then overrides those
values with anything found in <code>config.inc.php</code>. If the
default value is okay for a particular setting, there is no
need to include it in <code>config.inc.php</code>. You'll need a
few directives to get going, a simple configuration may look
like this:
<pre>
&lt;?php
$cfg['blowfish_secret'] = 'ba17c1ec07d65003'; // use here a value of your choice
$i=0;
$i++;
$cfg['Servers'][$i]['auth_type'] = 'cookie';
?&gt;
</pre>
Or, if you prefer to not be prompted every time you log in:
<pre>
&lt;?php
$i=0;
$i++;
$cfg['Servers'][$i]['user'] = 'root';
$cfg['Servers'][$i]['password'] = 'cbb74bc'; // use here your password
$cfg['Servers'][$i]['auth_type'] = 'config';
?&gt;
</pre>
For a full explanation of possible configuration values, see the
<a href="#config">Configuration Section</a> of this document.</li>
<li id="setup_script">Instead of manually editing
<code>config.inc.php</code>, you can use the
<a href="setup/">Setup Script</a>. First you must
manually create a folder <code>config</code> in the phpMyAdmin
directory. This is a security measure. On a Linux/Unix system you
can use the following commands:
<pre>
cd phpMyAdmin
mkdir config # create directory for saving
chmod o+rw config # give it world writable permissions
</pre>
And to edit an existing configuration, copy it over first:
<pre>
cp config.inc.php config/ # copy current configuration for editing
chmod o+w config/config.inc.php # give it world writable permissions
</pre>
On other platforms, simply create the folder and ensure that your
web server has read and write access to it. <a href="#faq1_26">FAQ
1.26</a> can help with this.<br /><br />
Next, open <code><a href="setup/">setup/</a>
</code>in your browser. Note that <strong>changes are not saved to
disk until explicitly choose <code>Save</code></strong> from the
<em>Configuration</em> area of the screen. Normally the script saves
the new config.inc.php to the <code>config/</code> directory, but if
the webserver does not have the proper permissions you may see the
error "Cannot load or save configuration." Ensure that the <code>
config/</code> directory exists and has the proper permissions -
or use the <code>Download</code> link to save the config file locally
and upload (via FTP or some similar means) to the proper location.<br /><br />
Once the file has been saved, it must be moved out of the <code>
config/</code> directory and the permissions must be reset, again
as a security measure:
<pre>
mv config/config.inc.php . # move file to current directory
chmod o-rw config.inc.php # remove world read and write permissions
rm -rf config # remove not needed directory
</pre>
Now the file is ready to be used. You can choose to review or edit
the file with your favorite editor, if you prefer to set some
advanced options which the setup script does not provide.</li></ul></li>
<li>If you are using the
<code>auth_type</code> &quot;config&quot;, it is suggested that you
protect the phpMyAdmin installation directory because using
config does not require a user to
enter a password to access the phpMyAdmin installation. Use of an alternate
authentication method is recommended, for example with
HTTP&#8211;AUTH in a <a href="#glossary"><em>.htaccess</em></a> file or switch to using
<code>auth_type</code> cookie or http. See the
<a href="#faqmultiuser"> multi&#8211;user sub&#8211;section</a> of this
<abbr title="Frequently Asked Questions">FAQ</abbr> for additional
information, especially <a href="#faq4_4">
<abbr title="Frequently Asked Questions">FAQ</abbr> 4.4</a>.</li>
<li>Open the <a href="index.php">main phpMyAdmin directory</a>
in your browser. phpMyAdmin should now display a welcome screen
and your databases, or a login dialog if using
<abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie
authentication mode.</li>
<li>You should deny access to the <code>./libraries</code> and
<code>./setup/lib</code> subfolders in your webserver configuration. For
Apache you can use supplied <a href="#glossary"><em>.htaccess</em></a> file in that folder, for other
webservers, you should configure this yourself. Such configuration
prevents from possible path exposure and cross side scripting
vulnerabilities that might happen to be found in that code.</li>
<li>
It is generally good idea to protect public phpMyAdmin installation
against access by robots as they usually can not do anything good
there. You can do this using <code>robots.txt</code> file in root of
your webserver or limit access by web server configuration, see
<a href="#faq1_42"><abbr title="Frequently Asked Questions">FAQ</abbr> 1.42</a>.
</li>
</ol>
<h3 id="linked-tables">phpMyAdmin configuration storage</h3>
<p> For a whole set of new features (bookmarks, comments,
<abbr title="structured query language">SQL</abbr>-history,
tracking mechanism,
<abbr title="Portable Document Format">PDF</abbr>-generation, column contents
transformation, etc.) you need to create a set of special tables. Those
tables can be located in your own database, or in a central database for a
multi-user installation (this database would then be accessed by the
controluser, so no other user should have rights to it).</p>
<p> Please look at your <code>./examples/</code> directory, where you should find a
file called <em>create_tables.sql</em>. (If you are using a Windows server, pay
special attention to <a href="#faq1_23">
<abbr title="Frequently Asked Questions">FAQ</abbr> 1.23</a>).</p>
<p> If you already had this infrastructure and upgraded to MySQL 4.1.2
or newer, please use <em>./examples/upgrade_tables_mysql_4_1_2+.sql</em>
and then create new tables by importing <em>./examples/create_tables.sql</em>.</p>
<p> You can use your phpMyAdmin to create the tables for you. Please be aware
that you may need special (administrator) privileges to create the database
and tables, and that the script may need some tuning, depending on the
database name.</p>
<p> After having imported the <em>./examples/create_tables.sql</em> file, you
should specify the table names in your <em>./config.inc.php</em> file. The
directives used for that can be found in the <a href="#config">Configuration
section</a>. You will also need to have a controluser with the proper rights
to those tables (see section <a href="#authentication_modes">Using
authentication modes</a> below).</p>
<h3 id="upgrading">Upgrading from an older version</h3>
<p> Simply copy <em>./config.inc.php</em> from your previous installation into the newly
unpacked one. Configuration files from old versions may
require some tweaking as some options have been changed or removed.
For compatibility with PHP 6, remove a <code>set_magic_quotes_runtime(0);</code>
statement that you might find near the end of your configuration file.</p>
<p> You should <strong>not</strong> copy <code>libraries/config.default.php</code>
over <code>config.inc.php</code> because the default configuration file
is version-specific.</p>
<p> If you have upgraded your MySQL server from a version previous to 4.1.2 to
version 5.x or newer and if you use the phpMyAdmin configuration storage,
you should run the <abbr title="structured query language">SQL</abbr> script
found in <code>examples/upgrade_tables_mysql_4_1_2+.sql</code>.</p>
<h3 id="authentication_modes">Using authentication modes</h3>
<ul><li><abbr title="HyperText Transfer Protocol">HTTP</abbr> and cookie
authentication modes are recommended in a <strong>multi-user environment</strong>
where you want to give users access to their own database and don't want
them to play around with others.<br />
Nevertheless be aware that MS Internet Explorer seems to be really buggy
about cookies, at least till version 6.<br />
Even in a <strong>single-user environment</strong>, you might prefer to use
<abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie mode so
that your user/password pair are not in clear in the configuration file.
</li>
<li><abbr title="HyperText Transfer Protocol">HTTP</abbr> and cookie
authentication modes are more secure: the MySQL login information does
not need to be set in the phpMyAdmin configuration file (except possibly
for the <a href="#controluser">controluser</a>).<br />
However, keep in mind that the password travels in plain text, unless
you are using the HTTPS protocol.<br />
In cookie mode, the password is stored, encrypted with the blowfish
algorithm, in a temporary cookie.</li>
<li id="pmausr">Note: this section is only applicable if
your MySQL server is running with <code>--skip-show-database</code>.<br /><br />
For '<abbr title="HyperText Transfer Protocol">HTTP</abbr>' and 'cookie'
modes, phpMyAdmin needs a controluser that has <strong>only</strong> the
<code>SELECT</code> privilege on the <em>`mysql`.`user` (all columns except
`Password`)</em>, <em>`mysql`.`db` (all columns)</em>, <em>`mysql`.`host`
(all columns)</em> and <em>`mysql`.`tables_priv` (all columns except
`Grantor` and `Timestamp`)</em> tables.<br /> You must specify the details
for the <a href="#controluser">controluser</a> in the <code>config.inc.php</code>
file under the
<code><a href="#cfg_Servers_controluser" class="configrule">
$cfg['Servers'][$i]['controluser']</a></code> and
<code><a href="#cfg_Servers_controlpass" class="configrule">
$cfg['Servers'][$i]['controlpass']</a></code> settings.<br />
The following example assumes you want to use <code>pma</code> as the
controluser and <code>pmapass</code> as the controlpass, but <strong>this is
only an example: use something else in your file!</strong> Input these
statements from the phpMyAdmin <abbr title="structured query language">SQL
</abbr> Query window or mysql command&#8211;line client.<br />
Of course you have to replace <code>localhost</code> with the webserver's host
if it's not the same as the MySQL server's one.
<pre>
GRANT USAGE ON mysql.* TO 'pma'@'localhost' IDENTIFIED BY 'pmapass';
GRANT SELECT (
Host, User, Select_priv, Insert_priv, Update_priv, Delete_priv,
Create_priv, Drop_priv, Reload_priv, Shutdown_priv, Process_priv,
File_priv, Grant_priv, References_priv, Index_priv, Alter_priv,
Show_db_priv, Super_priv, Create_tmp_table_priv, Lock_tables_priv,
Execute_priv, Repl_slave_priv, Repl_client_priv
) ON mysql.user TO 'pma'@'localhost';
GRANT SELECT ON mysql.db TO 'pma'@'localhost';
GRANT SELECT ON mysql.host TO 'pma'@'localhost';
GRANT SELECT (Host, Db, User, Table_name, Table_priv, Column_priv)
ON mysql.tables_priv TO 'pma'@'localhost';</pre>
If you want to use the many new relation and bookmark features:
<pre>
GRANT SELECT, INSERT, UPDATE, DELETE ON &lt;pma_db&gt;.* TO 'pma'@'localhost';
</pre>
(this of course requires that your <a href="#linked-tables">phpMyAdmin
configuration storage</a> be set up).
<br /></li>
<li>Then each of the <em>true</em> users should be granted a set of privileges
on a set of particular databases. Normally you shouldn't give global
privileges to an ordinary user, unless you understand the impact of those
privileges (for example, you are creating a superuser).<br />
For example, to grant the user <em>real_user</em> with all privileges on
the database <em>user_base</em>:<br />
<pre>
GRANT ALL PRIVILEGES ON user_base.* TO 'real_user'@localhost IDENTIFIED BY 'real_password';
</pre>
What the user may now do is controlled entirely by the MySQL user
management system.<br />
With <abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie
authentication mode, you don't need to fill the user/password fields
inside the <a href="#cfg_Servers" class="configrule">$cfg['Servers']</a>
array.</li>
</ul>
<h4>'<abbr title="HyperText Transfer Protocol">HTTP</abbr>' authentication mode</h4>
<ul><li>Uses <abbr title="HyperText Transfer Protocol">HTTP</abbr> Basic authentication
method and allows you to log in as any valid MySQL user.</li>
<li>Is supported with most PHP configurations. For
<abbr title="Internet Information Services">IIS</abbr>
(<abbr title="Internet Server Application Programming Interface">ISAPI</abbr>)
support using <abbr title="Common Gateway Interface">CGI</abbr> PHP see
<a href="#faq1_32"><abbr title="Frequently Asked Questions">FAQ</abbr>
1.32</a>, for using with Apache
<abbr title="Common Gateway Interface">CGI</abbr> see
<a href="#faq1_35"><abbr title="Frequently Asked Questions">FAQ</abbr>
1.35</a>.</li>
<li>See also <a href="#faq4_4">
<abbr title="Frequently Asked Questions">FAQ</abbr> 4.4</a> about not
using the <a href="#glossary"><em>.htaccess</em></a> mechanism along with
'<abbr title="HyperText Transfer Protocol">HTTP</abbr>' authentication
mode.</li>
</ul>
<h4>'cookie' authentication mode</h4>
<ul><li>You can use this method as a replacement for the
<abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication
(for example, if you're running
<abbr title="Internet Information Services">IIS</abbr>).</li>
<li>Obviously, the user must enable cookies in the browser, but this is
now a requirement for all authentication modes.</li>
<li>With this mode, the user can truly log out of phpMyAdmin and log in back
with the same username.</li>
<li>If you want to log in to arbitrary server see
<a href="#AllowArbitraryServer" class="configrule">
$cfg['AllowArbitraryServer']</a> directive.</li>
<li>As mentioned in the <a href="#require">requirements</a> section, having
the <code>mcrypt</code> extension will speed up access considerably, but is
not required.</li>
</ul>
<h4>'signon' authentication mode</h4>
<ul><li>This mode is a convenient way of using credentials from another
application to authenticate to phpMyAdmin.</li>
<li>The other application has to store login information into
session data.</li>
<li>More details in the <a href="#cfg_Servers_auth_type">auth_type</a>
section.</li>
</ul>
<h4>'config' authentication mode</h4>
<ul><li>This mode is the less secure one because it requires you to fill the
<a href="#servers_user" class="configrule">
$cfg['Servers'][$i]['user']</a> and
<a href="#servers_user" class="configrule">
$cfg['Servers'][$i]['password']</a> fields (and as a result, anyone who
can read your config.inc.php can discover your username and password).
<br />
But you don't need to setup a &quot;controluser&quot; here: using the
<a href="#servers_only_db" class="configrule">
$cfg['Servers'][$i]['only_db']</a> might be enough.</li>
<li>In the <a href="#faqmultiuser">
<abbr title="Internet service provider">ISP</abbr>
<abbr title="Frequently Asked Questions">FAQ</abbr></a> section, there
is an entry explaining how to protect your configuration file.</li>
<li>For additional security in this mode, you may wish to consider the Host
authentication
<a href="#servers_allowdeny_order" class="configrule">
$cfg['Servers'][$i]['AllowDeny']['order']</a> and
<a href="#servers_allowdeny_rules" class="configrule">
$cfg['Servers'][$i]['AllowDeny']['rules']</a> configuration
directives.</li>
<li>Unlike cookie and http, does not require a user to log in when first
loading the phpMyAdmin site. This is by design but could allow any
user to access your installation. Use of some restriction method is
suggested, perhaps a <a href="#glossary"><em>.htaccess</em></a> file with the
HTTP-AUTH directive or disallowing incoming HTTP requests at
one&#8217;s router or firewall will suffice (both of which
are beyond the scope of this manual but easily searchable with Google).</li>
</ul>
<h4 id="swekey">Swekey authentication</h4>
<p>
The Swekey is a low cost authentication USB key that can be used in
web applications.<br /><br />
When Swekey authentication is activated, phpMyAdmin requires the
users's Swekey to be plugged before entering the login page (currently
supported for cookie authentication mode only). Swekey Authentication is
disabled by default.<br /><br />
To enable it, add the following line to <code>config.inc.php</code>:
</p>
<pre>
$cfg['Servers'][$i]['auth_swekey_config'] = '/etc/swekey.conf';
</pre>
<p>
You then have to create the <code>swekey.conf</code> file that will associate
each user with their Swekey Id. It is important to place this file outside
of your web server's document root (in the example, it is located in <code>/etc</code>). A self documented sample file is provided
in the <code>examples</code> directory. Feel free to use it with your own
users' information.<br /><br />
If you want to purchase a Swekey please visit
<a href="http://phpmyadmin.net/auth_key">http://phpmyadmin.net/auth_key</a>
since this link provides funding for phpMyAdmin.
</p>
<!-- CONFIGURATION -->
<h2 id="config">Configuration</h2>
<p> <span class="important">Warning for <abbr title="Apple Macintosh">Mac</abbr>
users:</span> PHP does not seem to like
<abbr title="Apple Macintosh">Mac</abbr> end of lines character
(&quot;<code>\r</code>&quot;). So ensure you choose the option that allows to use
the *nix end of line character (&quot;<code>\n</code>&quot;) in your text editor
before saving a script you have modified.</p>
<p> <span class="important">Configuration note:</span>
Almost all configurable data is placed in <code>config.inc.php</code>. If this file
does not exist, please refer to the <a href="#setup">Quick install</a>
section to create one. This file only needs to contain the parameters you want to
change from their corresponding default value in
<code>libraries/config.default.php</code>.</p>
<p> The parameters which relate to design (like colors) are placed in
<code>themes/themename/layout.inc.php</code>. You might also want to create
<em>config.footer.inc.php</em> and <em>config.header.inc.php</em> files to add
your site specific code to be included on start and end of each page.</p>
<dl><dt id="cfg_PmaAbsoluteUri">$cfg['PmaAbsoluteUri'] string</dt>
<dd>Sets here the complete <abbr title="Uniform Resource Locator">URL</abbr>
(with full path) to your phpMyAdmin installation's directory.
E.g. <code>http://www.your_web.net/path_to_your_phpMyAdmin_directory/</code>.
Note also that the <abbr title="Uniform Resource Locator">URL</abbr> on
some web servers are case&#8211;sensitive.
Don&#8217;t forget the trailing slash at the end.<br /><br />
Starting with version 2.3.0, it is advisable to try leaving this
blank. In most cases phpMyAdmin automatically detects the proper
setting. Users of port forwarding will need to set PmaAbsoluteUri (<a
href="https://sourceforge.net/tracker/index.php?func=detail&amp;aid=1340187&amp;group_id=23067&amp;atid=377409">more info</a>).
A good test is to browse a table, edit a row and save it. There should
be an error message if phpMyAdmin is having trouble auto&#8211;detecting
the correct value. If you get an error that this must be set or if
the autodetect code fails to detect your path, please post a bug
report on our bug tracker so we can improve the code.</dd>
<dt id="cfg_PmaNoRelation_DisableWarning">$cfg['PmaNoRelation_DisableWarning'] boolean</dt>
<dd>Starting with version 2.3.0 phpMyAdmin offers a lot of features to work
with master / foreign &#8211; tables (see
<a href="#pmadb" class="configrule">$cfg['Servers'][$i]['pmadb']</a>).
<br />
If you tried to set this up and it does not work for you, have a look on
the &quot;Structure&quot; page of one database where you would like to
use it. You will find a link that will analyze why those features have
been disabled.<br />
If you do not want to use those features set this variable to
<code>TRUE</code> to stop this message from appearing.</dd>
<dt id="cfg_SuhosinDisableWarning">$cfg['SuhosinDisableWarning'] boolean</dt>
<dd>A warning is displayed on the main page if Suhosin is detected.
You can set this parameter to <code>TRUE</code> to stop this message
from appearing.</dd>
<dt id="cfg_McryptDisableWarning">$cfg['McryptDisableWarning'] boolean</dt>
<dd>Disable the default warning that is displayed if mcrypt is missing for
cookie authentication.
You can set this parameter to <code>TRUE</code> to stop this message
from appearing.</dd>
<dt id="cfg_TranslationWarningThreshold">$cfg['TranslationWarningThreshold'] integer</dt>
<dd>Show warning about incomplete translations on certain threshold.</dd>
<dt id="cfg_AllowThirdPartyFraming">$cfg['AllowThirdPartyFraming'] boolean</dt>
<dd>Setting this to <code>true</code> allows a page located on a different
domain to call phpMyAdmin inside a frame, and is a potential security
hole allowing cross-frame scripting attacks.</dd>
<dt id="cfg_blowfish_secret">$cfg['blowfish_secret'] string</dt>
<dd>The &quot;cookie&quot; auth_type uses blowfish
algorithm to encrypt the password.<br />
If you are using the &quot;cookie&quot; auth_type, enter here a random
passphrase of your choice. It will be used internally by the blowfish
algorithm: you won&#8217;t be prompted for this passphrase. There is
no maximum length for this secret.<br /><br />
Since version 3.1.0 phpMyAdmin can generate this on the fly, but it
makes a bit weaker security as this generated secret is stored in
session and furthermore it makes impossible to recall user name from
cookie.</dd>
<dt id="cfg_Servers">$cfg['Servers'] array</dt>
<dd>Since version 1.4.2, phpMyAdmin supports the administration of multiple
MySQL servers. Therefore, a
<a href="#cfg_Servers" class="configrule">$cfg['Servers']</a>-array has
been added which contains the login information for the different servers.
The first
<a href="#cfg_Servers_host" class="configrule">$cfg['Servers'][$i]['host']</a>
contains the hostname of the first server, the second
<a href="#cfg_Servers_host" class="configrule">$cfg['Servers'][$i]['host']</a>
the hostname of the second server, etc. In
<code>./libraries/config.default.php</code>, there is only one section for
server definition, however you can put as many as you need in
<code>./config.inc.php</code>, copy that block or needed parts (you don't
have to define all settings, just those you need to change).</dd>
<dt id="cfg_Servers_host">$cfg['Servers'][$i]['host'] string</dt>
<dd>The hostname or <abbr title="Internet Protocol">IP</abbr> address of your
$i-th MySQL-server. E.g. localhost.</dd>
<dt id="cfg_Servers_port">$cfg['Servers'][$i]['port'] string</dt>
<dd>The port-number of your $i-th MySQL-server. Default is 3306 (leave
blank). If you use &quot;localhost&quot; as the hostname, MySQL
ignores this port number and connects with the socket, so if you want
to connect to a port different from the default port, use
&quot;127.0.0.1&quot; or the real hostname in
<a href="#cfg_Servers_host" class="configrule">$cfg['Servers'][$i]['host']</a>.
</dd>
<dt id="cfg_Servers_socket">$cfg['Servers'][$i]['socket'] string</dt>
<dd>The path to the socket to use. Leave blank for default.<br />
To determine the correct socket, check your MySQL configuration or, using the
<code>mysql</code> command&#8211;line client, issue the <code>status</code> command.
Among the resulting information displayed will be the socket used.</dd>
<dt id="cfg_Servers_ssl">$cfg['Servers'][$i]['ssl'] boolean</dt>
<dd>Whether to enable SSL for connection to MySQL server.
</dd>
<dt id="cfg_Servers_connect_type">$cfg['Servers'][$i]['connect_type'] string</dt>
<dd>What type connection to use with the MySQL server. Your options are
<code>'socket'</code> and <code>'tcp'</code>. It defaults to 'tcp' as that
is nearly guaranteed to be available on all MySQL servers, while
sockets are not supported on some platforms.<br /><br />
To use the socket mode, your MySQL server must be on the same machine
as the Web server.</dd>
<dt id="cfg_Servers_extension">$cfg['Servers'][$i]['extension'] string</dt>
<dd>What php MySQL extension to use for the connection. Valid options are:
<br /><br />
<code><em>mysql</em></code> :
The classic MySQL extension.<br /><br />
<code><em>mysqli</em></code> :
The improved MySQL extension. This extension became available
with PHP 5.0.0 and is the recommended way to connect to a server
running MySQL 4.1.x or newer.</dd>
<dt id="cfg_Servers_compress">$cfg['Servers'][$i]['compress'] boolean</dt>
<dd>Whether to use a compressed protocol for the MySQL server connection
or not (experimental).</dd>
<dt id="controlhost">
<span id="cfg_Servers_controlhost">$cfg['Servers'][$i]['controlhost']</span> string<br />
</dt>
<dd>Permits to use an alternate host to hold the configuration storage
data.</dd>
<dt id="controluser">
<span id="cfg_Servers_controluser">$cfg['Servers'][$i]['controluser']</span> string<br />
<span id="cfg_Servers_controlpass">$cfg['Servers'][$i]['controlpass']</span> string
</dt>
<dd>This special account is used for 2 distinct purposes: to make possible
all relational features (see
<a href="#pmadb" class="configrule">$cfg['Servers'][$i]['pmadb']</a>)
and, for a MySQL server running with
<code>--skip-show-database</code>, to enable a multi-user installation
(<abbr title="HyperText Transfer Protocol">HTTP</abbr> or cookie
authentication mode).<br /><br />
When using <abbr title="HyperText Transfer Protocol">HTTP</abbr> or
cookie authentication modes (or 'config'
authentication mode since phpMyAdmin 2.2.1), you need to supply the
details of a MySQL account that has <code>SELECT</code> privilege on the
<em>mysql.user (all columns except &quot;Password&quot;)</em>,
<em>mysql.db (all columns)</em> and <em>mysql.tables_priv (all columns
except &quot;Grantor&quot; and &quot;Timestamp&quot;) </em>tables.
This account is used to check what databases the user will see at
login.<br />
Please see the <a href="#setup">install section</a> on
&quot;Using authentication modes&quot; for more information.<br /><br />
In phpMyAdmin versions before 2.2.5, those were called
&quot;stduser/stdpass&quot;.</dd>
<dt id="cfg_Servers_auth_type">$cfg['Servers'][$i]['auth_type'] string
<code>['<abbr title="HyperText Transfer Protocol">HTTP</abbr>'|'http'|'cookie'|'config'|'signon']</code></dt>
<dd>Whether config or cookie or
<abbr title="HyperText Transfer Protocol">HTTP</abbr> or signon authentication
should be used for this server.
<ul><li>'config' authentication (<code>$auth_type&nbsp;=&nbsp;'config'</code>)
is the plain old way: username and password are stored in
<em>config.inc.php</em>.</li>
<li>'cookie' authentication mode
(<code>$auth_type&nbsp;=&nbsp;'cookie'</code>) as introduced in
2.2.3 allows you to log in as any valid MySQL user with the
help of cookies. Username and password are stored in
cookies during the session and password is deleted when it
ends. This can also allow you to log in in arbitrary server if
<code><a href="#AllowArbitraryServer" class="configrule">$cfg['AllowArbitraryServer']</a></code> enabled.
</li>
<li>'<abbr title="HyperText Transfer Protocol">HTTP</abbr>' authentication (was called 'advanced' in previous versions and can be written also as 'http')
(<code>$auth_type&nbsp;=&nbsp;'<abbr title="HyperText Transfer Protocol">HTTP</abbr>'</code>) as introduced in 1.3.0
allows you to log in as any valid MySQL user via HTTP-Auth.</li>
<li>'signon' authentication mode
(<code>$auth_type&nbsp;=&nbsp;'signon'</code>)
as introduced in 2.10.0 allows you to log in from prepared PHP
session data or using supplied PHP script. This is useful for implementing single signon
from another application.
Sample way how to seed session is in signon example: <code>examples/signon.php</code>.
There is also alternative example using OpenID - <code>examples/openid.php</code> and
example for scripts based solution - <code>examples/signon-script.php</code>.
You need to
configure <a href="#cfg_Servers_SignonSession"
class="configrule">session name</a> or <a href="#cfg_Servers_SignonScript"
class="configrule">script to be executed</a> and <a
href="#cfg_Servers_SignonURL" class="configrule">signon
<abbr title="Uniform Resource Locator">URL</abbr></a> to use
this authentication method.</li>
</ul>
Please see the <a href="#setup">install section</a> on &quot;Using authentication modes&quot;
for more information.
</dd>
<dt id="servers_auth_http_realm">
<span id="cfg_Servers_auth_http_realm">$cfg['Servers'][$i]['auth_http_realm']</span> string<br />
</dt>
<dd>
When using auth_type = '<abbr title="HyperText Transfer Protocol">HTTP</abbr>', this field allows to define a custom
<abbr title="HyperText Transfer Protocol">HTTP</abbr> Basic Auth Realm which will be displayed to the user. If not explicitly
specified in your configuration, a string combined of "phpMyAdmin " and either
<a href="#cfg_Servers_verbose" class="configrule">$cfg['Servers'][$i]['verbose']</a>
or <a href="#cfg_Servers_host" class="configrule">$cfg['Servers'][$i]['host']</a> will be used.
</dd>
<dt id="servers_auth_swekey_config">
<span id="cfg_Servers_auth_swekey_config">$cfg['Servers'][$i]['auth_swekey_config']</span> string<br />
</dt>
<dd>
The name of the file containing <a href="#swekey">Swekey</a> ids and login
names for hardware authentication. Leave empty to deactivate this feature.
</dd>
<dt id="servers_user">
<span id="cfg_Servers_user">$cfg['Servers'][$i]['user']</span> string<br />
<span id="cfg_Servers_password">$cfg['Servers'][$i]['password']</span> string
</dt>
<dd>
When using auth_type = 'config', this is the user/password-pair
which phpMyAdmin will use to connect to the
MySQL server. This user/password pair is not needed when <abbr title="HyperText Transfer Protocol">HTTP</abbr> or
cookie authentication is used and should be empty.</dd>
<dt id="servers_nopassword">
<span
id="cfg_Servers_nopassword">$cfg['Servers'][$i]['nopassword']</span> boolean
</dt>
<dd>
Allow attempt to log in without password when a login with password
fails. This can be used together with http authentication, when
authentication is done some other way and phpMyAdmin gets user name
from auth and uses empty password for connecting to MySQL. Password
login is still tried first, but as fallback, no password method is
tried.</dd>
<dt id="servers_only_db">
<span id="cfg_Servers_only_db">$cfg['Servers'][$i]['only_db']</span> string or array
</dt>
<dd>
If set to a (an array of) database name(s), only this (these) database(s)
will be shown to the user. Since phpMyAdmin 2.2.1, this/these
database(s) name(s) may contain MySQL wildcards characters
(&quot;_&quot; and &quot;%&quot;): if you want to use literal instances
of these characters, escape them (I.E. use <code>'my\_db'</code> and not
<code>'my_db'</code>).<br />
This setting is an efficient way to lower the server load since the
latter does not need to send MySQL requests to build the available
database list. But <span class="important">it does not replace the
privileges rules of the MySQL database server</span>. If set, it just
means only these databases will be displayed but
<span class="important">not that all other databases can't be used.</span>
<br /><br />
An example of using more that one database:
<code>$cfg['Servers'][$i]['only_db'] = array('db1', 'db2');</code>
<br /><br />
As of phpMyAdmin 2.5.5 the order inside the array is used for sorting the
databases in the left frame, so that you can individually arrange your databases.<br />
If you want to have certain databases at the top, but don't care about the others, you do not
need to specify all other databases. Use:
<code>$cfg['Servers'][$i]['only_db'] = array('db3', 'db4', '*');</code>
instead to tell phpMyAdmin that it should display db3 and db4 on top, and the rest in alphabetic
order.</dd>
<dt><span id="cfg_Servers_hide_db">$cfg['Servers'][$i]['hide_db']</span> string
</dt>
<dd>Regular expression for hiding some databases from unprivileged users.
This only hides them
from listing, but a user is still able to access them (using, for example,
the SQL query area). To limit access, use the MySQL privilege system.
<br /><br />
For example, to hide all databases starting with the letter &#34;a&#34;, use<br />
<pre>$cfg['Servers'][$i]['hide_db'] = '^a';</pre>
and to hide both &#34;db1&#34; and &#34;db2&#34; use <br />
<pre>$cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$';</pre>
More information on regular expressions can be found in the
<a href="http://php.net/manual/en/reference.pcre.pattern.syntax.php">
PCRE pattern syntax</a> portion of the PHP reference manual.
</dd>
<dt id="cfg_Servers_verbose">$cfg['Servers'][$i]['verbose'] string</dt>
<dd>Only useful when using phpMyAdmin with multiple server entries. If set,
this string will be displayed instead of the hostname in the pull-down
menu on the main page. This can be useful if you want to show only
certain databases on your system, for example. For HTTP auth, all
non-US-ASCII characters will be stripped.</dd>
<dt id="pmadb">
<span id="cfg_Servers_pmadb">$cfg['Servers'][$i]['pmadb']</span> string
</dt>
<dd>The name of the database containing the phpMyAdmin configuration storage.
<br /><br />
See the <a href="#linked-tables">phpMyAdmin configuration storage</a>
section in this document to see the benefits of this feature,
and for a quick way of creating this database and the needed tables.
<br /><br />
If you are the only user of this phpMyAdmin installation, you can
use your current database to store those special tables; in this
case, just put your current database name in
<code>$cfg['Servers'][$i]['pmadb']</code>. For a multi-user installation,
set this parameter to the name of your central database containing
the phpMyAdmin configuration storage.</dd>
<dt id="bookmark">
<span id="cfg_Servers_bookmarktable">$cfg['Servers'][$i]['bookmarktable']</span> string
</dt>
<dd>Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This can be
useful for queries you often run.<br /><br />
To allow the usage of this functionality:
<ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
<li>enter the table name in
<code>$cfg['Servers'][$i]['bookmarktable']</code></li>
</ul>
</dd>
<dt id="relation">
<span id="cfg_Servers_relation">$cfg['Servers'][$i]['relation']</span> string
</dt>
<dd>Since release 2.2.4 you can describe, in a special 'relation' table,
which column is a key in another table (a foreign key). phpMyAdmin
currently uses this to
<ul><li>make clickable, when you browse the master table, the data values
that point to the foreign table;</li>
<li>display in an optional tool-tip the &quot;display column&quot;
when browsing the master table, if you move the mouse to a column
containing a foreign key (use also the 'table_info' table);<br />
(see <a href="#faqdisplay"><abbr title="Frequently Asked Questions">
FAQ</abbr> 6.7</a>)</li>
<li>in edit/insert mode, display a drop-down list of possible foreign
keys (key value and &quot;display column&quot; are shown)<br />
(see <a href="#faq6_21"><abbr title="Frequently Asked Questions">
FAQ</abbr> 6.21</a>)</li>
<li>display links on the table properties page, to check referential
integrity (display missing foreign keys) for each described key;
</li>
<li>in query-by-example, create automatic joins (see <a href="#faq6_6">
<abbr title="Frequently Asked Questions">FAQ</abbr> 6.6</a>)</li>
<li>enable you to get a <abbr title="Portable Document Format">PDF</abbr>
schema of your database (also uses the table_coords table).</li>
</ul>
The keys can be numeric or character.<br /><br />
To allow the usage of this functionality:
<ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin
configuration storage</li>
<li>put the relation table name in
<code>$cfg['Servers'][$i]['relation']</code></li>
<li>now as normal user open phpMyAdmin and for each one of your
tables where you want to use this feature, click
&quot;Structure/Relation view/&quot; and choose foreign
columns.
</li>
</ul>
Please note that in the current version, <code>master_db</code>
must be the same as <code>foreign_db</code>. Those columns have been put in
future development of the cross-db relations.
</dd>
<dt id="table_info">
<span id="cfg_Servers_table_info">$cfg['Servers'][$i]['table_info']</span> string
</dt>
<dd>
Since release 2.3.0 you can describe, in a special 'table_info'
table, which column is to be displayed as a tool-tip when moving the
cursor over the corresponding key.<br />
This configuration variable will hold the name of this special
table. To allow the usage of this functionality:
<ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
<li>put the table name in
<code>$cfg['Servers'][$i]['table_info']</code> (e.g.
'pma_table_info')</li>
<li>then for each table where you want to use this feature,
click &quot;Structure/Relation view/Choose column to display&quot;
to choose the column.</li>
</ul>
Usage tip: <a href="#faqdisplay">Display column</a>.
</dd>
<dt id="table_coords">
<span id="cfg_Servers_table_coords">$cfg['Servers'][$i]['table_coords']</span> string<br />
<span id="cfg_Servers_pdf_pages">$cfg['Servers'][$i]['pdf_pages']</span> string
</dt>
<dd>Since release 2.3.0 you can have phpMyAdmin create
<abbr title="Portable Document Format">PDF</abbr> pages showing
the relations between your tables. To do this it needs two tables
&quot;pdf_pages&quot; (storing information about the available
<abbr title="Portable Document Format">PDF</abbr>
pages) and &quot;table_coords&quot; (storing coordinates where each
table will be placed on a <abbr title="Portable Document Format">PDF</abbr>
schema output).<br /><br />
You must be using the &quot;relation&quot; feature.<br /><br />
To allow the usage of this functionality:
<ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
<li>put the correct table names in
<code>$cfg['Servers'][$i]['table_coords']</code> and
<code>$cfg['Servers'][$i]['pdf_pages']</code></li>
</ul>
Usage tips: <a href="#faqpdf"><abbr title="Portable Document Format">PDF</abbr> output</a>.
</dd>
<dt id="col_com">
<span id="cfg_Servers_column_info">$cfg['Servers'][$i]['column_info']</span> string
</dt>
<dd><!-- This part requires a content update! -->
Since release 2.3.0 you can store comments to describe each column for
each table. These will then be shown on the &quot;printview&quot;.
<br /><br />
Starting with release 2.5.0, comments are consequently used on the table
property pages and table browse view, showing up as tool-tips above the
column name (properties page) or embedded within the header of table in
browse view. They can also be shown in a table dump. Please see the
relevant configuration directives later on.<br /><br />
Also new in release 2.5.0 is a MIME-transformation system which is also
based on the following table structure. See <a href="#transformations">
Transformations</a> for further information. To use the
MIME-transformation system, your column_info table has to have the three
new columns 'mimetype', 'transformation', 'transformation_options'.
<br /><br />
To allow the usage of this functionality:
<ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
<li>put the table name in
<code>$cfg['Servers'][$i]['column_info']</code> (e.g.
'pma_column_info')</li>
<li>to update your PRE-2.5.0 Column_comments Table use this:
<pre>
ALTER TABLE `pma_column_comments`
ADD `mimetype` VARCHAR( 255 ) NOT NULL,
ADD `transformation` VARCHAR( 255 ) NOT NULL,
ADD `transformation_options` VARCHAR( 255 ) NOT NULL;
</pre>
and remember that the Variable in <em>config.inc.php</em> has been
renamed from<br />
<code>$cfg['Servers'][$i]['column_comments']</code> to
<code>$cfg['Servers'][$i]['column_info']</code></li>
</ul>
</dd>
<dt id="history">
<span id="cfg_Servers_history">$cfg['Servers'][$i]['history']</span> string
</dt>
<dd>Since release 2.5.0 you can store your
<abbr title="structured query language">SQL</abbr> history, which means
all queries you entered manually into the phpMyAdmin interface. If you
don't want to use a table-based history, you can use the JavaScript-based
history. Using that, all your history items are deleted when closing the
window.<br /><br />
Using
<a href="#cfg_QueryHistoryMax" class="configrule">$cfg['QueryHistoryMax']</a>
you can specify an amount of history items you want to have on hold. On
every login, this list gets cut to the maximum amount.<br /><br />
The query history is only available if JavaScript is enabled in your
browser.<br /><br />
To allow the usage of this functionality:
<ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
<li>put the table name in <code>$cfg['Servers'][$i]['history']</code>
(e.g. 'pma_history')
</li>
</ul>
</dd>
<dt id="recent">
<span id="cfg_Servers_recent">$cfg['Servers'][$i]['recent']</span> string
</dt>
<dd>
Since release 3.5.0 you can show recently used tables in the left navigation frame.
It helps you to jump across table directly, without the need to select the database,
and then select the table. Using
<a href="#cfg_LeftRecentTable" class="configrule">$cfg['LeftRecentTable']</a>
you can configure the maximum number of recent tables shown. When you select a table
from the list, it will jump to the page specified in
<a href="#cfg_LeftDefaultTabTable" class="configrule">$cfg['LeftDefaultTabTable']</a>.<br/><br/>
Without configuring the storage, you can still access the recently used tables,
but it will disappear after you logout.<br/><br/>
To allow the usage of this functionality persistently:
<ul>
<li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
<li>put the table name in <code>$cfg['Servers'][$i]['recent']</code> (e.g. 'pma_recent')</li>
</ul>
</dd>
<dt id="table_uiprefs">
<span id="cfg_Servers_table_uiprefs">$cfg['Servers'][$i]['table_uiprefs']</span> string
</dt>
<dd>
Since release 3.5.0 phpMyAdmin can be configured to remember several things
(sorted column
<a href="#cfg_RememberSorting" class="configrule">$cfg['RememberSorting']</a>
, column order, and column visibility from a database table) for browsing tables.
Without configuring the storage, these features still can be used,
but the values will disappear after you logout.<br/><br/>
To allow the usage of these functionality persistently:
<ul>
<li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
<li>put the table name in <code>$cfg['Servers'][$i]['table_uiprefs']</code> (e.g. 'pma_table_uiprefs')</li>
</ul>
</dd>
<dt id="tracking">
<span id="cfg_Servers_tracking">$cfg['Servers'][$i]['tracking']</span> string
</dt>
<dd>
Since release 3.3.x a tracking mechanism is available.
It helps you to track every <abbr title="structured query language">SQL</abbr> command which
is executed by phpMyAdmin. The mechanism supports logging of data manipulation
and data definition statements. After enabling it you can create versions of tables.
<br/><br/>
The creation of a version has two effects:
<ul>
<li>phpMyAdmin saves a snapshot of the table, including structure and indexes.</li>
<li>phpMyAdmin logs all commands which change the structure and/or data of the table and links these commands with the version number.</li>
</ul>
Of course you can view the tracked changes. On the "Tracking" page a complete report is available for every version.
For the report you can use filters, for example you can get a list of statements within a date range.
When you want to filter usernames you can enter * for all names or you enter a list of names separated by ','.
In addition you can export the (filtered) report to a file or to a temporary database.
<br/><br/>
To allow the usage of this functionality:
<ul>
<li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
<li>put the table name in <code>$cfg['Servers'][$i]['tracking']</code> (e.g. 'pma_tracking')</li>
</ul>
</dd>
<dt id="tracking2">
<span id="cfg_Servers_tracking_version_auto_create">$cfg['Servers'][$i]['tracking_version_auto_create']</span> boolean
</dt>
<dd>
Whether the tracking mechanism creates versions for tables and views automatically. Default value is false.
<br/><br/>
If this is set to true and you create a table or view with
<ul>
<li>CREATE TABLE ...</li>
<li>CREATE VIEW ...</li>
</ul>
and no version exists for it, the mechanism will
create a version for you automatically.
</dd>
<dt id="tracking3">
<span id="cfg_Servers_tracking_default_statements">$cfg['Servers'][$i]['tracking_default_statements']</span> string
</dt>
<dd>
Defines the list of statements the auto-creation uses for new versions. Default value is
<br/>
<pre>CREATE TABLE,ALTER TABLE,DROP TABLE,RENAME TABLE,
CREATE INDEX,DROP INDEX,
INSERT,UPDATE,DELETE,TRUNCATE,REPLACE,
CREATE VIEW,ALTER VIEW,DROP VIEW,
CREATE DATABASE,ALTER DATABASE,DROP DATABASE</pre>
</dd>
<dt id="tracking4">
<span id="cfg_Servers_tracking_add_drop_view">$cfg['Servers'][$i]['tracking_add_drop_view']</span> boolean
</dt>
<dd>
Whether a DROP VIEW IF EXISTS statement will be added as first line to the log when creating a view. Default value is true.
<br/><br/>
</dd>
<dt id="tracking5">
<span id="cfg_Servers_tracking_add_drop_table">$cfg['Servers'][$i]['tracking_add_drop_table']</span> boolean
</dt>
<dd>
Whether a DROP TABLE IF EXISTS statement will be added as first line to the log when creating a table. Default value is true.
<br/><br/>
</dd>
<dt id="tracking6">
<span id="cfg_Servers_tracking_add_drop_database">$cfg['Servers'][$i]['tracking_add_drop_database']</span> boolean
</dt>
<dd>
Whether a DROP DATABASE IF EXISTS statement will be added as first line to the log when creating a database. Default value is true.
<br/><br/>
</dd>
<dt id="userconfig">
<span id="cfg_Servers_userconfig">$cfg['Servers'][$i]['userconfig']</span> string
</dt>
<dd>
Since release 3.4.x phpMyAdmin allows users to set most preferences by themselves
and store them in the database.
<br /><br />
If you don't allow for storing preferences in <a href="#pmadb">pmadb</a>, users can
still personalize phpMyAdmin, but settings will be saved in browser's local storage,
or, it is is unavailable, until the end of session.
<br /><br />
To allow the usage of this functionality:
<ul>
<li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin
configuration storage</li>
<li>put the table name in <code>$cfg['Servers'][$i]['userconfig']</code></li>
</ul>
</dd>
<dt id="designer_coords">
<span id="cfg_Servers_designer_coords">$cfg['Servers'][$i]['designer_coords']</span> string
</dt>
<dd>Since release 2.10.0 a Designer interface is available; it permits
to visually manage the relations.
<br /><br />
To allow the usage of this functionality:
<ul><li>set up <a href="#pmadb">pmadb</a> and the phpMyAdmin configuration storage</li>
<li>put the table name in <code>$cfg['Servers'][$i]['designer_coords']</code> (e.g. 'pma_designer_coords')
</li>
</ul>
</dd>
<dt><span id="cfg_Servers_MaxTableUiprefs">$cfg['Servers'][$i]['MaxTableUiprefs']</span> integer
</dt>
<dd>Maximum number of rows saved in <a
href="#cfg_Servers_table_uiprefs">$cfg['Servers'][$i]['table_uiprefs']</a> table.<br /><br />
When tables are dropped or renamed, table_uiprefs may contain invalid
data (referring to tables which no longer exist).<br />
We only keep this number of newest rows in table_uiprefs and automatically delete older rows.</dd>
<dt><span id="cfg_Servers_AllowRoot">$cfg['Servers'][$i]['AllowRoot']</span>
boolean</dt>
<dd>Whether to allow root access. This is just a shortcut for the AllowDeny rules below.
</dd>
<dt><span id="cfg_Servers_AllowNoPassword">$cfg['Servers'][$i]['AllowNoPassword']</span>
boolean</dt>
<dd>Whether to allow logins without a password. The default
value of <code>false</code> for this parameter prevents unintended access
to a MySQL server with was left with an empty password for root or
on which an anonymous (blank) user is defined.
</dd>
<dt id="servers_allowdeny_order">
<span id="cfg_Servers_AllowDeny_order">$cfg['Servers'][$i]['AllowDeny']['order']</span> string
</dt>
<dd>If your rule order is empty, then <abbr title="Internet Protocol">IP</abbr>
authorization is disabled.<br /><br />
If your rule order is set to <code>'deny,allow'</code> then the system applies
all deny rules followed by allow rules. Access is allowed by default. Any
client which does not match a Deny command or does match an Allow command
will be allowed access to the server. <br /><br />
If your rule order is set to <code>'allow,deny'</code> then the system
applies all allow rules followed by deny rules. Access is denied by
default. Any client which does not match an Allow directive or does
match a Deny directive will be denied access to the server.<br /><br />
If your rule order is set to 'explicit', authorization is
performed in a similar fashion to rule order 'deny,allow', with the
added restriction that your host/username combination <strong>must</strong> be
listed in the <em>allow</em> rules, and not listed in the <em>deny</em>
rules. This is the <strong>most</strong> secure means of using Allow/Deny rules,
and was available in Apache by specifying allow and deny rules without
setting any order.<br /><br />
Please also see <a
href="#cfg_TrustedProxies">$cfg['TrustedProxies']</a> for detecting IP
address behind proxies.
</dd>
<dt id="servers_allowdeny_rules">
<span id="cfg_Servers_AllowDeny_rules">$cfg['Servers'][$i]['AllowDeny']['rules']</span> array of strings
</dt>
<dd>The general format for the rules is as such:
<pre>
&lt;'allow' | 'deny'&gt; &lt;username&gt; [from] &lt;ipmask&gt;
</pre>
If you wish to match all users, it is possible to use a <code>'%'</code> as
a wildcard in the <em>username</em> field.<br />
There are a few shortcuts you can use in the <em>ipmask</em> field as
well (please note that those containing SERVER_ADDRESS might not be
available on all webservers):
<pre>
'all' -&gt; 0.0.0.0/0
'localhost' -&gt; 127.0.0.1/8
'localnetA' -&gt; SERVER_ADDRESS/8
'localnetB' -&gt; SERVER_ADDRESS/16
'localnetC' -&gt; SERVER_ADDRESS/24
</pre>
Having an empty rule list is equivalent to either using
<code>'allow % from all'</code> if your rule order is set to
<code>'deny,allow'</code> or <code>'deny % from all'</code> if your rule order
is set to <code>'allow,deny'</code> or <code>'explicit'</code>.<br /><br />
For the <abbr title="Internet Protocol">IP</abbr> matching system, the
following work:<br />
<code>xxx.xxx.xxx.xxx</code> (an exact <abbr title="Internet Protocol">IP</abbr> address)<br />
<code>xxx.xxx.xxx.[yyy-zzz]</code> (an <abbr title="Internet Protocol">IP</abbr> address range)<br />
<code>xxx.xxx.xxx.xxx/nn</code> (CIDR, Classless Inter-Domain Routing type <abbr title="Internet Protocol">IP</abbr> addresses)<br />
But the following does not work:<br />
<code>xxx.xxx.xxx.xx[yyy-zzz]</code> (partial
<abbr title="Internet Protocol">IP</abbr> address range)<br />
Also IPv6 addresses are not supported.
</dd>
<dt><span id="cfg_Servers_DisableIS">$cfg['Servers'][$i]['DisableIS']</span> boolean</dt>
<dd>Disable using <code>INFORMATION_SCHEMA</code> to retrieve information (use <code>SHOW</code> commands instead), because of speed issues when many databases are present. Currently used in some parts of the code, more to come.
</dd>
<dt><span id="cfg_Servers_ShowDatabasesCommand">$cfg['Servers'][$i]['ShowDatabasesCommand']</span> string</dt>
<dd>On a server with a huge number of databases, the default <code>SHOW
DATABASES</code> command used to fetch the name of available databases will
probably be too slow, so it can be replaced by faster commands (see
<code>libraries/config.default.php</code> for examples).
</dd>
<dt><span id="cfg_Servers_CountTables">$cfg['Servers'][$i]['CountTables']</span> boolean</dt>
<dd>Whether to count the number of tables for each database when preparing the list of databases for the navigation frame.
</dd>
<dt><span id="cfg_Servers_SignonScript">$cfg['Servers'][$i]['SignonScript']</span> string</dt>
<dd>Name of PHP script to be sourced and executed to obtain
login credentials. This is alternative approach to session based single
signon. The script needs to provide function
<code>get_login_credentials</code> which returns list of username and
password, accepting single parameter of existing username (can be empty).
See <code>examples/signon-script.php</code> for an example.
</dd>
<dt><span id="cfg_Servers_SignonSession">$cfg['Servers'][$i]['SignonSession']</span> string</dt>
<dd>Name of session which will be used for signon authentication method.
You should use something different than <code>phpMyAdmin</code>, because
this is session which phpMyAdmin uses internally. Takes effect only if
<a href="#cfg_Servers_SignonScript" class="configrule">SignonScript</a>
is not configured.
</dd>
<dt><span id="cfg_Servers_SignonURL">$cfg['Servers'][$i]['SignonURL']</span> string</dt>
<dd><abbr title="Uniform Resource Locator">URL</abbr> where user will be
redirected to log in for signon authentication method. Should be absolute
including protocol.
</dd>
<dt><span id="cfg_Servers_LogoutURL">$cfg['Servers'][$i]['LogoutURL']</span> string</dt>
<dd><abbr title="Uniform Resource Locator">URL</abbr> where user will be
redirected after logout (doesn't affect config authentication method).
Should be absolute including protocol.
</dd>
<dt id="cfg_ServerDefault">$cfg['ServerDefault'] integer</dt>
<dd>If you have more than one server configured, you can set
<code>$cfg['ServerDefault']</code> to any one of them to autoconnect to
that server when phpMyAdmin is started, or set it to 0 to be given a
list of servers without logging in.<br />
If you have only one server configured, <code>$cfg['ServerDefault']</code>
MUST be set to that server.</dd>
<dt id="cfg_AjaxEnable">$cfg['AjaxEnable'] boolean</dt>
<dd>Defines whether to refresh only parts of certain pages using Ajax
techniques. Applies only where a non-Ajax behavior is possible;
for example, the Designer feature is Ajax-only so this directive
does not apply to it.</dd>
<dt id="cfg_VersionCheck">$cfg['VersionCheck'] boolean</dt>
<dd>Enables check for latest versions using javascript on main phpMyAdmin
page.</dd>
<dt id="cfg_MaxDbList">$cfg['MaxDbList'] integer</dt>
<dd>The maximum number of database names to be displayed in the
navigation frame and the database list.</dd>
<dt id="cfg_MaxTableList">$cfg['MaxTableList'] integer</dt>
<dd>The maximum number of table names to be displayed in the
main panel's list (except on the Export page). This limit is also enforced in the navigation panel
when in Light mode.</dd>
<dt id="cfg_ShowHint">$cfg['ShowHint'] boolean</dt>
<dd>Whether or not to show hints (for example, hints when hovering over table headers).</dd>
<dt id="cfg_MaxCharactersInDisplayedSQL">$cfg['MaxCharactersInDisplayedSQL'] integer</dt>
<dd>The maximum number of characters when a <abbr title="structured query language">
SQL</abbr> query is displayed. The default limit of 1000 should be correct
to avoid the display of tons of hexadecimal codes that represent BLOBs, but
some users have real <abbr title="structured query language">SQL</abbr>
queries that are longer than 1000 characters. Also, if a query's length
exceeds this limit, this query is not saved in the history.</dd>
<dt id="cfg_OBGzip">$cfg['OBGzip'] string/boolean</dt>
<dd>Defines whether to use GZip output buffering for increased
speed in <abbr title="HyperText Transfer Protocol">HTTP</abbr> transfers.<br />
Set to true/false for enabling/disabling. When set to 'auto' (string),
phpMyAdmin tries to enable output buffering and will automatically disable
it if your browser has some problems with buffering. IE6 with a certain patch
is known to cause data corruption when having enabled buffering.</dd>
<dt id="cfg_PersistentConnections">$cfg['PersistentConnections'] boolean</dt>
<dd>Whether <a href="http://php.net/manual/en/features.persistent-connections.php">persistent connections</a>
should be used or not. Works with following extensions:
<ul>
<li>mysql (<a href="http://php.net/manual/en/function.mysql-pconnect.php">mysql_pconnect</a>),</li>
<li>mysqli (requires PHP 5.3.0 or newer, <a href="http://php.net/manual/en/mysqli.persistconns.php">more information</a>).</li>
</ul></dd>
<dt id="cfg_ForceSSL">$cfg['ForceSSL'] boolean</dt>
<dd>Whether to force using https while accessing phpMyAdmin.</dd>
<dt id="cfg_ExecTimeLimit">$cfg['ExecTimeLimit'] integer [number of seconds]</dt>
<dd>Set the number of seconds a script is allowed to run. If seconds is set
to zero, no time limit is imposed.<br />
This setting is used while importing/exporting dump files and in the
Synchronize feature but has no effect when PHP is running in safe mode.</dd>
<dt id="cfg_SessionSavePath">$cfg['SessionSavePath'] string</dt>
<dd>Path for storing session data (<a
href="http://php.net/session_save_path">session_save_path PHP parameter</a>).</dd>
<dt id="cfg_MemoryLimit">$cfg['MemoryLimit'] string [number of bytes]</dt>
<dd>Set the number of bytes a script is allowed to allocate. If set
to zero, no limit is imposed.<br />
This setting is used while importing/exporting dump files and at some
other places in phpMyAdmin so you definitely don't want to put here
a too low value. It has no effect when PHP is running in safe mode.<br />
You can also use any string as in php.ini, eg. '16M'. Ensure
you don't omit the suffix (16 means 16 bytes!)</dd>
<dt id="cfg_SkipLockedTables">$cfg['SkipLockedTables'] boolean</dt>
<dd>Mark used tables and make it possible to show databases with locked
tables (since MySQL 3.23.30).</dd>
<dt id="cfg_ShowSQL">$cfg['ShowSQL'] boolean</dt>
<dd>Defines whether <abbr title="structured query language">SQL</abbr> queries
generated by phpMyAdmin should be displayed or not.</dd>
<dt id="cfg_RetainQueryBox">$cfg['RetainQueryBox'] boolean</dt>
<dd>Defines whether the <abbr title="structured query language">SQL</abbr>
query box should be kept displayed after its submission.</dd>
<dt id="cfg_CodemirrorEnable">$cfg['CodemirrorEnable'] boolean</dt>
<dd>Defines whether to use a Javascript code editor for SQL query boxes.
CodeMirror provides syntax highlighting and line numbers. <br />
However, middle-clicking for pasting the clipboard contents in some Linux
distributions (such as Ubuntu) is not supported by all browsers.</dd>
<dt id="cfg_AllowUserDropDatabase">$cfg['AllowUserDropDatabase'] boolean</dt>
<dd>Defines whether normal users (non-administrator) are allowed to
delete their own database or not. If set as FALSE, the link &quot;Drop
Database&quot; will not be shown, and even a &quot;DROP DATABASE
mydatabase&quot; will be rejected. Quite practical for
<abbr title="Internet service provider">ISP</abbr>'s with many
customers.<br />
Please note that this limitation of <abbr title="structured query language">
SQL</abbr> queries is not as strict as when using MySQL privileges. This
is due to nature of <abbr title="structured query language">SQL</abbr> queries
which might be quite complicated. So this choice should be viewed as
help to avoid accidental dropping rather than strict privilege
limitation.</dd>
<dt id="cfg_Confirm">$cfg['Confirm'] boolean</dt>
<dd>Whether a warning (&quot;Are your really sure...&quot;) should be
displayed when you're about to lose data.</dd>
<dt id="cfg_LoginCookieRecall">$cfg['LoginCookieRecall'] boolean</dt>
<dd>Define whether the previous login should be recalled or not in cookie
authentication mode.<br /><br />
This is automatically disabled if you do not have configured
<code><a href="#cfg_blowfish_secret">$cfg['blowfish_secret']</a></code>.
</dd>
<dt id="cfg_LoginCookieValidity">$cfg['LoginCookieValidity'] integer [number of seconds]</dt>
<dd>Define how long is login cookie valid. Please note that php
configuration option <a href="http://php.net/manual/en/session.configuration.php#ini.session.gc-maxlifetime">session.gc_maxlifetime</a>
might limit session validity and if session is lost, login cookie is
also invalidated. So it is a good idea to set <code>session.gc_maxlifetime</code>
not lower than the value of $cfg['LoginCookieValidity'].</dd>
<dt id="cfg_LoginCookieStore">$cfg['LoginCookieStore'] integer [number of seconds]</dt>
<dd>Define how long login cookie should be stored in browser. Default 0
means that it will be kept for existing session. This is recommended
for not trusted environments.</dd>
<dt id="cfg_LoginCookieDeleteAll">$cfg['LoginCookieDeleteAll'] boolean</dt>
<dd>If enabled (default), logout deletes cookies for all servers,
otherwise only for current one. Setting this to false makes it easy to
forget to log out from other server, when you are using more of
them.</dd>
<dt id="cfg_UseDbSearch">$cfg['UseDbSearch'] boolean</dt>
<dd>Define whether the "search string inside database" is enabled or not.</dd>
<dt id="cfg_IgnoreMultiSubmitErrors">$cfg['IgnoreMultiSubmitErrors'] boolean</dt>
<dd>Define whether phpMyAdmin will continue executing a multi-query
statement if one of the queries fails. Default is to abort execution.</dd>
<dt id="AllowArbitraryServer">
<span id="cfg_AllowArbitraryServer">$cfg['AllowArbitraryServer']</span> boolean</dt>
<dd>If enabled, allows you to log in to arbitrary servers using cookie auth and permits to specify servers of your choice in the Synchronize dialog.
<br /><br />
<strong>NOTE:</strong> Please use this carefully, as this may allow users access to
MySQL servers behind the firewall where your
<abbr title="HyperText Transfer Protocol">HTTP</abbr> server is placed.
</dd>
<dt id ="cfg_Error_Handler_display">$cfg['Error_Handler']['display'] boolean</dt>
<dd>Whether to display errors from PHP or not.</dd>
<dt id ="cfg_Error_Handler_gather">$cfg['Error_Handler']['gather'] boolean</dt>
<dd>Whether to gather errors from PHP or not.</dd>
<dt id="cfg_LeftFrameLight">$cfg['LeftFrameLight'] boolean</dt>
<dd>Defines whether to use a select-based menu and display only the current
tables in the left frame (smaller page). Only in Non-Lightmode you can
use the feature to display nested folders using
<a href="#cfg_LeftFrameTableSeparator" class="configrule">$cfg['LeftFrameTableSeparator']</a>
</dd>
<dt id="cfg_LeftFrameDBTree">$cfg['LeftFrameDBTree'] boolean</dt>
<dd>Defines whether to display the names of databases (in the
selector) using a tree, see also
<a href="#cfg_LeftFrameDBSeparator" class="configrule">$cfg['LeftFrameDBSeparator']</a>.
</dd>
<dt id="cfg_LeftFrameDBSeparator">$cfg['LeftFrameDBSeparator']
string or array</dt>
<dd>The string used to separate the parts of the database name when showing
them in a tree. Alternatively you can specify more strings in an array
and all of them will be used as a separator.</dd>
<dt id="cfg_LeftFrameTableSeparator">$cfg['LeftFrameTableSeparator'] string</dt>
<dd>Defines a string to be used to nest table spaces. Defaults to '__'.
This means if you have tables like 'first__second__third' this will be
shown as a three-level hierarchy like: first &gt; second &gt; third.
If set to FALSE or empty, the feature is disabled. NOTE: You should
not use this separator at the beginning or end of a
table name or multiple times after another without any other
characters in between.</dd>
<dt id="cfg_LeftFrameTableLevel">$cfg['LeftFrameTableLevel'] string</dt>
<dd>Defines how many sublevels should be displayed when splitting
up tables by the above separator.</dd>
<dt id="cfg_LeftRecentTable">$cfg['LeftRecentTable'] integer</dt>
<dd>The maximum number of recently used tables shown in the left navigation
frame. Set this to 0 (zero) to disable the listing of recent tables.</dd>
<dt id="cfg_ShowTooltip">$cfg['ShowTooltip'] boolean</dt>
<dd>Defines whether to display table comment as tool-tip in left frame or
not.</dd>
<dt id="cfg_ShowTooltipAliasDB">$cfg['ShowTooltipAliasDB'] boolean</dt>
<dd>If tool-tips are enabled and a DB comment is set, this will flip the
comment and the real name. That means that if you have a table called
'user0001' and add the comment 'MyName' on it, you will see the name
'MyName' used consequently in the left frame and the tool-tip shows
the real name of the DB.</dd>
<dt id="cfg_ShowTooltipAliasTB">$cfg['ShowTooltipAliasTB'] boolean/string</dt>
<dd>Same as <a href="#cfg_ShowTooltipAliasDB" class="configrule">$cfg['ShowTooltipAliasDB']</a>, except this works for table names.
When setting this to 'nested', the Alias of the Tablename is only used
to split/nest the tables according to the
<a href="#cfg_LeftFrameTableSeparator" class="configrule">$cfg['LeftFrameTableSeparator']</a>
directive. So only the folder is called like the Alias, the tablename itself
stays the real tablename.</dd>
<dt id="cfg_LeftDisplayLogo">$cfg['LeftDisplayLogo'] boolean</dt>
<dd>Defines whether or not to display the phpMyAdmin logo at the top of the left frame.
Defaults to <code>TRUE</code>.</dd>
<dt id="cfg_LeftLogoLink">$cfg['LeftLogoLink'] string</dt>
<dd>Enter <abbr title="Uniform Resource Locator">URL</abbr> where logo in the navigation frame will point to.
For use especially with self made theme which changes this.
The default value for this is <code>main.php</code>.</dd>
<dt id="cfg_LeftLogoLinkWindow">$cfg['LeftLogoLinkWindow'] string</dt>
<dd>Whether to open the linked page in the main window (<code>main</code>)
or in a new one (<code>new</code>). Note: use <code>new</code> if you are
linking to <code>phpmyadmin.net</code>.</dd>
<dt id="cfg_LeftDisplayTableFilterMinimum">$cfg['LeftDisplayTableFilterMinimum']
integer</dt>
<dd>Defines the minimum number of tables to display a JavaScript filter box above the
list of tables in the left frame.
Defaults to <code>30</code>. To disable the filter completely some high number
can be used (e.g. 9999)</dd>
<dt id="cfg_LeftDisplayServers">$cfg['LeftDisplayServers'] boolean</dt>
<dd>Defines whether or not to display a server choice at the top of the left frame.
Defaults to FALSE.</dd>
<dt id="cfg_DisplayServersList">$cfg['DisplayServersList'] boolean</dt>
<dd>Defines whether to display this server choice as links instead of in a drop-down.
Defaults to FALSE (drop-down).</dd>
<dt id="cfg_DisplayDatabasesList">$cfg['DisplayDatabasesList'] boolean or text</dt>
<dd>Defines whether to display database choice in light navigation frame as links
instead of in a drop-down. Defaults to 'auto' - on main page list is
shown, when database is selected, only drop down is displayed.</dd>
<dt id="cfg_LeftDefaultTabTable">$cfg['LeftDefaultTabTable'] string</dt>
<dd>Defines the tab displayed by default when clicking the small
icon next to each table name in the navigation panel. Possible
values: &quot;tbl_structure.php&quot;,
&quot;tbl_sql.php&quot;, &quot;tbl_select.php&quot;,
&quot;tbl_change.php&quot; or &quot;sql.php&quot;.</dd>
<dt id="cfg_HideStructureActions">$cfg['HideStructureActions'] boolean</dt>
<dd>Defines whether the table structure actions are hidden under a
&quot;More&quot; drop-down.</dd>
<dt id="cfg_ShowStats">$cfg['ShowStats'] boolean</dt>
<dd>Defines whether or not to display space usage and statistics about databases
and tables.<br />
Note that statistics requires at least MySQL 3.23.3 and that, at this
date, MySQL doesn't return such information for Berkeley DB tables.</dd>
<dt><span id="cfg_ShowServerInfo">$cfg['ShowServerInfo'] </span>boolean</dt>
<dd>Defines whether to display detailed server information on main page.
You can additionally hide more information by using
<code><a href="#cfg_Servers_verbose">$cfg['Servers'][$i]['verbose']</a></code>.
</dd>
<dt><span id="cfg_ShowPhpInfo">$cfg['ShowPhpInfo'] </span>boolean<br />
<span id="cfg_ShowChgPassword">$cfg['ShowChgPassword'] </span>boolean<br />
<span id="cfg_ShowCreateDb">$cfg['ShowCreateDb'] </span>boolean
</dt>
<dd>Defines whether to display the &quot;PHP information&quot; and
&quot;Change password &quot; links and form for creating database or
not at the starting main (right) frame. This setting
does not check MySQL commands entered directly.<br /><br />
Please note that to block the usage of phpinfo() in scripts, you
have to put this in your <em>php.ini</em>:
<pre>disable_functions = phpinfo()</pre>
Also note that enabling the &quot;Change password &quot; link has no
effect with &quot;config&quot; authentication mode: because of the
hard coded password value in the configuration file, end users can't
be allowed to change their passwords.</dd>
<dt id="cfg_ShowDbStructureCreation">$cfg['ShowDbStructureCreation'] boolean</dt>
<dd>Defines whether the database structure page (tables list) has a
&quot;Creation&quot; column that displays when each table was created.</dd>
<dt id="cfg_ShowDbStructureLastUpdate">$cfg['ShowDbStructureLastUpdate'] boolean</dt>
<dd>Defines whether the database structure page (tables list) has a
&quot;Last update&quot; column that displays when each table was last updated.</dd>
<dt id="cfg_ShowDbStructureLastCheck">$cfg['cfg_ShowDbStructureLastCheck'] boolean</dt>
<dd>Defines whether the database structure page (tables list) has a
&quot;Last check&quot; column that displays when each table was last checked.</dd>
<dt id="cfg_NavigationBarIconic">$cfg['NavigationBarIconic'] string</dt>
<dd>Defines whether navigation bar buttons and the right panel top menu
contain text or symbols only. A value of TRUE displays icons, FALSE
displays text and 'both' displays both icons and text.</dd>
<dt id="cfg_ShowAll">$cfg['ShowAll'] boolean</dt>
<dd>Defines whether a user should be displayed a
&quot;Show all&quot; button in browse mode or not in all cases.
By default it is shown only on small tables (less than 5 &times;
<a href="#cfg_MaxRows">$cfg['MaxRows']</a> rows) to avoid performance
issues while getting too many rows.</dd>
<dt id="cfg_MaxRows">$cfg['MaxRows'] integer</dt>
<dd>Number of rows displayed when browsing a result set and no LIMIT
clause is used. If the result set contains more rows, &quot;Previous&quot; and &quot;Next&quot; links will be shown.</dd>
<dt id="cfg_Order">$cfg['Order'] string [<code>DESC</code>|<code>ASC</code>|<code>SMART</code>]</dt>
<dd>Defines whether columns are displayed in ascending (<code>ASC</code>) order,
in descending (<code>DESC</code>) order or in a &quot;smart&quot;
(<code>SMART</code>) order - I.E. descending order for columns of type TIME,
DATE, DATETIME and TIMESTAMP, ascending order else- by default.</dd>
<dt id="cfg_DisplayBinaryAsHex">$cfg['DisplayBinaryAsHex'] boolean </dt>
<dd>Defines whether the &quot;Show binary contents as HEX&quot; browse
option is ticked by default.</dd>
<dt id="cfg_ProtectBinary">$cfg['ProtectBinary'] boolean or string</dt>
<dd>Defines whether <code>BLOB</code> or <code>BINARY</code> columns are protected
from editing when browsing a table's content. Valid values are:
<ul><li><code>FALSE</code> to allow editing of all columns;</li>
<li><code>'blob'</code> to allow editing of all columns except <code>BLOBS</code>;</li>
<li><code>'noblob'</code> to disallow editing of all columns except <code>BLOBS</code>
(the opposite of <code>'blob'</code>);</li>
<li><code>'all'</code> to disallow editing of all <code>BINARY</code> or
<code>BLOB</code> columns.</li>
</ul>
</dd>
<dt id="cfg_ShowFunctionFields">$cfg['ShowFunctionFields'] boolean</dt>
<dd>Defines whether or not MySQL functions fields should be initially
displayed in edit/insert mode. Since version 2.10, the user can
toggle this setting from the interface.
</dd>
<dt id="cfg_ShowFieldTypesInDataEditView">$cfg['ShowFieldTypesInDataEditView'] boolean</dt>
<dd>Defines whether or not type fields should be initially
displayed in edit/insert mode. The user can
toggle this setting from the interface.
</dd>
<dt id="cfg_CharEditing">$cfg['CharEditing'] string</dt>
<dd>Defines which type of editing controls should be used for CHAR and
VARCHAR columns. Possible values are:
<ul><li>input - this allows to limit size of text to size of columns in
MySQL, but has problems with newlines in columns</li>
<li>textarea - no problems with newlines in columns, but also no
length limitations</li>
</ul>
Default is old behavior so input.</dd>
<dt id="cfg_MinSizeForInputField">$cfg['MinSizeForInputField'] integer</dt>
<dd>Defines the minimum size for input fields generated for CHAR and
VARCHAR columns.</dd>
<dt id="cfg_MaxSizeForInputField">$cfg['MaxSizeForInputField'] integer</dt>
<dd>Defines the maximum size for input fields generated for CHAR and
VARCHAR columns.</dd>
<dt id="cfg_InsertRows">$cfg['InsertRows'] integer</dt>
<dd>Defines the maximum number of concurrent entries for the Insert page.</dd>
<dt id="cfg_ForeignKeyMaxLimit">$cfg['ForeignKeyMaxLimit'] integer</dt>
<dd>If there are fewer items than this in the set of foreign keys, then a
drop-down box of foreign keys is presented, in the style described by the
<a href="#cfg_ForeignKeyDropdownOrder" class="configrule">$cfg['ForeignKeyDropdownOrder']</a>
setting.</dd>
<dt id="cfg_ForeignKeyDropdownOrder">$cfg['ForeignKeyDropdownOrder'] array</dt>
<dd>For the foreign key drop-down fields, there are several methods of
display, offering both the key and value data. The contents of the
array should be one or both of the following strings:
<em>'content-id'</em>, <em>'id-content'</em>.</dd>
<dt><span id="cfg_ZipDump">$cfg['ZipDump'] </span>boolean<br />
<span id="cfg_GZipDump">$cfg['GZipDump'] </span>boolean<br />
<span id="cfg_BZipDump">$cfg['BZipDump'] </span>boolean
</dt>
<dd>Defines whether to allow the use of zip/GZip/BZip2 compression when
creating a dump file</dd>
<dt><span id="cfg_CompressOnFly">$cfg['CompressOnFly'] </span>boolean<br />
</dt>
<dd>Defines whether to allow on the fly compression for GZip/BZip2
compressed exports. This doesn't affect smaller dumps and allows users to
create larger dumps that won't otherwise fit in memory due to php
memory limit. Produced files contain more GZip/BZip2 headers, but all
normal programs handle this correctly.</dd>
<dt id="cfg_PropertiesIconic">$cfg['PropertiesIconic'] string</dt>
<dd>If set to <code>TRUE</code>, will display icons instead of text for db and table
properties links (like 'Browse', 'Select', 'Insert', ...).<br /> Can be
set to <code>'both'</code> if you want icons AND text.<br />
When set to <code>FALSE</code>, will only show text.</dd>
<dt id="cfg_PropertiesNumColumns">$cfg['PropertiesNumColumns'] integer</dt>
<dd>How many columns will be utilized to display the tables on the
database property view? Default is 1 column. When setting this to a
value larger than 1, the type of the database will be omitted for more
display space.</dd>
<dt id="cfg_DefaultTabServer">$cfg['DefaultTabServer'] string</dt>
<dd>Defines the tab displayed by default on server view. Possible
values: &quot;main.php&quot; (recommended for multi-user setups),
&quot;server_databases.php&quot;, &quot;server_status.php&quot;,
&quot;server_variables.php&quot;, &quot;server_privileges.php&quot;
or &quot;server_processlist.php&quot;.</dd>
<dt id="cfg_DefaultTabDatabase">$cfg['DefaultTabDatabase'] string</dt>
<dd>Defines the tab displayed by default on database view. Possible
values: &quot;db_structure.php&quot;,
&quot;db_sql.php&quot; or &quot;db_search.php&quot;.</dd>
<dt id="cfg_DefaultTabTable">$cfg['DefaultTabTable'] string</dt>
<dd>Defines the tab displayed by default on table view. Possible
values: &quot;tbl_structure.php&quot;,
&quot;tbl_sql.php&quot;, &quot;tbl_select.php&quot;,
&quot;tbl_change.php&quot; or &quot;sql.php&quot;.</dd>
<dt id="cfg_MySQLManualBase">$cfg['MySQLManualBase'] string</dt>
<dd>If set to an <abbr title="Uniform Resource Locator">URL</abbr> which
points to the MySQL documentation (type depends
on <a href="#cfg_MySQLManualType" class="configrule">$cfg['MySQLManualType']</a>), appropriate help links are
generated.<br />
See <a href="http://dev.mysql.com/doc/">MySQL Documentation page</a>
for more information about MySQL manuals and their types.</dd>
<dt id="cfg_MySQLManualType">$cfg['MySQLManualType'] string</dt>
<dd>Type of MySQL documentation:
<ul><li>viewable - &quot;viewable online&quot;, current one used on MySQL website</li>
<li>searchable - &quot;Searchable, with user comments&quot;</li>
<li>chapters - &quot;HTML, one page per chapter&quot;</li>
<li>big - &quot;HTML, all on one page&quot;</li>
<li>none - do not show documentation links</li>
</ul>
</dd>
<dt id="cfg_DefaultLang">$cfg['DefaultLang'] string</dt>
<dd>Defines the default language to use, if not browser-defined or
user-defined.<br />
The corresponding language file needs to be in
locale/<em>code</em>/LC_MESSAGES/phpmyadmin.mo.
</dd>
<dt id="cfg_DefaultConnectionCollation">$cfg['DefaultConnectionCollation'] string</dt>
<dd>Defines the default connection collation to use, if not
user-defined.<br />
See the <a href="http://dev.mysql.com/doc/mysql/en/charset-charsets.html">MySQL
documentation</a> for list of possible values. This setting is ignored when
connected to Drizzle server.</dd>
<dt id="cfg_Lang">$cfg['Lang'] string</dt>
<dd>Force language to use.<br />
The corresponding language file needs to be in
locale/<em>code</em>/LC_MESSAGES/phpmyadmin.mo.
</dd>
<dt id="cfg_FilterLanguages">$cfg['FilterLanguages'] string</dt>
<dd>Limit list of available languages to those matching the given regular
expression. For example if you want only Czech and English, you should
set filter to <code>'^(cs|en)'</code>.</dd>
<dt id="cfg_RecodingEngine">$cfg['RecodingEngine'] string</dt>
<dd>You can select here which functions will be used for character set
conversion. Possible values are:
<ul><li>auto - automatically use available one (first is tested
iconv, then recode)</li>
<li>iconv - use iconv or libiconv functions</li>
<li>recode - use recode_string function</li>
<li>none - disable encoding conversion</li>
</ul>
Default is auto.</dd>
<dd>
Enabled charset conversion activates a pull-down menu
in the Export and Import pages, to choose the character set when
exporting a file. The default value in this menu comes from
<code>$cfg['Export']['charset']</code> and <code>$cfg['Import']['charset']</code>.
</dd>
<dt id="cfg_IconvExtraParams">$cfg['IconvExtraParams'] string</dt>
<dd>Specify some parameters for iconv used in charset conversion. See
<a href="http://www.gnu.org/software/libiconv/documentation/libiconv/iconv_open.3.html">iconv
documentation</a> for details. By default <code>//TRANSLIT</code> is
used, so that invalid characters will be transliterated.</dd>
<dt id="cfg_AvailableCharsets">$cfg['AvailableCharsets'] array</dt>
<dd>Available character sets for MySQL conversion. You can add your own (any of
supported by recode/iconv) or remove these which you don't use.
Character sets will be shown in same order as here listed, so if you
frequently use some of these move them to the top.</dd>
<dt id="cfg_TrustedProxies">$cfg['TrustedProxies'] array</dt>
<dd>Lists proxies and HTTP headers which are trusted for <a
href="#servers_allowdeny_order">IP Allow/Deny</a>. This list is by
default empty, you need to fill in some trusted proxy servers if you
want to use rules for IP addresses behind proxy.<br /><br />
The following example specifies that phpMyAdmin should trust a
HTTP_X_FORWARDED_FOR (<code>X-Forwarded-For</code>) header coming from the proxy 1.2.3.4:
<pre>
$cfg['TrustedProxies'] =
array('1.2.3.4' =&gt; 'HTTP_X_FORWARDED_FOR');
</pre>
The $cfg['Servers'][$i]['AllowDeny']['rules'] directive uses the
client's IP address as usual.
</dd>
<dt id="cfg_GD2Available">$cfg['GD2Available'] string</dt>
<dd>Specifies whether GD &gt;= 2 is available. If yes it can be used for
MIME transformations.<br />
Possible values are:
<ul><li>auto - automatically detect</li>
<li>yes - GD 2 functions can be used</li>
<li>no - GD 2 function cannot be used</li>
</ul>
Default is auto.
</dd>
<dt id="cfg_CheckConfigurationPermissions">$cfg['CheckConfigurationPermissions'] boolean</dt>
<dd>
We normally check the permissions on the configuration file to ensure
it's not world writable. However, phpMyAdmin could be installed on
a NTFS filesystem mounted on a non-Windows server, in which case the
permissions seems wrong but in fact cannot be detected. In this case
a sysadmin would set this parameter to <code>FALSE</code>. Default is <code>TRUE</code>.
</dd>
<dt id="cfg_LinkLengthLimit">$cfg['LinkLengthLimit'] integer</dt>
<dd>
Limit for length of <abbr title="Uniform Resource Locator">URL</abbr> in links.
When length would be above this limit, it is replaced by form with button.
This is required as some web servers (<abbr title="Internet Information Services">
IIS</abbr>) have problems with long <abbr title="Uniform Resource Locator">
URL</abbr>s. Default is <code>1000</code>.
</dd>
<dt
id="cfg_DisableMultiTableMaintenance">$cfg['DisableMultiTableMaintenance'] boolean</dt>
<dd>
In the database Structure page, it's possible to mark some tables then
choose an operation like optimizing for many tables. This can slow down
a server; therefore, setting this to <code>true</code> prevents this kind
of multiple maintenance operation. Default is <code>false</code>.
</dd>
<dt id="cfg_NaviWidth">$cfg['NaviWidth'] integer</dt>
<dd>Navi frame width in pixels. See <code>themes/themename/layout.inc.php</code>.
</dd>
<dt><span id="cfg_NaviBackground">$cfg['NaviBackground']</span> string [CSS color for background]<br />
<span id="cfg_MainBackground">$cfg['MainBackground']</span> string [CSS color for background]
</dt>
<dd>The background styles used for both the frames.
See <code>themes/themename/layout.inc.php</code>.</dd>
<dt id="cfg_NaviPointerBackground">$cfg['NaviPointerBackground'] string [CSS color for background]<br />
<span id="cfg_NaviPointerColor">$cfg['NaviPointerColor']</span> string [CSS color]</dt>
<dd>The style used for the pointer in the navi frame.
See <code>themes/themename/layout.inc.php</code>.</dd>
<dt id="cfg_LeftPointerEnable">$cfg['LeftPointerEnable'] boolean</dt>
<dd>A value of <code>TRUE</code> activates the navi pointer (when LeftFrameLight
is <code>FALSE</code>).</dd>
<dt id="cfg_Border">$cfg['Border'] integer</dt>
<dd>The size of a table's border. See <code>themes/themename/layout.inc.php</code>.
</dd>
<dt id="cfg_ThBackground">$cfg['ThBackground'] string [CSS color for background]<br />
<span id="cfg_ThColor">$cfg['ThColor']</span> string [CSS color]</dt>
<dd>The style used for table headers. See
<code>themes/themename/layout.inc.php</code>.</dd>
<dt id="cfg_BgcolorOne">$cfg['BgOne'] string [CSS color]</dt>
<dd>The color (HTML) #1 for table rows. See <code>themes/themename/layout.inc.php</code>.
</dd>
<dt id="cfg_BgcolorTwo">$cfg['BgTwo'] string [CSS color]</dt>
<dd>The color (HTML) #2 for table rows. See <code>themes/themename/layout.inc.php</code>.
</dd>
<dt><span id="cfg_BrowsePointerBackground">$cfg['BrowsePointerBackground'] </span>string [CSS color]<br />
<span id="cfg_BrowsePointerColor">$cfg['BrowsePointerColor'] </span>string [CSS color]<br />
<span id="cfg_BrowseMarkerBackground">$cfg['BrowseMarkerBackground'] </span>string [CSS color]<br />
<span id="cfg_BrowseMarkerColor">$cfg['BrowseMarkerColor'] </span>string [CSS color]
</dt>
<dd>The colors (HTML) uses for the pointer and the marker in browse mode.<br />
The former feature highlights the row over which your mouse is passing
and the latter lets you visually mark/unmark rows by clicking on
them. Highlighting / marking a column is done by hovering over /
clicking the column's header (outside of the text).<br />
See <code>themes/themename/layout.inc.php</code>.</dd>
<dt id="cfg_FontFamily">$cfg['FontFamily'] string</dt>
<dd>You put here a valid CSS font family value, for example
<code>arial, sans-serif</code>.<br />
See <code>themes/themename/layout.inc.php</code>.</dd>
<dt id="cfg_FontFamilyFixed">$cfg['FontFamilyFixed'] string</dt>
<dd>You put here a valid CSS font family value, for example
<code>monospace</code>. This one is used in textarea.<br />
See <code>themes/themename/layout.inc.php</code>.</dd>
<dt id="cfg_BrowsePointerEnable">$cfg['BrowsePointerEnable'] boolean</dt>
<dd>Whether to activate the browse pointer or not.</dd>
<dt id="cfg_BrowseMarkerEnable">$cfg['BrowseMarkerEnable'] boolean</dt>
<dd>Whether to activate the browse marker or not.</dd>
<dt><span id="cfg_TextareaCols">$cfg['TextareaCols'] </span>integer<br />
<span id="cfg_TextareaRows">$cfg['TextareaRows'] </span>integer<br />
<span id="cfg_CharTextareaCols">$cfg['CharTextareaCols'] </span>integer<br />
<span id="cfg_CharTextareaRows">$cfg['CharTextareaRows'] </span>integer
</dt>
<dd>Number of columns and rows for the textareas.<br />
This value will be emphasized (*2) for <abbr title="structured query language">SQL</abbr> query textareas and (*1.25) for
<abbr title="structured query language">SQL</abbr> textareas inside the query window.<br />
The Char* values are used for CHAR and VARCHAR editing (if configured
via <a href="#cfg_CharEditing">$cfg['CharEditing']</a>).</dd>
<dt><span id="cfg_LongtextDoubleTextarea">$cfg['LongtextDoubleTextarea'] </span>boolean
</dt>
<dd>Defines whether textarea for LONGTEXT columns should have double size.</dd>
<dt><span id="cfg_TextareaAutoSelect">$cfg['TextareaAutoSelect'] </span>boolean
</dt>
<dd>Defines if the whole textarea of the query box will be selected on
click.</dd>
<dt id="cfg_LimitChars">$cfg['LimitChars'] integer</dt>
<dd>Maximum number of characters shown in any non-numeric field on browse view.
Can be turned off by a toggle button on the browse page.</dd>
<dt><span id="cfg_RowActionLinks">$cfg['RowActionLinks'] </span>string
</dt>
<dd>Defines the place where table row links (Edit, Copy,
Delete) would be put when tables contents are displayed (you may
have them displayed at the left side, right side, both sides or nowhere).
&quot;left&quot; and &quot;right&quot; are parsed as &quot;top&quot;
and &quot;bottom&quot; with vertical display mode.</dd>
<dt id="cfg_DefaultDisplay">$cfg['DefaultDisplay'] string</dt>
<dd>There are 3 display modes: horizontal, horizontalflipped and vertical.
Define which one is displayed by default. The first mode displays each
row on a horizontal line, the second rotates the headers by 90
degrees, so you can use descriptive headers even though columns only
contain small values and still print them out. The vertical mode sorts
each row on a vertical lineup.
</dd>
<dt id="cfg_RememberSorting">$cfg['RememberSorting'] boolean</dt>
<dd>If enabled, remember the sorting of each table when browsing them.</dd>
<dt id="cfg_HeaderFlipType">$cfg['HeaderFlipType'] string</dt>
<dd>
The HeaderFlipType can be set to 'auto', 'css' or 'fake'. When using
'css' the rotation of the header for horizontalflipped is done via
CSS. The CSS transformation currently works only in Internet
Explorer.If set to 'fake' PHP does the transformation for you, but of
course this does not look as good as CSS. The 'auto' option enables
CSS transformation when browser supports it and use PHP based one
otherwise.
</dd>
<dt id="cfg_ShowBrowseComments">$cfg['ShowBrowseComments'] boolean<br />
<span id="cfg_ShowPropertyComments">$cfg['ShowPropertyComments'] </span>boolean
</dt>
<dd>By setting the corresponding variable to <code>TRUE</code> you can enable the
display of column comments in Browse or Property display. In browse
mode, the comments are shown inside the header. In property mode,
comments are displayed using a CSS-formatted dashed-line below the
name of the column. The comment is shown as a tool-tip for that column.
</dd>
<dt id ="cfg_SQLQuery_Edit">$cfg['SQLQuery']['Edit'] boolean</dt>
<dd>Whether to display an edit link to change a query in any SQL Query box.</dd>
<dt id ="cfg_SQLQuery_Explain">$cfg['SQLQuery']['Explain'] boolean</dt>
<dd>Whether to display a link to explain a SELECT query in any SQL Query box.</dd>
<dt id ="cfg_SQLQuery_ShowAsPHP">$cfg['SQLQuery']['ShowAsPHP'] boolean</dt>
<dd>Whether to display a link to wrap a query in PHP code in any SQL Query box.</dd>
<dt id ="cfg_SQLQuery_Validate">$cfg['SQLQuery']['Validate'] boolean</dt>
<dd>Whether to display a link to validate a query in any SQL Query box.
See also <code><a href="#cfg_SQLValidator">$cfg_SQLValidator</a></code>.</dd>
<dt id ="cfg_SQLQuery_Refresh">$cfg['SQLQuery']['Refresh'] boolean</dt>
<dd>Whether to display a link to refresh a query in any SQL Query box.</dd>
<dt id="cfg_UploadDir">$cfg['UploadDir'] string</dt>
<dd>
The name of the directory where
<abbr title="structured query language">SQL</abbr> files have been
uploaded by other means than phpMyAdmin (for example, ftp). Those files
are available under a drop-down box when you click the database or
table name, then the Import tab.
<br /><br />
If you want different directory for each user, %u will be replaced
with username.<br /><br />
Please note that the file names must have the suffix &quot;.sql&quot;
(or &quot;.sql.bz2&quot; or &quot;.sql.gz&quot; if support for
compressed formats is enabled).<br /><br />
This feature is useful when your file is too big to be uploaded via
<abbr title="HyperText Transfer Protocol">HTTP</abbr>, or when file
uploads are disabled in PHP.<br /><br />
Please note that if PHP is running in safe mode, this directory must
be owned by the same user as the owner of the phpMyAdmin scripts.
<br /><br />
See also <a href="#faq1_16">
<abbr title="Frequently Asked Questions">FAQ</abbr> 1.16</a> for
alternatives.
</dd>
<dt id="cfg_SaveDir">$cfg['SaveDir'] string</dt>
<dd>
The name of the directory where dumps can be saved.<br /><br />
If you want different directory for each user, %u will be replaced
with username.<br /><br />
Please note that the directory must exist and has to be writable for
the user running webserver.<br /><br />
Please note that if PHP is running in safe mode, this directory must
be owned by the same user as the owner of the phpMyAdmin scripts.
</dd>
<dt id="cfg_TempDir">$cfg['TempDir'] string</dt>
<dd>
The name of the directory where temporary files can be stored.
<br /><br />
This is needed for importing ESRI Shapefiles, see
<a href="#faq6_30"><abbr title="Frequently Asked Questions">FAQ</abbr>
6.30</a> and to work around limitations of <code>open_basedir</code> for uploaded
files, see <a href="#faq1_11"><abbr title="Frequently Asked Questions">FAQ</abbr>
1.11</a>.
<br /><br />
If the directory where phpMyAdmin is installed is subject to an
<code>open_basedir</code> restriction, you need to create a
temporary directory in some directory accessible by the web
server. However for security reasons, this directory should be outside
the tree published by webserver. If you cannot avoid having this
directory published by webserver, place at least an empty
<code>index.html</code> file there, so that directory listing is not
possible.
<br /><br />
This directory should have as strict permissions as possible as the only
user required to access this directory is the one who runs the
webserver. If you have root privileges, simply make this user owner of
this directory and make it accessible only by it:
<br /><br />
<pre>
chown www-data:www-data tmp
chmod 700 tmp
</pre>
If you cannot change owner of the directory, you can achieve a similar
setup using <abbr title="Access Control List">ACL</abbr>:
<pre>
chmod 700 tmp
setfacl -m "g:www-data:rwx" tmp
setfacl -d -m "g:www-data:rwx" tmp
</pre>
If neither of above works for you, you can still make the directory
<code>chmod 777</code>, but it might impose risk of other users on
system reading and writing data in this directory.
</dd>
<dt id="cfg_Export">$cfg['Export'] array</dt>
<dd>
In this array are defined default parameters for export, names of
items are similar to texts seen on export page, so you can easily
identify what they mean.
</dd>
<dt id="cfg_Export_method">$cfg['Export']['method'] string</dt>
<dd>
Defines how the export form is displayed when it loads. Valid values are:
<ul>
<li><code>quick</code> to display the minimum number of options to configure</li>
<li><code>custom</code> to display every available option to configure</li>
<li><code>custom-no-form</code> same as <code>custom</code> but does not display the option of using quick export</li>
</ul>
</dd>
<dt id="cfg_Import">$cfg['Import'] array</dt>
<dd>
In this array are defined default parameters for import, names of
items are similar to texts seen on import page, so you can easily
identify what they mean.
</dd>
<dt id="cfg_SaveCellsAtOnce">$cfg['SaveCellsAtOnce'] boolean</dt>
<dd>
Defines whether or not to save all edited cells at once in browse-mode.
</dd>
<dt id="cfg_ShowDisplayDirection">$cfg['ShowDisplayDirection'] boolean</dt>
<dd>
Defines whether or not type display direction option is shown
when browsing a table.
</dd>
<dt id="cfg_RepeatCells">$cfg['RepeatCells'] integer</dt>
<dd>
Repeat the headers every X cells, or 0 to deactivate.
</dd>
<dt id="cfg_EditInWindow">$cfg['EditInWindow'] boolean<br />
<span id="cfg_QueryWindowWidth">$cfg['QueryWindowWidth'] </span>integer<br />
<span id="cfg_QueryWindowHeight">$cfg['QueryWindowHeight'] </span>integer<br />
<span id="cfg_QueryHistoryDB">$cfg['QueryHistoryDB'] </span>boolean<br />
<span id="cfg_QueryWindowDefTab">$cfg['QueryWindowDefTab'] </span>string<br />
<span id="cfg_QueryHistoryMax">$cfg['QueryHistoryMax'] </span>integer
</dt>
<dd>
All those variables affect the query window feature. A <code><abbr title="structured query language">SQL</abbr></code> link
or icon is always displayed on the left panel. If JavaScript is enabled in
your browser, a click on this opens a distinct query window, which is
a direct interface to enter <abbr title="structured query language">SQL</abbr> queries. Otherwise, the right panel
changes to display a query box.<br /><br />
The size of this query window can be customized with
<code>$cfg['QueryWindowWidth']</code> and <code>$cfg['QueryWindowHeight']</code>
- both integers for the size in pixels. Note that normally, those
parameters will be modified in <code>layout.inc.php</code> for the
theme you are using.<br /><br />
If <code>$cfg['EditInWindow']</code> is set to true, a click on [Edit]
from the results page (in the &quot;Showing Rows&quot; section)
opens the query window and puts the current query
inside it. If set to false, clicking on the link puts the <abbr title="structured query language">SQL</abbr>
query in the right panel's query box.
<br /><br />
The usage of the JavaScript query window is recommended if you have a
JavaScript enabled browser. Basic functions are used to exchange quite
a few variables, so most 4th generation browsers should be capable to
use that feature. It currently is only tested with Internet Explorer 6
and Mozilla 1.x.
<br /><br />
If <code>$cfg['QueryHistoryDB']</code> is set to <code>TRUE</code>, all your Queries are logged
to a table, which has to be created by you (see <a
href="#history" class="configrule">$cfg['Servers'][$i]['history']</a>). If set to FALSE,
all your queries will be appended to the form, but only as long as
your window is opened they remain saved.
<br /><br />
When using the JavaScript based query window, it will always get
updated when you click on a new table/db to browse and will focus if
you click on "Edit <abbr title="structured query language">SQL</abbr>" after using a query. You can suppress updating
the query window by checking the box "Do not overwrite this query from
outside the window" below the query textarea. Then you can browse
tables/databases in the background without losing the contents of the
textarea, so this is especially useful when composing a query with
tables you first have to look in. The checkbox will get automatically
checked whenever you change the contents of the textarea. Please
uncheck the button whenever you definitely want the query window to
get updated even though you have made alterations.
<br /><br />
If <code>$cfg['QueryHistoryDB']</code> is set to <code>TRUE</code> you can specify the amount of
saved history items using <code>$cfg['QueryHistoryMax']</code>.
<br /><br />
The query window also has a custom tabbed look to group the features.
Using the variable <code>$cfg['QueryWindowDefTab']</code> you can specify the
default tab to be used when opening the query window. It can be set to
either 'sql', 'files', 'history' or 'full'.</dd>
<dt id="cfg_BrowseMIME">$cfg['BrowseMIME'] boolean</dt>
<dd>Enable <a href="#transformations">MIME-transformations</a>.</dd>
<dt id="cfg_MaxExactCount">$cfg['MaxExactCount'] integer</dt>
<dd>For InnoDB tables, determines for how large tables phpMyAdmin
should get the exact row count using <code>SELECT COUNT</code>.
If the approximate row count as returned by
<code>SHOW TABLE STATUS</code> is smaller than this value,
<code>SELECT COUNT</code> will be used, otherwise the approximate
count will be used.
</dd>
<dt id="cfg_MaxExactCountViews">$cfg['MaxExactCountViews'] integer</dt>
<dd>For VIEWs, since obtaining the exact count could have an
impact on performance, this value is the maximum to be displayed, using
a <code>SELECT COUNT ... LIMIT</code>. Setting this to 0 bypasses
any row counting.
</dd>
<dt id="cfg_NaturalOrder">$cfg['NaturalOrder'] boolean</dt>
<dd>Sorts database and table names according to natural order (for example,
t1, t2, t10). Currently implemented in the left panel (Light mode)
and in Database view, for the table list.</dd>
<dt id="cfg_InitialSlidersState">$cfg['InitialSlidersState'] string</dt>
<dd>If set to <code>'closed'</code>, the visual sliders are initially in a
closed state. A value of <code>'open'</code> does the reverse. To completely
disable all visual sliders, use <code>'disabled'</code>.</dd>
<dt id="cfg_UserprefsDisallow">$cfg['UserprefsDisallow'] array</dt>
<dd>Contains names of configuration options (keys in <code>$cfg</code> array)
that users can't set through user preferences. For possible values, refer
to <code>libraries/config/user_preferences.forms.php</code>.</dd>
<dt id="cfg_UserprefsDeveloperTab">$cfg['UserprefsDeveloperTab'] boolean</dt>
<dd>Activates in the user preferences a tab containing options for
developers of phpMyAdmin.</dd>
<dt id="cfg_TitleTable">$cfg['TitleTable'] string</dt>
<dt id="cfg_TitleDatabase">$cfg['TitleDatabase'] string</dt>
<dt id="cfg_TitleServer">$cfg['TitleServer'] string</dt>
<dt id="cfg_TitleDefault">$cfg['TitleDefault'] string</dt>
<dd>Allows you to specify window's title bar. You can use
<a href="#faq6_27">format string expansion</a>.
</dd>
<dt id="cfg_ThemePath">$cfg['ThemePath'] string</dt>
<dd>If theme manager is active, use this as the path of the subdirectory
containing all the themes.</dd>
<dt id="cfg_ThemeManager">$cfg['ThemeManager'] boolean</dt>
<dd>Enables user-selectable themes. See <a href="#faqthemes">
<abbr title="Frequently Asked Questions">FAQ</abbr> 2.7</a>.</dd>
<dt id="cfg_ThemeDefault">$cfg['ThemeDefault'] string</dt>
<dd>The default theme (a subdirectory under <code>cfg['ThemePath']</code>).</dd>
<dt id="cfg_ThemePerServer">$cfg['ThemePerServer'] boolean</dt>
<dd>Whether to allow different theme for each server.</dd>
<dt id="cfg_DefaultQueryTable">$cfg['DefaultQueryTable'] string<br />
<span id="cfg_DefaultQueryDatabase">$cfg['DefaultQueryDatabase']</span> string
</dt>
<dd>Default queries that will be displayed in query boxes when user didn't
specify any. You can use standard
<a href="#faq6_27">format string expansion</a>.
</dd>
<dt id="cfg_SQP_fmtType">$cfg['SQP']['fmtType'] string [<code>html</code>|<code>none</code>]</dt>
<dd>
The main use of the new <abbr title="structured query language">SQL</abbr> Parser is to pretty-print <abbr title="structured query language">SQL</abbr> queries. By
default we use HTML to format the query, but you can disable this by
setting this variable to <code>'none'</code>.
</dd>
<dt id="cfg_SQP_fmtInd">$cfg['SQP']['fmtInd'] float<br />
<span id="cfg_SQP">$cfg['SQP']['fmtIndUnit']</span> string [<code>em</code>|<code>px</code>|<code>pt</code>|<code>ex</code>]</dt>
<dd>For the pretty-printing of <abbr title="structured query language">SQL</abbr> queries, under some cases the part of a
query inside a bracket is indented. By changing
<code>$cfg['SQP']['fmtInd']</code> you can change the amount of this indent.
<br />Related in purpose is <code>$cfg['SQP']['fmtIndUnit']</code> which
specifies the units of the indent amount that you specified. This is
used via stylesheets.</dd>
<dt id="cfg_SQP_fmtColor">$cfg['SQP']['fmtColor'] array of string tuples</dt>
<dd>This array is used to define the colours for each type of element of
the pretty-printed <abbr title="structured query language">SQL</abbr> queries. The tuple format is<br />
<em>class</em> =&gt; [<em>HTML colour code</em> | <em>empty string</em>]<br />
If you specify an empty string for the color of a class, it is ignored
in creating the stylesheet.
You should not alter the class names, only the colour strings.<br />
<strong>Class name key:</strong>
<ul><li><strong>comment</strong> Applies to all comment sub-classes</li>
<li><strong>comment_mysql</strong> Comments as <code>"#...\n"</code></li>
<li><strong>comment_ansi</strong> Comments as <code>"-- ...\n"</code></li>
<li><strong>comment_c</strong> Comments as <code>"/*...*/"</code></li>
<li><strong>digit</strong> Applies to all digit sub-classes</li>
<li><strong>digit_hex</strong> Hexadecimal numbers</li>
<li><strong>digit_integer</strong> Integer numbers</li>
<li><strong>digit_float</strong> Floating point numbers</li>
<li><strong>punct</strong> Applies to all punctuation sub-classes</li>
<li><strong>punct_bracket_open_round</strong> Opening brackets<code>"("</code></li>
<li><strong>punct_bracket_close_round</strong> Closing brackets <code>")"</code></li>
<li><strong>punct_listsep</strong> List item Separator <code>","</code></li>
<li><strong>punct_qualifier</strong> Table/Column Qualifier <code>"."</code> </li>
<li><strong>punct_queryend</strong> End of query marker <code>";"</code></li>
<li><strong>alpha</strong> Applies to all alphabetic classes</li>
<li><strong>alpha_columnType</strong> Identifiers matching a column type</li>
<li><strong>alpha_columnAttrib</strong> Identifiers matching a database/table/column attribute</li>
<li><strong>alpha_functionName</strong> Identifiers matching a MySQL function name</li>
<li><strong>alpha_reservedWord</strong> Identifiers matching any other reserved word</li>
<li><strong>alpha_variable</strong> Identifiers matching a <abbr title="structured query language">SQL</abbr> variable <code>"@foo"</code></li>
<li><strong>alpha_identifier</strong> All other identifiers</li>
<li><strong>quote</strong> Applies to all quotation mark classes</li>
<li><strong>quote_double</strong> Double quotes <code>"</code></li>
<li><strong>quote_single</strong> Single quotes <code>'</code></li>
<li><strong>quote_backtick</strong> Backtick quotes <code>`</code></li>
</ul>
</dd>
<dt id="cfg_SQLValidator">$cfg['SQLValidator'] boolean</dt>
<dd><dl><dt id="cfg_SQLValidator_use">$cfg['SQLValidator']['use'] boolean</dt>
<dd>phpMyAdmin now supports use of the <a href="http://developer.mimer.com/validator/index.htm">Mimer <abbr title="structured query language">SQL</abbr> Validator</a> service,
as originally published on
<a href="http://developers.slashdot.org/article.pl?sid=02/02/19/1720246">Slashdot</a>.
<br />
For help in setting up your system to use the service, see the
<a href="#faqsqlvalidator"><abbr title="Frequently Asked Questions">FAQ</abbr> 6.14</a>.
</dd>
<dt id="cfg_SQLValidator_username">$cfg['SQLValidator']['username'] string<br />
<span id="cfg_SQLValidator_password">$cfg['SQLValidator']['password']</span> string</dt>
<dd>The SOAP service allows you to log in with <code>anonymous</code>
and any password, so we use those by default. Instead, if
you have an account with them, you can put your login details
here, and it will be used in place of the anonymous login.</dd>
</dl>
</dd>
<dt id="cfg_DBG">$cfg['DBG']</dt>
<dd><strong>DEVELOPERS ONLY!</strong></dd>
<dt id="cfg_DBG_sql">$cfg['DBG']['sql'] boolean</dt>
<dd><strong>DEVELOPERS ONLY!</strong><br />
Enable logging queries and execution times to be displayed in the bottom
of main page (right frame).</dd>
<dt id="cfg_DefaultFunctions">$cfg['DefaultFunctions'] array</dt>
<dd>Functions selected by default when inserting/changing row, Functions
are defined for meta types as (FUNC_NUMBER, FUNC_DATE, FUNC_CHAR,
FUNC_SPATIAL, FUNC_UUID) and for
<code>first_timestamp</code>, which is used for first timestamp column
in table.</dd>
</dl>
<!-- TRANSFORMATIONS -->
<h2 id="transformations">Transformations</h2>
<ol><li><a href="#transformationsintro">Introduction</a></li>
<li><a href="#transformationshowto">Usage</a></li>
<li><a href="#transformationsfiles">File structure</a></li>
</ol>
<h3 id="transformationsintro">1. Introduction</h3>
<p> To enable transformations, you have to setup the <code>column_info</code> table
and the proper directives. Please see the <a href="#config">Configuration
section</a> on how to do so.</p>
<p> You can apply different transformations to the contents of each column. The
transformation will take the content of each column and transform it with
certain rules defined in the selected transformation.</p>
<p> Say you have a column 'filename' which contains a filename. Normally you would
see in phpMyAdmin only this filename. Using transformations you can transform
that filename into a HTML link, so you can click inside of the phpMyAdmin
structure on the column's link and will see the file displayed in a new browser
window. Using transformation options you can also specify strings to
append/prepend to a string or the format you want the output stored in.</p>
<p> For a general overview of all available transformations and their options,
you can consult your
<em>&lt;www.your-host.com&gt;/&lt;your-install-dir&gt;/transformation_overview.php</em>
installation.</p>
<p> For a tutorial on how to effectively use transformations, see our
<a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on
the official phpMyAdmin homepage.</p>
<h3 id="transformationshowto">2. Usage</h3>
<p> Go to your <em>tbl_structure.php</em> page (i.e. reached through
clicking on the 'Structure' link for a table). There click on
&quot;Change&quot; (or change icon) and there you will see three new
fields at
the end of the line. They are called 'MIME-type', 'Browser transformation' and
'Transformation options'.</p>
<ul><li>The field 'MIME-type' is a drop-down field. Select the MIME-type
that corresponds to the column's contents. Please note that
transformations are inactive as long as no MIME-type is selected.</li>
<li>The field 'Browser transformation' is a drop-down field. You can choose from a
hopefully growing amount of pre-defined transformations. See below for information on
how to build your own transformation.<br />
There are global transformations and mimetype-bound transformations. Global transformations
can be used for any mimetype. They will take the mimetype, if necessary, into regard.
Mimetype-bound transformations usually only operate on a certain mimetype. There are
transformations which operate on the main mimetype (like 'image'), which will most likely
take the subtype into regard, and those who only operate on a
specific subtype (like 'image/jpeg').<br />
You can use transformations on mimetypes for which the function was not defined for. There
is no security check for you selected the right transformation, so take care of what the
output will be like.</li>
<li>The field 'Transformation options' is a free-type textfield. You have to enter
transform-function specific options here. Usually the transforms can operate with default
options, but it is generally a good idea to look up the overview to see which options are
necessary.<br />
Much like the ENUM/SET-Fields, you have to split up several options using the format
'a','b','c',...(NOTE THE MISSING BLANKS). This is because internally the options will be
parsed as an array, leaving the first value the first element in the array, and so
forth.<br />
If you want to specify a MIME character set you can define it in the transformation_options.
You have to put that outside of the pre-defined options of the specific mime-transform,
as the last value of the set. Use the format "'; charset=XXX'". If you use a transform,
for which you can specify 2 options and you want to append a character set, enter "'first
parameter','second parameter','charset=us-ascii'". You can, however use the defaults for
the parameters: "'','','charset=us-ascii'".</li>
</ul>
<h3 id="transformationsfiles">3. File structure</h3>
<p> All mimetypes and their transformations are defined through single files in
the directory 'libraries/transformations/'.</p>
<p> They are stored in files to ease up customization and easy adding of new
transformations.</p>
<p> Because the user cannot enter own mimetypes, it is kept sure that transformations
always work. It makes no sense to apply a transformation to a mimetype the
transform-function doesn't know to handle.</p>
<p> One can, however, use empty mime-types and global transformations which should work
for many mimetypes. You can also use transforms on a different mimetype than what they where built
for, but pay attention to option usage as well as what the transformation does to your
column.</p>
<p> There is a file called '<em>transformations.lib.php</em>' that provides some basic functions
which can be included by any other transform function.</p>
<p> There are 5 possible file names:</p>
<ol><li>A mimetype+subtype transform:<br /><br />
<code>[mimetype]_[subtype]__[transform].inc.php</code><br /><br />
Please not that mimetype and subtype are separated via '_', which shall
not be contained in their names. The transform function/filename may
contain only characters which cause no problems in the file system as
well as the PHP function naming convention.<br /><br />
The transform function will the be called
'<code>PMA_transform_[mimetype]_[subtype]__[transform]()</code>'.<br /><br />
<strong>Example:</strong><br /><br />
<code>text_html__formatted.inc.php</code><br />
<code>PMA_transform_text_html__formatted()</code></li>
<li>A mimetype (w/o subtype) transform:<br /><br />
<code>[mimetype]__[transform].inc.php</code><br /><br />
Please note that there are no single '_' characters.
The transform function/filename may contain only characters which cause
no problems in the file system as well as the PHP function naming
convention.<br /><br />
The transform function will the be called
'<code>PMA_transform_[mimetype]__[transform]()</code>'.<br /><br />
<strong>Example:</strong><br /><br />
<code>text__formatted.inc.php</code><br />
<code>PMA_transform_text__formatted()</code></li>
<li>A mimetype+subtype without specific transform function<br /><br />
<code>[mimetype]_[subtype].inc.php</code><br /><br />
Please note that there are no '__' characters in the filename. Do not
use special characters in the filename causing problems with the file
system.<br /><br />
No transformation function is defined in the file itself.<br /><br />
<strong>Example:</strong><br /><br />
<code>text_plain.inc.php</code><br />
(No function)</li>
<li>A mimetype (w/o subtype) without specific transform function<br /><br />
<code>[mimetype].inc.php</code><br /><br />
Please note that there are no '_' characters in the filename. Do not use
special characters in the filename causing problems with the file system.
<br /><br />
No transformation function is defined in the file itself.<br /><br />
<strong>Example:</strong><br /><br />
<code>text.inc.php</code><br />
(No function)</li>
<li>A global transform function with no specific mimetype<br /><br />
<code>global__[transform].inc.php</code><br /><br />
The transform function will the be called
'<code>PMA_transform_global__[transform]()</code>'.<br /><br />
<strong>Example:</strong><br /><br />
<code>global__formatted</code><br />
<code>PMA_transform_global__formatted()</code></li>
</ol>
<p> So generally use '_' to split up mimetype and subtype, and '__' to provide a
transform function.</p>
<p> All filenames containing no '__' in themselves are not shown as valid transform
functions in the dropdown.</p>
<p> Please see the libraries/transformations/TEMPLATE file for adding your own transform
function. See the libraries/transformations/TEMPLATE_MIMETYPE for adding a mimetype
without a transform function.</p>
<p> To create a new transform function please see
<code>libraries/transformations/template_generator.sh</code>.
To create a new, empty mimetype please see
<code>libraries/transformations/template_generator_mimetype.sh</code>.</p>
<p> A transform function always gets passed three variables:</p>
<ol><li><strong>$buffer</strong> - Contains the text inside of the column. This is the text,
you want to transform.</li>
<li><strong>$options</strong> - Contains any user-passed options to a transform function
as an array.</li>
<li><strong>$meta</strong> - Contains an object with information about your column.
The data is drawn from the output of the
<a href="http://www.php.net/mysql_fetch_field">mysql_fetch_field()</a>
function. This means, all object properties described on the
<a href="http://www.php.net/mysql_fetch_field">manual page</a> are
available in this variable and can be used to transform a column accordingly
to unsigned/zerofill/not_null/... properties.<br />
The $meta-&gt;mimetype variable contains the original MIME-type of the
column (i.e. 'text/plain', 'image/jpeg' etc.)</li>
</ol>
<p> Additionally you should also provide additional function to provide
information about the transformation to the user. This function should
have same name as transformation function just with appended
<code>_info</code> suffix. This function accepts no parameters and returns
array with information about the transformation. Currently following keys
can be used:
</p>
<dl>
<dt><code>info</code></dt>
<dd>Long description of the transformation.</dd>
</dl>
<!-- FAQ -->
<h2 id="faq">FAQ - Frequently Asked Questions</h2>
<ol><li><a href="#faqserver">Server</a></li>
<li><a href="#faqconfig">Configuration</a></li>
<li><a href="#faqlimitations">Known limitations</a></li>
<li><a href="#faqmultiuser">ISPs, multi-user installations</a></li>
<li><a href="#faqbrowsers">Browsers or client <abbr title="operating system">OS</abbr></a></li>
<li><a href="#faqusing">Using phpMyAdmin</a></li>
<li><a href="#faqproject">phpMyAdmin project</a></li>
<li><a href="#faqsecurity">Security</a></li>
<li><a href="#faqsynchronization">Synchronization</a></li>
</ol>
<p> Please have a look at our
<a href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on
the official phpMyAdmin homepage for in-depth coverage of phpMyAdmin's
features and or interface.</p>
<h3 id="faqserver">Server</h3>
<h4 id="faq1_1">
<a href="#faq1_1">1.1 My server is crashing each time a specific
action is required or phpMyAdmin sends a blank page or a page full of
cryptic characters to my browser, what can I do?</a></h4>
<p> Try to set the <a href="#cfg_OBGzip" class="configrule">$cfg['OBGzip']</a>
directive to <code>FALSE</code> in your <em>config.inc.php</em> file and the
<code>zlib.output_compression</code> directive to <code>Off</code> in your php
configuration file.<br /></p>
<h4 id="faq1_2">
<a href="#faq1_2">1.2 My Apache server crashes when using phpMyAdmin.</a></h4>
<p> You should first try the latest versions of Apache (and possibly MySQL).<br />
See also the
<a href="#faq1_1"><abbr title="Frequently Asked Questions">FAQ</abbr> 1.1</a>
entry about PHP bugs with output buffering.<br />
If your server keeps crashing, please ask for help in the various Apache
support groups.</p>
<h4 id="faq1_3">
<a href="#faq1_3">1.3 (withdrawn).</a></h4>
<h4 id="faq1_4">
<a href="#faq1_4">1.4 Using phpMyAdmin on
<abbr title="Internet Information Services">IIS</abbr>, I'm displayed the
error message: &quot;The specified <abbr title="Common Gateway Interface">CGI</abbr>
application misbehaved by not returning a complete set of
<abbr title="HyperText Transfer Protocol">HTTP</abbr> headers ...&quot;.</a>
</h4>
<p> You just forgot to read the <em>install.txt</em> file from the PHP distribution.
Have a look at the last message in this
<a href="http://bugs.php.net/bug.php?id=12061">bug report</a> from the
official PHP bug database.</p>
<h4 id="faq1_5">
<a href="#faq1_5">1.5 Using phpMyAdmin on
<abbr title="Internet Information Services">IIS</abbr>, I'm facing crashes
and/or many error messages with the
<abbr title="HyperText Transfer Protocol">HTTP</abbr>.</a></h4>
<p> This is a known problem with the PHP
<abbr title="Internet Server Application Programming Interface">ISAPI</abbr>
filter: it's not so stable. Please use instead the cookie authentication mode.
</p>
<h4 id="faq1_6">
<a href="#faq1_6">1.6 I can't use phpMyAdmin on PWS: nothing is displayed!</a></h4>
<p> This seems to be a PWS bug. Filippo Simoncini found a workaround (at this
time there is no better fix): remove or comment the <code>DOCTYPE</code>
declarations (2 lines) from the scripts <em>libraries/header.inc.php</em>,
<em>libraries/header_printview.inc.php</em>, <em>index.php</em>,
<em>navigation.php</em> and <em>libraries/common.lib.php</em>.</p>
<h4 id="faq1_7">
<a href="#faq1_7">1.7 How can I GZip or Bzip a dump or a
<abbr title="comma separated values">CSV</abbr> export? It does not seem to
work.</a></h4>
<p> These features are based on the <code>gzencode()</code> and <code>bzcompress()</code>
PHP functions to be more independent of the platform (Unix/Windows, Safe Mode
or not, and so on). So, you must have Zlib/Bzip2
support (<code>--with-zlib</code> and <code>--with-bz2</code>).<br /></p>
<h4 id="faq1_8">
<a href="#faq1_8">1.8 I cannot insert a text file in a table, and I get
an error about safe mode being in effect.</a></h4>
<p> Your uploaded file is saved by PHP in the &quot;upload dir&quot;, as
defined in <em>php.ini</em> by the variable <code>upload_tmp_dir</code> (usually
the system default is <em>/tmp</em>).<br />
We recommend the following setup for Apache servers running in safe mode,
to enable uploads of files while being reasonably secure:</p>
<ul><li>create a separate directory for uploads: <code>mkdir /tmp/php</code></li>
<li>give ownership to the Apache server's user.group:
<code>chown apache.apache /tmp/php</code></li>
<li>give proper permission: <code>chmod 600 /tmp/php</code></li>
<li>put <code>upload_tmp_dir = /tmp/php</code> in <em>php.ini</em></li>
<li>restart Apache</li>
</ul>
<h4 id="faq1_9">
<a href="#faq1_9">1.9 (withdrawn).</a></h4>
<h4 id="faq1_10">
<a href="#faq1_10">1.10 I'm having troubles when uploading files with
phpMyAdmin running on a secure server. My browser is Internet Explorer and
I'm using the Apache server.</a></h4>
<p> As suggested by &quot;Rob M&quot; in the phpWizard forum, add this line to
your <em>httpd.conf</em>:</p>
<pre>SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown</pre>
<p> It seems to clear up many problems between Internet Explorer and SSL.</p>
<h4 id="faq1_11">
<a href="#faq1_11">1.11 I get an 'open_basedir restriction' while
uploading a file from the query box.</a></h4>
<p> Since version 2.2.4, phpMyAdmin supports servers with open_basedir
restrictions. However you need to create temporary directory and
configure it as <a href="#cfg_TempDir" class="configrule">$cfg['TempDir']</a>.
The uploaded files will be moved there, and after execution of your
<abbr title="structured query language">SQL</abbr> commands, removed.</p>
<h4 id="faq1_12">
<a href="#faq1_12">1.12 I have lost my MySQL root password, what can I do?</a></h4>
<p> The MySQL manual explains how to
<a href="http://dev.mysql.com/doc/mysql/en/resetting-permissions.html">
reset the permissions</a>.</p>
<h4 id="faq1_13">
<a href="#faq1_13">1.13 (withdrawn).</a></h4>
<h4 id="faq1_14">
<a href="#faq1_14">1.14 (withdrawn).</a></h4>
<h4 id="faq1_15">
<a href="#faq1_15">1.15 I have problems with <em>mysql.user</em> column names.</a>
</h4>
<p> In previous MySQL versions, the <code>User</code> and <code>Password</code>columns
were named <code>user</code> and <code>password</code>. Please modify your column
names to align with current standards.</p>
<h4 id="faq1_16">
<a href="#faq1_16">1.16 I cannot upload big dump files (memory,
<abbr title="HyperText Transfer Protocol">HTTP</abbr> or timeout problems).</a>
</h4>
<p> Starting with version 2.7.0, the import engine has been re&#8211;written and these
problems should not occur. If possible, upgrade your phpMyAdmin to the latest version
to take advantage of the new import features.</p>
<p> The first things to check (or ask your host provider to check) are the
values of <code>upload_max_filesize</code>, <code>memory_limit</code> and
<code>post_max_size</code> in the <em>php.ini</em> configuration file.
All of these three settings limit the maximum size of data that can be
submitted and handled by PHP. One user also said that
<code>post_max_size</code>
and <code>memory_limit</code> need to be larger than <code>upload_max_filesize</code>.<br /> <br />
There exist several workarounds if your upload is too big or your
hosting provider is unwilling to change the settings:</p>
<ul><li>Look at the <a href="#cfg_UploadDir" class="configrule">$cfg['UploadDir']</a>
feature. This allows one to
upload a file to the server via scp, ftp, or your favorite file transfer
method. PhpMyAdmin is then able to import the files from the temporary
directory. More information is available in the <a href="#config">Configuration
section</a> of this document.</li>
<li>Using a utility (such as <a href="http://www.ozerov.de/bigdump.php">
BigDump</a>) to split the files before uploading. We cannot support this
or any third party applications, but are aware of users having success
with it.</li>
<li>If you have shell (command line) access, use MySQL to import the files
directly. You can do this by issuing the &quot;source&quot; command from
within MySQL: <code>source <em>filename.sql</em></code>.</li>
</ul>
<h4 id="faq1_17">
<a id="faqmysqlversions" href="#faq1_17">1.17 Which MySQL versions does phpMyAdmin
support?</a></h4>
<p> Since phpMyAdmin 3.0.x, only MySQL 5.0.1 and newer are supported. For
older MySQL versions, you need to use the latest 2.x branch. phpMyAdmin can
connect to your MySQL server using PHP's classic
<a href="http://php.net/mysql">MySQL extension</a> as well as the
<a href="http://php.net/mysqli">improved MySQL extension (MySQLi)</a> that
is available in PHP 5.0. The latter one should be used unless you have a
good reason not to do so.<br />
When compiling PHP, we strongly recommend that you manually link the MySQL
extension of your choice to a MySQL client library of at least the same
minor version since the one that is bundled with some PHP distributions is
rather old and might cause problems <a href="#faq1_17a">
(see <abbr title="Frequently Asked Questions">FAQ</abbr> 1.17a)</a>.<br /><br />
<a href="http://mariadb.org/">MariaDB</a> is also supported
(versions 5.1 and 5.2 were tested).<br /><br />
Since phpMyAdmin 3.5 <a href="http://www.drizzle.org/">Drizzle</a> is supported.
</p>
<h5 id="faq1_17a">
<a href="#faq1_17a">1.17a I cannot connect to the MySQL server. It always returns the error
message, &quot;Client does not support authentication protocol requested
by server; consider upgrading MySQL client&quot;</a></h5>
<p> You tried to access MySQL with an old MySQL client library. The version of
your MySQL client library can be checked in your phpinfo() output.
In general, it should have at least the same minor version as your server
- as mentioned in <a href="#faq1_17">
<abbr title="Frequently Asked Questions">FAQ</abbr> 1.17</a>.<br /><br />
This problem is generally caused by using MySQL version 4.1 or newer. MySQL
changed the authentication hash and your PHP is trying to use the old method.
The proper solution is to use the <a href="http://www.php.net/mysqli">mysqli extension</a>
with the proper client library to match your MySQL installation. Your
chosen extension is specified in <a href="#cfg_Servers_extension" class="configrule">$cfg['Servers'][$i]['extension']</a>.
More information (and several workarounds) are located in the
<a href="http://dev.mysql.com/doc/mysql/en/old-client.html">MySQL Documentation</a>.
</p>
<h4 id="faq1_18">
<a href="#faq1_18">1.18 (withdrawn).</a></h4>
<h4 id="faq1_19">
<a href="#faq1_19">1.19 I can't run the &quot;display relations&quot; feature because the
script seems not to know the font face I'm using!</a></h4>
<p> The &quot;FPDF&quot; library we're using for this feature requires some
special files to use font faces.<br />
Please refers to the <a href="http://www.fpdf.org/">FPDF manual</a> to build
these files.</p>
<h4 id="faqmysql">
<a href="#faqmysql">1.20 I receive the error &quot;cannot load MySQL extension, please
check PHP Configuration&quot;.</a></h4>
<p> To connect to a MySQL server, PHP needs a set of MySQL functions called
&quot;MySQL extension&quot;. This extension may be part of the PHP
distribution (compiled-in), otherwise it needs to be loaded dynamically. Its
name is probably <em>mysql.so</em> or <em>php_mysql.dll</em>. phpMyAdmin tried
to load the extension but failed.<br /><br />
Usually, the problem is solved by installing a software package called
&quot;PHP-MySQL&quot; or something similar.</p>
<h4 id="faq1_21">
<a href="#faq1_21">1.21 I am running the
<abbr title="Common Gateway Interface">CGI</abbr> version of PHP under Unix,
and I cannot log in using cookie auth.</a></h4>
<p> In <em>php.ini</em>, set <code>mysql.max_links</code> higher than 1.</p>
<h4 id="faq1_22">
<a href="#faq1_22">1.22 I don't see the &quot;Location of text file&quot; field,
so I cannot upload.</a></h4>
<p> This is most likely because in <em>php.ini</em>, your <code>file_uploads</code>
parameter is not set to &quot;on&quot;.</p>
<h4 id="faq1_23">
<a href="#faq1_23">1.23 I'm running MySQL on a Win32 machine. Each time I create
a new table the table and column names are changed to lowercase!</a></h4>
<p> This happens because the MySQL directive <code>lower_case_table_names</code>
defaults to 1 (<code>ON</code>) in the Win32 version of MySQL. You can change
this behavior by simply changing the directive to 0 (<code>OFF</code>):<br />
Just edit your <code>my.ini</code> file that should be located in your Windows
directory and add the following line to the group [mysqld]:</p>
<pre>set-variable = lower_case_table_names=0</pre>
<p> Next, save the file and restart the MySQL service. You can always check the
value of this directive using the query</p>
<pre>SHOW VARIABLES LIKE 'lower_case_table_names';</pre>
<h4 id="faq1_24">
<a href="#faq1_24">1.24 (withdrawn).</a></h4>
<h4 id="faq1_25">
<a href="#faq1_25">1.25 I am running Apache with mod_gzip-1.3.26.1a on Windows XP,
and I get problems, such as undefined variables when I run a
<abbr title="structured query language">SQL</abbr> query.</a></h4>
<p> A tip from Jose Fandos: put a comment on the following two lines
in httpd.conf, like this:</p>
<pre>
# mod_gzip_item_include file \.php$
# mod_gzip_item_include mime "application/x-httpd-php.*"
</pre>
<p> as this version of mod_gzip on Apache (Windows) has problems handling
PHP scripts. Of course you have to restart Apache.</p>
<h4 id="faq1_26">
<a href="#faq1_26">1.26 I just installed phpMyAdmin in my document root of
<abbr title="Internet Information Services">IIS</abbr> but
I get the error &quot;No input file specified&quot; when trying to
run phpMyAdmin.</a></h4>
<p> This is a permission problem. Right-click on the phpmyadmin folder
and choose properties. Under the tab Security, click on &quot;Add&quot;
and select the user &quot;IUSR_machine&quot; from the list. Now set his
permissions and it should work.</p>
<h4 id="faq1_27">
<a href="#faq1_27">1.27 I get empty page when I want to view huge page (eg.
db_structure.php with plenty of tables).</a></h4>
<p> This is a <a href="http://bugs.php.net/21079">PHP bug</a> that occur when
GZIP output buffering is enabled. If you turn off it (by
<a href="#cfg_OBGzip" class="configrule">$cfg['OBGzip'] = false</a>
in <em>config.inc.php</em>), it should work. This bug will be fixed in
PHP&nbsp;5.0.0.</p>
<h4 id="faq1_28">
<a href="#faq1_28">1.28 My MySQL server sometimes refuses queries and returns the
message 'Errorcode: 13'. What does this mean?</a></h4>
<p> This can happen due to a MySQL bug when having database / table names with
upper case characters although <code>lower_case_table_names</code> is set to 1.
To fix this, turn off this directive, convert all database and table names
to lower case and turn it on again. Alternatively, there's a bug-fix
available starting with MySQL&nbsp;3.23.56 / 4.0.11-gamma.</p>
<h4 id="faq1_29">
<a href="#faq1_29">1.29 When I create a table or modify a column, I get an error
and the columns are duplicated.</a></h4>
<p> It is possible to configure Apache in such a way that PHP has problems
interpreting .php files.</p>
<p> The problems occur when two different (and conflicting) set of directives
are used:</p>
<pre>
SetOutputFilter PHP
SetInputFilter PHP
</pre>
<p> and</p>
<pre>AddType application/x-httpd-php .php</pre>
<p> In the case we saw, one set of directives was in
<code>/etc/httpd/conf/httpd.conf</code>, while
the other set was in <code>/etc/httpd/conf/addon-modules/php.conf</code>.<br />
The recommended way is with <code>AddType</code>, so just comment out
the first set of lines and restart Apache:</p>
<pre>
#SetOutputFilter PHP
#SetInputFilter PHP
</pre>
<h4 id="faq1_30">
<a href="#faq1_30">1.30 I get the error &quot;navigation.php: Missing hash&quot;.</a></h4>
<p> This problem is known to happen when the server is running Turck MMCache
but upgrading MMCache to version 2.3.21 solves the problem.</p>
<h4 id="faq1_31">
<a href="#faq1_31">1.31 Does phpMyAdmin support php5?</a></h4>
<p>Yes.</p>
<p>
Since release 3.0 only PHP 5.2 and newer. For older PHP versions 2.9 branch
is still maintained.
</p>
<h4 id="faq1_32">
<a href="#faq1_32">1.32 Can I use <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication with <abbr title="Internet Information Services">IIS</abbr>?</a></h4>
<p> Yes. This procedure was tested with phpMyAdmin 2.6.1, PHP 4.3.9 in <abbr title="Internet Server Application Programming Interface">ISAPI</abbr>
mode under <abbr title="Internet Information Services">IIS</abbr> 5.1.</p>
<ol><li>In your <code>php.ini</code> file, set <code>cgi.rfc2616_headers = 0</code></li>
<li>In <code>Web Site Properties -&gt; File/Directory Security -&gt; Anonymous
Access</code> dialog box, check the <code>Anonymous access</code> checkbox and
uncheck any other checkboxes (i.e. uncheck <code>Basic authentication</code>,
<code>Integrated Windows authentication</code>, and <code>Digest</code> if it's
enabled.) Click <code>OK</code>.</li>
<li>In <code>Custom Errors</code>, select the range of <code>401;1</code> through
<code>401;5</code> and click the <code>Set to Default</code> button.</li>
</ol>
<h4 id="faq1_33">
<a href="#faq1_33">1.33 (withdrawn).</a></h4>
<h4 id="faq1_34">
<a href="#faq1_34">1.34 Can I access directly to database or table pages?</a></h4>
<p> Yes. Out of the box, you can use <abbr title="Uniform Resource Locator">URL</abbr>s like
http://server/phpMyAdmin/index.php?server=X&amp;db=database&amp;table=table&amp;target=script. For <code>server</code> you use the server number which refers to
the order of the server paragraph in <code>config.inc.php</code>.
Table and script parts are optional. If you want
http://server/phpMyAdmin/database[/table][/script] <abbr title="Uniform Resource Locator">URL</abbr>s, you need to do
some configuration. Following lines apply only for <a
href="http://httpd.apache.org">Apache</a> web server. First make sure,
that you have enabled some features within global configuration. You need
<code>Options FollowSymLinks</code> and <code>AllowOverride
FileInfo</code> enabled for directory where phpMyAdmin is installed and
you need mod_rewrite to be enabled. Then you just need to create following
<a href="#glossary"><em>.htaccess</em></a> file in root folder of phpMyAdmin installation
(don't forget to change directory name inside of it):</p>
<pre>
RewriteEngine On
RewriteBase /path_to_phpMyAdmin
RewriteRule ^([a-zA-Z0-9_]+)/([a-zA-Z0-9_]+)/([a-z_]+\.php)$ index.php?db=$1&amp;table=$2&amp;target=$3 [R]
RewriteRule ^([a-zA-Z0-9_]+)/([a-z_]+\.php)$ index.php?db=$1&amp;target=$2 [R]
RewriteRule ^([a-zA-Z0-9_]+)/([a-zA-Z0-9_]+)$ index.php?db=$1&amp;table=$2 [R]
RewriteRule ^([a-zA-Z0-9_]+)$ index.php?db=$1 [R]
</pre>
<h4 id="faq1_35">
<a href="#faq1_35">1.35 Can I use <abbr title="HyperText Transfer Protocol">HTTP</abbr> authentication with Apache <abbr title="Common Gateway Interface">CGI</abbr>?</a></h4>
<p> Yes. However you need to pass authentication variable to <abbr title="Common Gateway Interface">CGI</abbr> using
following rewrite rule:</p>
<pre>
RewriteEngine On
RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization},L]
</pre>
<h4 id="faq1_36">
<a href="#faq1_36">1.36 I get an error &quot;500 Internal Server Error&quot;.</a>
</h4>
<p>
There can be many explanations to this and a look at your server's
error log file might give a clue.
</p>
<h4 id="faq1_37">
<a href="#faq1_37">1.37 I run phpMyAdmin on cluster of different machines and
password encryption in cookie auth doesn't work.</a></h4>
<p> If your cluster consist of different architectures, PHP code used for
encryption/decryption won't work correct. This is caused by use of
pack/unpack functions in code. Only solution is to use mcrypt extension
which works fine in this case.</p>
<h4 id="faq1_38">
<a href="#faq1_38">1.38 Can I use phpMyAdmin on a server on which Suhosin is enabled?</a></h4>
<p> Yes but the default configuration values of Suhosin are known to cause
problems with some operations, for example editing a table with many
columns and no primary key or with textual primary key.
</p>
<p>
Suhosin configuration might lead to malfunction in some cases and it can
not be fully avoided as phpMyAdmin is kind of application which needs to
transfer big amounts of columns in single HTTP request, what is something
what Suhosin tries to prevent. Generally all
<code>suhosin.request.*</code>, <code>suhosin.post.*</code> and
<code>suhosin.get.*</code> directives can have negative effect on
phpMyAdmin usability. You can always find in your error logs which limit
did cause dropping of variable, so you can diagnose the problem and adjust
matching configuration variable.
</p>
<p>
The default values for most Suhosin configuration options will work in most
scenarios, however you might want to adjust at least following parameters:
</p>
<ul>
<li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.request.max_vars">suhosin.request.max_vars</a> should be increased (eg. 2048)</li>
<li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.post.max_vars">suhosin.post.max_vars</a> should be increased (eg. 2048)</li>
<li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.request.max_array_index_length">suhosin.request.max_array_index_length</a> should be increased (eg. 256)</li>
<li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.post.max_array_index_length">suhosin.post.max_array_index_length</a> should be increased (eg. 256)</li>
<li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.request.max_totalname_length">suhosin.request.max_totalname_length</a> should be increased (eg. 8192)</li>
<li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.post.max_totalname_length">suhosin.post.max_totalname_length</a> should be increased (eg. 8192)</li>
<li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.get.max_value_length">suhosin.get.max_value_length</a> should be increased (eg. 1024)</li>
<li><a href="http://www.hardened-php.net/suhosin/configuration.html#suhosin.sql.bailout_on_error">suhosin.sql.bailout_on_error</a> needs to be disabled (the default)</li>
<li><a href="http://www.hardened-php.net/suhosin/configuration.html#logging_configuration">suhosin.log.*</a> should not include <abbr title="structured query language">SQL</abbr>, otherwise you get big slowdown</li>
</ul>
<p>
You can also disable the warning using the <a href="#cfg_SuhosinDisableWarning">
<code>SuhosinDisableWarning</code> directive</a>.
</p>
<h4 id="faq1_39">
<a href="#faq1_39">1.39 When I try to connect via https, I can log in,
but then my connection is redirected back to http. What can cause this
behavior?</a></h4>
<p> Be sure that you have enabled <code>SSLOptions</code> and <code>StdEnvVars</code>
in your Apache configuration. See <a href="http://httpd.apache.org/docs/2.0/mod/mod_ssl.html#ssloptions">http://httpd.apache.org/docs/2.0/mod/mod_ssl.html#ssloptions</a>.</p>
<h4 id="faq1_40">
<a href="#faq1_40">1.40 When accessing phpMyAdmin via an Apache reverse proxy, cookie login does not work.</a></h4>
<p>To be able to use cookie auth Apache must know that it has to rewrite the set-cookie headers.<br />
Example from the Apache 2.2 documentation:</p>
<pre>
ProxyPass /mirror/foo/ http://backend.example.com/
ProxyPassReverse /mirror/foo/ http://backend.example.com/
ProxyPassReverseCookieDomain backend.example.com public.example.com
ProxyPassReverseCookiePath / /mirror/foo/
</pre>
<p>Note: if the backend url looks like http://host/~user/phpmyadmin,
the tilde (~) must be url encoded as %7E in the ProxyPassReverse* lines.
This is not specific to phpmyadmin, it's just the behavior of Apache.
</p>
<pre>
ProxyPass /mirror/foo/ http://backend.example.com/~user/phpmyadmin
ProxyPassReverse /mirror/foo/
http://backend.example.com/%7Euser/phpmyadmin
ProxyPassReverseCookiePath /%7Euser/phpmyadmin /mirror/foo
</pre>
<p>See <a href="http://httpd.apache.org/docs/2.2/mod/mod_proxy.html">http://httpd.apache.org/docs/2.2/mod/mod_proxy.html</a>
for more details.</p>