### Navigation

- index
- next |
- previous |
- phpMyAdmin 4.0.10.1 documentation »

# Configuration

Almost all configurable data is placed in `config.inc.php`. If this file does not exist, please refer to the Installation section to create one. This file only needs to contain the parameters you want to change from their corresponding default value in `libraries/config.default.php`.

The parameters which relate to design (like colors) are placed in `themes/themename/layout.inc.php`. You might also want to create `config.footer.inc.php` and `config.header.inc.php` files to add your site specific code to be included on start and end of each page.

Note

Some distributions (eg. Debian or Ubuntu) store `config.inc.php` in `/etc/phpmyadmin` instead of within phpMyAdmin sources.

Warning

Mac users should note that if you are on a version before Mac OS X, PHP does not seem to like Mac end of lines character (`\r`). So ensure you choose the option that allows to use the *nix end of line character (`\n`) in your text editor before saving a script you have modified.

## Basic settings

`$cfg['PmaAbsoluteUri']`

  Type: | string
  Default value: | `''`

  Sets here the complete URL (with full path) to your phpMyAdmin installation’s directory. E.g. `http://www.example.net/path_to_your_phpMyAdmin_directory/`. Note also that the URL on some web servers are case–sensitive. Don’t forget the trailing slash at the end.

  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 `$cfg['PmaAbsoluteUri']` (more info).

  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–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.

  See also

  1.40 When accessing phpMyAdmin via an Apache reverse proxy, cookie login does not work.

`$cfg['PmaNoRelation_DisableWarning']`

  Type: | boolean
  Default value: | false

  Starting with version 2.3.0 phpMyAdmin offers a lot of features to work with master / foreign – tables (see `$cfg['Servers'][$i]['pmadb']`).

  If you tried to set this up and it does not work for you, have a look on the Structure 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.

  If you do not want to use those features set this variable to `true` to stop this message from appearing.

`$cfg['SuhosinDisableWarning']`

  Type: | boolean
  Default value: | false

  A warning is displayed on the main page if Suhosin is detected.

  You can set this parameter to `true` to stop this message from appearing.

`$cfg['McryptDisableWarning']`

  Type: | boolean
  Default value: | false

  Disable the default warning that is displayed if mcrypt is missing for cookie authentication.

  You can set this parameter to `true` to stop this message from appearing.

`$cfg['ServerLibraryDifference_DisableWarning']`

  Type: | boolean
  Default value: | false

  A warning is displayed on the main page if there is a difference between the MySQL library and server version.

  You can set this parameter to `true` to stop this message from appearing.

`$cfg['ReservedWordDisableWarning']`

  Type: | boolean
  Default value: | false

  This warning is displayed on the Structure page of a table if one or more column names match with words which are MySQL reserved.

  If you want to turn off this warning, you can set it to `true` and warning will not longer be displayed

`$cfg['TranslationWarningThreshold']`

  Type: | integer
  Default value: | 80

  Show warning about incomplete translations on certain threshold.

`$cfg['AllowThirdPartyFraming']`

  Type: | boolean
  Default value: | false

  Setting this to `true` allows phpMyAdmin to be included inside a frame, and is a potential security hole allowing cross-frame scripting attacks or clickjacking.

## Server connection settings

`$cfg['Servers']`

  Type: | array
  Default value: | one server array with settings listed bellow

  Since version 1.4.2, phpMyAdmin supports the administration of multiple MySQL servers. Therefore, a `$cfg['Servers']`-array has been added which contains the login information for the different servers. The first `$cfg['Servers'][$i]['host']` contains the hostname of the first server, the second `$cfg['Servers'][$i]['host']` the hostname of the second server, etc. In `libraries/config.default.php`, there is only one section for server definition, however you can put as many as you need in `config.inc.php`, copy that block or needed parts (you don’t have to define all settings, just those you need to change).

  Note

  The `$cfg['Servers']` array starts with $cfg[‘Servers’][1]. Do not use $cfg[‘Servers’][0]. If you want more than one server, just copy following section (including $i incrementation) serveral times. There is no need to define full server array, just define values you need to change.

`$cfg['Servers'][$i]['host']`

  Type: | string
  Default value: | `'localhost'`

  The hostname or IP address of your $i-th MySQL-server. E.g. `localhost`.

  Possible values are:

  - hostname, e.g., `'localhost'` or `'mydb.example.org'`
  - IP address, e.g., `'127.0.0.1'` or `'192.168.10.1'`
  - dot - `'.'`, i.e., use named pipes on windows systems
  - empty - `''`, disables this server

`$cfg['Servers'][$i]['port']`

  Type: | string
  Default value: | `''`

  The port-number of your $i-th MySQL-server. Default is 3306 (leave blank).

  Note

  If you use `localhost` 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 `127.0.0.1` or the real hostname in `$cfg['Servers'][$i]['host']`.

`$cfg['Servers'][$i]['socket']`

  Type: | string
  Default value: | `''`

  The path to the socket to use. Leave blank for default. To determine the correct socket, check your MySQL configuration or, using the mysql command–line client, issue the `status` command. Among the resulting information displayed will be the socket used.

`$cfg['Servers'][$i]['ssl']`

  Type: | boolean
  Default value: | false

  Whether to enable SSL for connection to MySQL server.

`$cfg['Servers'][$i]['connect_type']`

  Type: | string
  Default value: | `'tcp'`

  What type connection to use with the MySQL server. Your options are `'socket'` and `'tcp'`. It defaults to tcp as that is nearly guaranteed to be available on all MySQL servers, while sockets are not supported on some platforms. To use the socket mode, your MySQL server must be on the same machine as the Web server.

`$cfg['Servers'][$i]['extension']`

  Type: | string
  Default value: | `'mysqli'`

  What php MySQL extension to use for the connection. Valid options are:

  `mysql`
    The classic MySQL extension.
  `mysqli`
    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.

`$cfg['Servers'][$i]['compress']`

  Type: | boolean
  Default value: | false

  Whether to use a compressed protocol for the MySQL server connection or not (experimental).

`$cfg['Servers'][$i]['controlhost']`

  Type: | string
  Default value: | `''`

  Permits to use an alternate host to hold the configuration storage data.

`$cfg['Servers'][$i]['controluser']`

  Type: | string
  Default value: | `''`

`$cfg['Servers'][$i]['controlpass']`

  Type: | string
  Default value: | `''`

  This special account is used for 2 distinct purposes: to make possible all relational features (see `$cfg['Servers'][$i]['pmadb']`) and, for a MySQL server running with `--skip-show-database`, to enable a multi-user installation (HTTP or cookie authentication mode).

  When using HTTP 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 `SELECT` privilege on the mysql.user (all columns except “Password”), mysql.db (all columns) and mysql.tables_priv (all columns except “Grantor” and “Timestamp”) tables. This account is used to check what databases the user will see at login.

  Changed in version 2.2.5: those were called `stduser` and `stdpass`

  See also

  Installation, Using authentication modes

`$cfg['Servers'][$i]['auth_type']`

  Type: | string
  Default value: | `'cookie'`

  Whether config or cookie or HTTP or signon authentication should be used for this server.

  - ‘config’ authentication (`$auth_type = 'config'`) is the plain old way: username and password are stored in `config.inc.php`.
  - ‘cookie’ authentication mode (`$auth_type = 'cookie'`) 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 `$cfg['AllowArbitraryServer']` enabled.
  - ‘http’ authentication (was called ‘advanced’ in previous versions and can be written also as ‘http’) (`$auth_type = 'http';'`) as introduced in 1.3.0 allows you to log in as any valid MySQL user via HTTP-Auth.
  - ‘signon’ authentication mode (`$auth_type = 'signon'`) 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: `examples/signon.php`. There is also alternative example using OpenID - `examples/openid.php` and example for scripts based solution - `examples/signon-script.php`. You need to configure `$cfg['Servers'][$i]['SignonSession']` or `$cfg['Servers'][$i]['SignonScript']` and `$cfg['Servers'][$i]['SignonURL']` to use this authentication method.

  See also

  Using authentication modes

`$cfg['Servers'][$i]['auth_http_realm']`

  Type: | string
  Default value: | `''`

  When using auth_type = `http`, this field allows to define a custom HTTP Basic Auth Realm which will be displayed to the user. If not explicitly specified in your configuration, a string combined of “phpMyAdmin ” and either `$cfg['Servers'][$i]['verbose']` or `$cfg['Servers'][$i]['host']` will be used.

`$cfg['Servers'][$i]['auth_swekey_config']`

  Type: | string
  Default value: | `''`

  The name of the file containing Swekey authentication mode ids and login names for hardware authentication. Leave empty to deactivate this feature.

`$cfg['Servers'][$i]['user']`

  Type: | string
  Default value: | `'root'`

`$cfg['Servers'][$i]['password']`

  Type: | string
  Default value: | `''`

  When using `$cfg['Servers'][$i]['auth_type']` set to ‘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 HTTP or cookie authentication is used and should be empty.

`$cfg['Servers'][$i]['nopassword']`

  Type: | boolean
  Default value: | false

  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.

`$cfg['Servers'][$i]['only_db']`

  Type: | string or array
  Default value: | `''`

  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 (“_” and “%”): if you want to use literal instances of these characters, escape them (I.E. use `'my\_db'` and not `'my_db'`).

  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 it does not replace the privileges rules of the MySQL database server. If set, it just means only these databases will be displayed but not that all other databases can’t be used.

  An example of using more that one database:

      $cfg['Servers'][$i]['only_db'] = array('db1', 'db2');

  Changed in version 4.0.0: Previous versions permitted to specify the display order of the database names via this directive.

`$cfg['Servers'][$i]['hide_db']`

  Type: | string
  Default value: | `''`

  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. For example, to hide all databases starting with the letter “a”, use

      $cfg['Servers'][$i]['hide_db'] = '^a';

  and to hide both “db1” and “db2” use

      $cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$';

  More information on regular expressions can be found in the PCRE pattern syntax portion of the PHP reference manual.

`$cfg['Servers'][$i]['verbose']`

  Type: | string
  Default value: | `''`

  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.

`$cfg['Servers'][$i]['pmadb']`

  Type: | string
  Default value: | `''`

  The name of the database containing the phpMyAdmin configuration storage.

  See the phpMyAdmin configuration storage section in this document to see the benefits of this feature, and for a quick way of creating this database and the needed tables.

  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 `$cfg['Servers'][$i]['pmadb']`. For a multi-user installation, set this parameter to the name of your central database containing the phpMyAdmin configuration storage.

`$cfg['Servers'][$i]['bookmarktable']`

  Type: | string
  Default value: | `''`

  Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This can be useful for queries you often run. To allow the usage of this functionality:

  - set up `$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  - enter the table name in `$cfg['Servers'][$i]['bookmarktable']`

`$cfg['Servers'][$i]['relation']`

  Type: | string
  Default value: | `''`

  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

  - make clickable, when you browse the master table, the data values that point to the foreign table;
  - display in an optional tool-tip the “display column” when browsing the master table, if you move the mouse to a column containing a foreign key (use also the ‘table_info’ table); (see 6.7 How can I use the “display column” feature?)
  - in edit/insert mode, display a drop-down list of possible foreign keys (key value and “display column” are shown) (see 6.21 In edit/insert mode, how can I see a list of possible values for a column, based on some foreign table?)
  - display links on the table properties page, to check referential integrity (display missing foreign keys) for each described key;
  - in query-by-example, create automatic joins (see 6.6 How can I use the relation table in Query-by-example?)
  - enable you to get a PDF schema of your database (also uses the table_coords table).

  The keys can be numeric or character.

  To allow the usage of this functionality:

  - set up `$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  - put the relation table name in `$cfg['Servers'][$i]['relation']`
  - now as normal user open phpMyAdmin and for each one of your tables where you want to use this feature, click Structure/Relation view/ and choose foreign columns.

  Note

  In the current version, `master_db` must be the same as `foreign_db`. Those columns have been put in future development of the cross-db relations.

`$cfg['Servers'][$i]['table_info']`

  Type: | string
  Default value: | `''`

  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. This configuration variable will hold the name of this special table. To allow the usage of this functionality:

  - set up `$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  - put the table name in `$cfg['Servers'][$i]['table_info']` (e.g. `pma__table_info`)
  - then for each table where you want to use this feature, click “Structure/Relation view/Choose column to display” to choose the column.

  See also

  6.7 How can I use the “display column” feature?

`$cfg['Servers'][$i]['table_coords']`

  Type: | string
  Default value: | `''`

`$cfg['Servers'][$i]['pdf_pages']`

  Type: | string
  Default value: | `''`

  Since release 2.3.0 you can have phpMyAdmin create PDF pages showing the relations between your tables. To do this it needs two tables “pdf_pages” (storing information about the available PDF pages) and “table_coords” (storing coordinates where each table will be placed on a PDF schema output). You must be using the “relation” feature.

  To allow the usage of this functionality:

  - set up `$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  - put the correct table names in `$cfg['Servers'][$i]['table_coords']` and `$cfg['Servers'][$i]['pdf_pages']`

  See also

  6.8 How can I produce a PDF schema of my database?.

`$cfg['Servers'][$i]['column_info']`

  Type: | string
  Default value: | `''`

  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 “printview”.

  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.

  Also new in release 2.5.0 is a MIME- transformation system which is also based on the following table structure. See Transformations for further information. To use the MIME- transformation system, your column_info table has to have the three new columns ‘mimetype’, ‘transformation’, ‘transformation_options’.

  To allow the usage of this functionality:

  - set up `$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage

  - put the table name in `$cfg['Servers'][$i]['column_info']` (e.g. `pma__column_info`)

  - to update your PRE-2.5.0 Column_comments Table use this: and remember that the Variable in `config.inc.php` has been renamed from `$cfg['Servers'][$i]['column_comments']` to `$cfg['Servers'][$i]['column_info']`

        ALTER TABLE `pma__column_comments`
        ADD `mimetype` VARCHAR( 255 ) NOT NULL,
        ADD `transformation` VARCHAR( 255 ) NOT NULL,
        ADD `transformation_options` VARCHAR( 255 ) NOT NULL;

`$cfg['Servers'][$i]['history']`

  Type: | string
  Default value: | `''`

  Since release 2.5.0 you can store your SQL 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. Using `$cfg['QueryHistoryMax']` 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.

  The query history is only available if JavaScript is enabled in your browser.

  To allow the usage of this functionality:

  - set up `$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  - put the table name in `$cfg['Servers'][$i]['history']` (e.g. `pma__history`)

`$cfg['Servers'][$i]['recent']`

  Type: | string
  Default value: | `''`

  Since release 3.5.0 you can show recently used tables in the navigation panel. It helps you to jump across table directly, without the need to select the database, and then select the table. Using `$cfg['NumRecentTables']` 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 `$cfg['NavigationTreeDefaultTabTable']`.

  Without configuring the storage, you can still access the recently used tables, but it will disappear after you logout.

  To allow the usage of this functionality persistently:

  - set up `$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  - put the table name in `$cfg['Servers'][$i]['recent']` (e.g. `pma__recent`)

`$cfg['Servers'][$i]['table_uiprefs']`

  Type: | string
  Default value: | `''`

  Since release 3.5.0 phpMyAdmin can be configured to remember several things (sorted column `$cfg['RememberSorting']`, 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.

  To allow the usage of these functionality persistently:

  - set up `$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  - put the table name in `$cfg['Servers'][$i]['table_uiprefs']` (e.g. `pma__table_uiprefs`)

`$cfg['Servers'][$i]['tracking']`

  Type: | string
  Default value: | `''`

  Since release 3.3.x a tracking mechanism is available. It helps you to track every SQL 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.

  The creation of a version has two effects:

  - phpMyAdmin saves a snapshot of the table, including structure and indexes.
  - phpMyAdmin logs all commands which change the structure and/or data of the table and links these commands with the version number.

  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.

  To allow the usage of this functionality:

  - set up `$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  - put the table name in `$cfg['Servers'][$i]['tracking']` (e.g. `pma__tracking`)

`$cfg['Servers'][$i]['tracking_version_auto_create']`

  Type: | boolean
  Default value: | false

  Whether the tracking mechanism creates versions for tables and views automatically.

  If this is set to true and you create a table or view with

  - CREATE TABLE ...
  - CREATE VIEW ...

  and no version exists for it, the mechanism will create a version for you automatically.

`$cfg['Servers'][$i]['tracking_default_statements']`

  Type: | string
  Default value: | `'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'`

  Defines the list of statements the auto-creation uses for new versions.

`$cfg['Servers'][$i]['tracking_add_drop_view']`

  Type: | boolean
  Default value: | true

  Whether a DROP VIEW IF EXISTS statement will be added as first line to the log when creating a view.

`$cfg['Servers'][$i]['tracking_add_drop_table']`

  Type: | boolean
  Default value: | true

  Whether a DROP TABLE IF EXISTS statement will be added as first line to the log when creating a table.

`$cfg['Servers'][$i]['tracking_add_drop_database']`

  Type: | boolean
  Default value: | true

  Whether a DROP DATABASE IF EXISTS statement will be added as first line to the log when creating a database.

`$cfg['Servers'][$i]['userconfig']`

  Type: | string
  Default value: | `''`

  Since release 3.4.x phpMyAdmin allows users to set most preferences by themselves and store them in the database.

  If you don’t allow for storing preferences in `$cfg['Servers'][$i]['pmadb']`, 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.

  To allow the usage of this functionality:

  - set up `$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  - put the table name in `$cfg['Servers'][$i]['userconfig']`

`$cfg['Servers'][$i]['designer_coords']`

  Type: | string
  Default value: | `''`

  Since release 2.10.0 a Designer interface is available; it permits to visually manage the relations.

  To allow the usage of this functionality:

  - set up `$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
  - put the table name in `$cfg['Servers'][$i]['designer_coords']` (e.g. `pma__designer_coords`)

`$cfg['Servers'][$i]['MaxTableUiprefs']`

  Type: | integer
  Default value: | 100

  Maximum number of rows saved in `$cfg['Servers'][$i]['table_uiprefs']` table.

  When tables are dropped or renamed, `$cfg['Servers'][$i]['table_uiprefs']` may contain invalid data (referring to tables which no longer exist). We only keep this number of newest rows in `$cfg['Servers'][$i]['table_uiprefs']` and automatically delete older rows.

`$cfg['Servers'][$i]['AllowRoot']`

  Type: | boolean
  Default value: | true

  Whether to allow root access. This is just a shortcut for the `$cfg['Servers'][$i]['AllowDeny']['rules']` below.

`$cfg['Servers'][$i]['AllowNoPassword']`

  Type: | boolean
  Default value: | false

  Whether to allow logins without a password. The default value of `false` 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.

`$cfg['Servers'][$i]['AllowDeny']['order']`

  Type: | string
  Default value: | `''`

  If your rule order is empty, then IP authorization is disabled.

  If your rule order is set to `'deny,allow'` 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.

  If your rule order is set to `'allow,deny'` 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.

  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 must be listed in the allow rules, and not listed in the deny rules. This is the most secure means of using Allow/Deny rules, and was available in Apache by specifying allow and deny rules without setting any order.

  Please also see `$cfg['TrustedProxies']` for detecting IP address behind proxies.

`$cfg['Servers'][$i]['AllowDeny']['rules']`

  Type: | array of strings
  Default value: | array()

  The general format for the rules is as such:

      <'allow' | 'deny'> <username> [from] <ipmask>

  If you wish to match all users, it is possible to use a `'%'` as a wildcard in the username field.

  There are a few shortcuts you can use in the ipmask field as well (please note that those containing SERVER_ADDRESS might not be available on all webservers):

      'all' -> 0.0.0.0/0
      'localhost' -> 127.0.0.1/8
      'localnetA' -> SERVER_ADDRESS/8
      'localnetB' -> SERVER_ADDRESS/16
      'localnetC' -> SERVER_ADDRESS/24

  Having an empty rule list is equivalent to either using `'allow % from all'` if your rule order is set to `'deny,allow'` or `'deny % from all'` if your rule order is set to `'allow,deny'` or `'explicit'`.

  For the IP address matching system, the following work:

  - `xxx.xxx.xxx.xxx` (an exact IP address)
  - `xxx.xxx.xxx.[yyy-zzz]` (an IP address range)
  - `xxx.xxx.xxx.xxx/nn` (CIDR, Classless Inter-Domain Routing type IP addresses)

  But the following does not work:

  - `xxx.xxx.xxx.xx[yyy-zzz]` (partial IP address range)

  For IPv6 addresses, the following work:

  - `xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx` (an exact IPv6 address)
  - `xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:[yyyy-zzzz]` (an IPv6 address range)
  - `xxxx:xxxx:xxxx:xxxx/nn` (CIDR, Classless Inter-Domain Routing type IPv6 addresses)

  But the following does not work:

  - `xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xx[yyy-zzz]` (partial IPv6 address range)

`$cfg['Servers'][$i]['DisableIS']`

  Type: | boolean
  Default value: | true

  Disable using `INFORMATION_SCHEMA` to retrieve information (use `SHOW` commands instead), because of speed issues when many databases are present. Currently used in some parts of the code, more to come.

`$cfg['Servers'][$i]['ShowDatabasesCommand']`

  Type: | string
  Default value: | `'SHOW DATABASES'`

  On a server with a huge number of databases, the default `SHOW DATABASES` command used to fetch the name of available databases will probably be too slow, so it can be replaced by faster commands. You can use `#user#` string will be replaced by current user.

  When using `false`, it will disable fetching databases from the server, only databases in `$cfg['Servers'][$i]['only_db']` will be displayed.

  Examples:

  - `'SHOW DATABASES'`
  - `"SHOW DATABASES LIKE '#user#\_%'"`
  - `'SELECT DISTINCT TABLE_SCHEMA FROM information_schema.SCHEMA_PRIVILEGES'`
  - `'SELECT SCHEMA_NAME FROM information_schema.SCHEMATA'`
  - `false`

`$cfg['Servers'][$i]['SignonScript']`

  Type: | string
  Default value: | `''`

  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 `get_login_credentials` which returns list of username and password, accepting single parameter of existing username (can be empty). See `examples/signon-script.php` for an example.

`$cfg['Servers'][$i]['SignonSession']`

  Type: | string
  Default value: | `''`

  Name of session which will be used for signon authentication method. You should use something different than `phpMyAdmin`, because this is session which phpMyAdmin uses internally. Takes effect only if `$cfg['Servers'][$i]['SignonScript']` is not configured.

`$cfg['Servers'][$i]['SignonURL']`

  Type: | string
  Default value: | `''`

  URL where user will be redirected to log in for signon authentication method. Should be absolute including protocol.

`$cfg['Servers'][$i]['LogoutURL']`

  Type: | string
  Default value: | `''`

  URL where user will be redirected after logout (doesn’t affect config authentication method). Should be absolute including protocol.

`$cfg['Servers'][$i]['StatusCacheDatabases']`

  Type: | array of strings
  Default value: | array()

  Enables caching of `TABLE STATUS` outputs for specific databases on this server (in some cases `TABLE STATUS` can be very slow, so you may want to cache it). APC is used (if the PHP extension is available, if not, this setting is ignored silently). You have to provide `$cfg['Servers'][$i]['StatusCacheLifetime']`.

  Takes effect only if `$cfg['Servers'][$i]['DisableIS']` is `true`.

`$cfg['Servers'][$i]['StatusCacheLifetime']`

  Type: | integer
  Default value: | 0

  Lifetime in seconds of the `TABLE STATUS` cache if `$cfg['Servers'][$i]['StatusCacheDatabases']` is used.

## Generic settings

`$cfg['ServerDefault']`

  Type: | integer
  Default value: | 1

  If you have more than one server configured, you can set `$cfg['ServerDefault']` 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.

  If you have only one server configured, `$cfg['ServerDefault']` MUST be set to that server.

`$cfg['VersionCheck']`

  Type: | boolean
  Default value: | true

  Enables check for latest versions using javascript on main phpMyAdmin page.

  Note

  This setting can be adjusted by your vendor.

`$cfg['MaxDbList']`

  Type: | integer
  Default value: | 100

  The maximum number of database names to be displayed in the main panel’s database list.

`$cfg['MaxNavigationItems']`

  Type: | integer
  Default value: | 250

  The number of items that can be displayed on each page of the navigation tree.

`$cfg['MaxTableList']`

  Type: | integer
  Default value: | 250

  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.

`$cfg['ShowHint']`

  Type: | boolean
  Default value: | true

  Whether or not to show hints (for example, hints when hovering over table headers).

`$cfg['MaxCharactersInDisplayedSQL']`

  Type: | integer
  Default value: | 1000

  The maximum number of characters when a SQL 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 SQL queries that are longer than 1000 characters. Also, if a query’s length exceeds this limit, this query is not saved in the history.

`$cfg['PersistentConnections']`

  Type: | boolean
  Default value: | false

  Whether persistent connections should be used or not. Works with following extensions:

  - mysql (mysql_pconnect),
  - mysqli (requires PHP 5.3.0 or newer, more information).

`$cfg['ForceSSL']`

  Type: | boolean
  Default value: | false

  Whether to force using https while accessing phpMyAdmin.

`$cfg['ExecTimeLimit']`

  Type: | integer [number of seconds]
  Default value: | 300

  Set the number of seconds a script is allowed to run. If seconds is set to zero, no time limit is imposed. This setting is used while importing/exporting dump files but has no effect when PHP is running in safe mode.

`$cfg['SessionSavePath']`

  Type: | string
  Default value: | `''`

  Path for storing session data (session_save_path PHP parameter).

`$cfg['MemoryLimit']`

  Type: | string [number of bytes]
  Default value: | `'0'`

  Set the number of bytes a script is allowed to allocate. If set to zero, no limit is imposed.

  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.

  You can also use any string as in `php.ini`, eg. ‘16M’. Ensure you don’t omit the suffix (16 means 16 bytes!)

`$cfg['SkipLockedTables']`

  Type: | boolean
  Default value: | false

  Mark used tables and make it possible to show databases with locked tables (since MySQL 3.23.30).

`$cfg['ShowSQL']`

  Type: | boolean
  Default value: | true

  Defines whether SQL queries generated by phpMyAdmin should be displayed or not.

`$cfg['RetainQueryBox']`

  Type: | boolean
  Default value: | false

  Defines whether the SQL query box should be kept displayed after its submission.

`$cfg['CodemirrorEnable']`

  Type: | boolean
  Default value: | true

  Defines whether to use a Javascript code editor for SQL query boxes. CodeMirror provides syntax highlighting and line numbers. However, middle-clicking for pasting the clipboard contents in some Linux distributions (such as Ubuntu) is not supported by all browsers.

`$cfg['AllowUserDropDatabase']`

  Type: | boolean
  Default value: | false

  Defines whether normal users (non-administrator) are allowed to delete their own database or not. If set as false, the link Drop Database will not be shown, and even a `DROP DATABASE mydatabase` will be rejected. Quite practical for ISP ‘s with many customers.

  Note

  This limitation of SQL queries is not as strict as when using MySQL privileges. This is due to nature of SQL queries which might be quite complicated. So this choice should be viewed as help to avoid accidental dropping rather than strict privilege limitation.

`$cfg['Confirm']`

  Type: | boolean
  Default value: | true

  Whether a warning (“Are your really sure...”) should be displayed when you’re about to lose data.

`$cfg['UseDbSearch']`

  Type: | boolean
  Default value: | true

  Define whether the “search string inside database” is enabled or not.

`$cfg['IgnoreMultiSubmitErrors']`

  Type: | boolean
  Default value: | false

  Define whether phpMyAdmin will continue executing a multi-query statement if one of the queries fails. Default is to abort execution.

## Cookie authentication options

`$cfg['blowfish_secret']`

  Type: | string
  Default value: | `''`

  The “cookie” auth_type uses blowfish algorithm to encrypt the password. If you are using the “cookie” auth_type, enter here a random passphrase of your choice. It will be used internally by the blowfish algorithm: you won’t be prompted for this passphrase. There is no maximum length for this secret.

  Changed in version 3.1.0: 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.

`$cfg['LoginCookieRecall']`

  Type: | boolean
  Default value: | true

  Define whether the previous login should be recalled or not in cookie authentication mode.

  This is automatically disabled if you do not have configured `$cfg['blowfish_secret']`.

`$cfg['LoginCookieValidity']`

  Type: | integer [number of seconds]
  Default value: | 1440

  Define how long a login cookie is valid. Please note that php configuration option session.gc_maxlifetime might limit session validity and if the session is lost, the login cookie is also invalidated. So it is a good idea to set `session.gc_maxlifetime` at least to the same value of `$cfg['LoginCookieValidity']`.

`$cfg['LoginCookieStore']`

  Type: | integer [number of seconds]
  Default value: | 0

  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.

`$cfg['LoginCookieDeleteAll']`

  Type: | boolean
  Default value: | true

  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.

`$cfg['AllowArbitraryServer']`

  Type: | boolean
  Default value: | false

  If enabled, allows you to log in to arbitrary servers using cookie authentication.

  Note

  Please use this carefully, as this may allow users access to MySQL servers behind the firewall where your HTTP server is placed.

## Navigation panel setup

`$cfg['NavigationTreeEnableGrouping']`

  Type: | boolean
  Default value: | true

  Defines whether to group the databases based on a common prefix in their name `$cfg['NavigationTreeDbSeparator']`.

`$cfg['NavigationTreeDbSeparator']`

  Type: | string or array
  Default value: | `'_'`

  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.

`$cfg['NavigationTreeTableSeparator']`

  Type: | string or array
  Default value: | `'__'`

  Defines a string to be used to nest table spaces. This means if you have tables like `first__second__third` this will be shown as a three-level hierarchy like: first > second > 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.

`$cfg['NavigationTreeTableLevel']`

  Type: | integer
  Default value: | 1

  Defines how many sublevels should be displayed when splitting up tables by the above separator.

`$cfg['NumRecentTables']`

  Type: | integer
  Default value: | 10

  The maximum number of recently used tables shown in the navigation panel. Set this to 0 (zero) to disable the listing of recent tables.

`$cfg['NavigationDisplayLogo']`

  Type: | boolean
  Default value: | true

  Defines whether or not to display the phpMyAdmin logo at the top of the navigation panel.

`$cfg['NavigationLogoLink']`

  Type: | string
  Default value: | `'index.php'`

  Enter URL where logo in the navigation panel will point to. For use especially with self made theme which changes this.

`$cfg['NavigationLogoLinkWindow']`

  Type: | string
  Default value: | `'main'`

  Whether to open the linked page in the main window (`main`) or in a new one (`new`). Note: use `new` if you are linking to `phpmyadmin.net`.

`$cfg['NavigationTreeDisplayItemFilterMinimum']`

  Type: | integer
  Default value: | 30

  Defines the minimum number of items (tables, views, routines and events) to display a JavaScript filter box above the list of items in the navigation tree.

  To disable the filter completely some high number can be used (e.g. 9999)

`$cfg['NavigationTreeDisplayDbFilterMinimum']`

  Type: | integer
  Default value: | 30

  Defines the minimum number of databases to display a JavaScript filter box above the list of databases in the navigation tree.

  To disable the filter completely some high number can be used (e.g. 9999)

`$cfg['NavigationDisplayServers']`

  Type: | boolean
  Default value: | true

  Defines whether or not to display a server choice at the top of the navigation panel.

`$cfg['DisplayServersList']`

  Type: | boolean
  Default value: | false

  Defines whether to display this server choice as links instead of in a drop-down.

`$cfg['NavigationTreeDefaultTabTable']`

  Type: | string
  Default value: | `'tbl_structure.php'`

  Defines the tab displayed by default when clicking the small icon next to each table name in the navigation panel. Possible values:

  - `tbl_structure.php`
  - `tbl_sql.php`
  - `tbl_select.php`
  - `tbl_change.php`
  - `sql.php`

## Main panel

`$cfg['ShowStats']`

  Type: | boolean
  Default value: | true

  Defines whether or not to display space usage and statistics about databases and tables. 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.

`$cfg['ShowServerInfo']`

  Type: | boolean
  Default value: | true

  Defines whether to display detailed server information on main page. You can additionally hide more information by using `$cfg['Servers'][$i]['verbose']`.

`$cfg['ShowPhpInfo']`

  Type: | boolean
  Default value: | false

`$cfg['ShowChgPassword']`

  Type: | boolean
  Default value: | true

`$cfg['ShowCreateDb']`

  Type: | boolean
  Default value: | true

  Defines whether to display the PHP information and Change password links and form for creating database or not at the starting main (right) frame. This setting does not check MySQL commands entered directly.

  Please note that to block the usage of `phpinfo()` in scripts, you have to put this in your `php.ini`:

      disable_functions = phpinfo()

  Also note that enabling the Change password link has no effect with config authentication mode: because of the hard coded password value in the configuration file, end users can’t be allowed to change their passwords.

## Database structure

`$cfg['ShowDbStructureCreation']`

  Type: | boolean
  Default value: | false

  Defines whether the database structure page (tables list) has a “Creation” column that displays when each table was created.

`$cfg['ShowDbStructureLastUpdate']`

  Type: | boolean
  Default value: | false

  Defines whether the database structure page (tables list) has a “Last update” column that displays when each table was last updated.

`$cfg['ShowDbStructureLastCheck']`

  Type: | boolean
  Default value: | false

  Defines whether the database structure page (tables list) has a “Last check” column that displays when each table was last checked.

`$cfg['HideStructureActions']`

  Type: | boolean
  Default value: | true

  Defines whether the table structure actions are hidden under a “More” drop-down.

## Browse mode

`$cfg['TableNavigationLinksMode']`

  Type: | string
  Default value: | `'icons'`

  Defines whether the table navigation links contain `'icons'`, `'text'` or `'both'`.

`$cfg['ShowAll']`

  Type: | boolean
  Default value: | false

  Defines whether a user should be displayed a “Show all” button in browse mode or not in all cases. By default it is shown only on small tables (less than 5 × `$cfg['MaxRows']` rows) to avoid performance issues while getting too many rows.

`$cfg['MaxRows']`

  Type: | integer
  Default value: | 30

  Number of rows displayed when browsing a result set and no LIMIT clause is used. If the result set contains more rows, “Previous” and “Next” links will be shown.

`$cfg['Order']`

  Type: | string
  Default value: | `'SMART'`

  Defines whether columns are displayed in ascending (`ASC`) order, in descending (`DESC`) order or in a “smart” (`SMART`) order - I.E. descending order for columns of type TIME, DATE, DATETIME and TIMESTAMP, ascending order else- by default.

`$cfg['DisplayBinaryAsHex']`

  Type: | boolean
  Default value: | true

  Defines whether the “Show binary contents as HEX” browse option is ticked by default.

`$cfg['GridEditing']`

  Type: | string
  Default value: | `'double-click'`

  Defines which action (`double-click` or `click`) triggers grid editing. Can be deactived with the `disabled` value.

`$cfg['SaveCellsAtOnce']`

  Type: | boolean
  Default value: | false

  Defines whether or not to save all edited cells at once for grid editing.

## Editing mode

`$cfg['ProtectBinary']`

  Type: | boolean or string
  Default value: | `'blob'`

  Defines whether `BLOB` or `BINARY` columns are protected from editing when browsing a table’s content. Valid values are:

  - `false` to allow editing of all columns;
  - `'blob'` to allow editing of all columns except `BLOBS`;
  - `'noblob'` to disallow editing of all columns except `BLOBS` (the opposite of `'blob'`);
  - `'all'` to disallow editing of all `BINARY` or `BLOB` columns.

`$cfg['ShowFunctionFields']`

  Type: | boolean
  Default value: | true

  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.

`$cfg['ShowFieldTypesInDataEditView']`

  Type: | boolean
  Default value: | true

  Defines whether or not type fields should be initially displayed in edit/insert mode. The user can toggle this setting from the interface.

`$cfg['InsertRows']`

  Type: | integer
  Default value: | 2

  Defines the maximum number of concurrent entries for the Insert page.

`$cfg['ForeignKeyMaxLimit']`

  Type: | integer
  Default value: | 100

  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 `$cfg['ForeignKeyDropdownOrder']` setting.

`$cfg['ForeignKeyDropdownOrder']`

  Type: | array
  Default value: | array(‘content-id’, ‘id-content’)

  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: `content-id`, `id-content`.

## Export and import settings

`$cfg['ZipDump']`

  Type: | boolean
  Default value: | true

`$cfg['GZipDump']`

  Type: | boolean
  Default value: | true

`$cfg['BZipDump']`

  Type: | boolean
  Default value: | true

  Defines whether to allow the use of zip/GZip/BZip2 compression when creating a dump file

`$cfg['CompressOnFly']`

  Type: | boolean
  Default value: | true

  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.

`$cfg['Export']`

  Type: | array
  Default value: | array(...)

  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.

`$cfg['Export']['method']`

  Type: | string
  Default value: | `'quick'`

  Defines how the export form is displayed when it loads. Valid values are:

  - `quick` to display the minimum number of options to configure
  - `custom` to display every available option to configure
  - `custom-no-form` same as `custom` but does not display the option of using quick export

`$cfg['Import']`

  Type: | array
  Default value: | array(...)

  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.

## Tabs display settings

`$cfg['TabsMode']`

  Type: | string
  Default value: | `'both'`

  Defines whether the menu tabs contain `'icons'`, `'text'` or `'both'`.

`$cfg['ActionLinksMode']`

  Type: | string
  Default value: | `'both'`

  If set to `icons`, will display icons instead of text for db and table properties links (like Browse, Select, Insert, ...). Can be set to `'both'` if you want icons AND text. When set to `text`, will only show text.

`$cfg['PropertiesNumColumns']`

  Type: | integer
  Default value: | 1

  How many columns will be utilized to display the tables on the database property view? When setting this to a value larger than 1, the type of the database will be omitted for more display space.

`$cfg['DefaultTabServer']`

  Type: | string
  Default value: | `'index.php'`

  Defines the tab displayed by default on server view. Possible values:

  - `main.php` (recommended for multi-user setups)
  - `server_databases.php`,
  - `server_status.php`
  - `server_variables.php`
  - `server_privileges.php`

`$cfg['DefaultTabDatabase']`

  Type: | string
  Default value: | `'db_structure.php'`

  Defines the tab displayed by default on database view. Possible values:

  - `db_structure.php`
  - `db_sql.php`
  - `db_search.php`.

`$cfg['DefaultTabTable']`

  Type: | string
  Default value: | `'sql.php'`

  Defines the tab displayed by default on table view. Possible values:

  - `tbl_structure.php`
  - `tbl_sql.php`
  - `tbl_select.php`
  - `tbl_change.php`
  - `sql.php`

## Documentation

`$cfg['MySQLManualBase']`

  Type: | string
  Default value: | `'http://dev.mysql.com/doc/refman'`

  If set to an URL which points to the MySQL documentation (type depends on `$cfg['MySQLManualType']`), appropriate help links are generated.

  See MySQL Documentation page for more information about MySQL manuals and their types.

`$cfg['MySQLManualType']`

  Type: | string
  Default value: | `'viewable'`

  Type of MySQL documentation:

  - viewable - “viewable online”, current one used on MySQL website
  - searchable - “Searchable, with user comments”
  - chapters - “HTML, one page per chapter”
  - big - “HTML, all on one page”
  - none - do not show documentation links

## Languages

`$cfg['DefaultLang']`

  Type: | string
  Default value: | `'en'`

  Defines the default language to use, if not browser-defined or user- defined. The corresponding language file needs to be in locale/code/LC_MESSAGES/phpmyadmin.mo.

`$cfg['DefaultConnectionCollation']`

  Type: | string
  Default value: | `'utf8_general_ci'`

  Defines the default connection collation to use, if not user-defined. See the MySQL documentation for list of possible values. This setting is ignored when connected to Drizzle server.

`$cfg['Lang']`

  Type: | string
  Default value: | not set

  Force language to use. The corresponding language file needs to be in locale/code/LC_MESSAGES/phpmyadmin.mo.

`$cfg['FilterLanguages']`

  Type: | string
  Default value: | `''`

  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 `'^(cs|en)'`.

`$cfg['RecodingEngine']`

  Type: | string
  Default value: | `'auto'`

  You can select here which functions will be used for character set conversion. Possible values are:

  - auto - automatically use available one (first is tested iconv, then recode)
  - iconv - use iconv or libiconv functions
  - recode - use recode_string function
  - none - disable encoding conversion

  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 `$cfg['Export']['charset']` and `$cfg['Import']['charset']`.

`$cfg['IconvExtraParams']`

  Type: | string
  Default value: | `'//TRANSLIT'`

  Specify some parameters for iconv used in charset conversion. See iconv documentation for details. By default `//TRANSLIT` is used, so that invalid characters will be transliterated.

`$cfg['AvailableCharsets']`

  Type: | array
  Default value: | array(..._

  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.

## Web server settings

`$cfg['OBGzip']`

  Type: | string/boolean
  Default value: | `'auto'`

  Defines whether to use GZip output buffering for increased speed in HTTP transfers. 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.

`$cfg['TrustedProxies']`

  Type: | array
  Default value: | array()

  Lists proxies and HTTP headers which are trusted for `$cfg['Servers'][$i]['AllowDeny']['order']`. 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.

  The following example specifies that phpMyAdmin should trust a HTTP_X_FORWARDED_FOR (`X -Forwarded-For`) header coming from the proxy 1.2.3.4:

      $cfg['TrustedProxies'] = array('1.2.3.4' => 'HTTP_X_FORWARDED_FOR');

  The `$cfg['Servers'][$i]['AllowDeny']['rules']` directive uses the client’s IP address as usual.

`$cfg['GD2Available']`

  Type: | string
  Default value: | `'auto'`

  Specifies whether GD >= 2 is available. If yes it can be used for MIME transformations. Possible values are:

  - auto - automatically detect
  - yes - GD 2 functions can be used
  - no - GD 2 function cannot be used

`$cfg['CheckConfigurationPermissions']`

  Type: | boolean
  Default value: | true

  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 `false`.

`$cfg['LinkLengthLimit']`

  Type: | integer
  Default value: | 1000

  Limit for length of URL in links. When length would be above this limit, it is replaced by form with button. This is required as some web servers (IIS) have problems with long URL .

`$cfg['CSPAllow']`

  Type: | string
  Default value: | `''`

  Additional string to include in allowed script sources in Content Security Policy header.

  This can be useful when you want to include some external javascript files in `config.footer.inc.php` or `config.header.inc.php`, which would be normally not allowed by Content Security Policy.

`$cfg['DisableMultiTableMaintenance']`

  Type: | boolean
  Default value: | false

  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 `true` prevents this kind of multiple maintenance operation.

## Theme settings

`$cfg['NaviWidth']`

  Type: | integer
  Default value: |

  Navigation panel width in pixels. See `themes/themename/layout.inc.php`.

`$cfg['NaviBackground']`

  Type: | string [CSS color for background]
  Default value: |

`$cfg['MainBackground']`

  Type: | string [CSS color for background]
  Default value: |

  The background styles used for both the frames. See `themes/themename/layout.inc.php`.

`$cfg['NaviPointerBackground']`

  Type: | string [CSS color for background]
  Default value: |

`$cfg['NaviPointerColor']`

  Type: | string [CSS color]
  Default value: |

  The style used for the pointer in the navi frame. See `themes/themename/layout.inc.php`.

`$cfg['Border']`

  Type: | integer
  Default value: |

  The size of a table’s border. See `themes/themename/layout.inc.php`.

`$cfg['ThBackground']`

  Type: | string [CSS color for background]
  Default value: |

`$cfg['ThColor']`

  Type: | string [CSS color]
  Default value: |

  The style used for table headers. See `themes/themename/layout.inc.php`.

`$cfg['BgOne']`

  Type: | string [CSS color]
  Default value: |

  The color (HTML) #1 for table rows. See `themes/themename/layout.inc.php`.

`$cfg['BgTwo']`

  Type: | string [CSS color]
  Default value: |

  The color (HTML) #2 for table rows. See `themes/themename/layout.inc.php`.

`$cfg['BrowsePointerBackground']`

  Type: | string [CSS color]
  Default value: |

`$cfg['BrowsePointerColor']`

  Type: | string [CSS color]
  Default value: |

`$cfg['BrowseMarkerBackground']`

  Type: | string [CSS color]
  Default value: |

`$cfg['BrowseMarkerColor']`

  Type: | string [CSS color]
  Default value: |

  The colors (HTML) uses for the pointer and the marker in browse mode. The former feature highlights the row over which your mouse is passing and the latter lets you visually mark/unmark rows by clicking on the corresponding checkbox. Highlighting / marking a column is done by hovering over / clicking the column’s header (outside of the text). See `themes/themename/layout.inc.php`.

`$cfg['FontFamily']`

  Type: | string
  Default value: |

  You put here a valid CSS font family value, for example `arial, sans- serif`. See `themes/themename/layout.inc.php`.

`$cfg['FontFamilyFixed']`

  Type: | string
  Default value: |

  You put here a valid CSS font family value, for example `monospace`. This one is used in textarea. See `themes/themename/layout.inc.php`.

## Design customization

`$cfg['NavigationTreePointerEnable']`

  Type: | boolean
  Default value: | true

  A value of `true` activates the navi pointer.

`$cfg['BrowsePointerEnable']`

  Type: | boolean
  Default value: | true

  Whether to activate the browse pointer or not.

`$cfg['BrowseMarkerEnable']`

  Type: | boolean
  Default value: | true

  Whether to activate the browse marker or not.

`$cfg['LimitChars']`

  Type: | integer
  Default value: | 50

  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.

`$cfg['RowActionLinks']`

  Type: | string
  Default value: | `'left'`

  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). “left” and “right” are parsed as “top” and “bottom” with vertical display mode.

`$cfg['DefaultDisplay']`

  Type: | string
  Default value: | `'horizonta'`

  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.

`$cfg['RememberSorting']`

  Type: | boolean
  Default value: | true

  If enabled, remember the sorting of each table when browsing them.

`$cfg['HeaderFlipType']`

  Type: | string
  Default value: | `'auto'`

  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.

`$cfg['ShowBrowseComments']`

  Type: | boolean
  Default value: | true

`$cfg['ShowPropertyComments']`

  Type: | boolean
  Default value: | true

  By setting the corresponding variable to `true` 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.

## Text fields

`$cfg['CharEditing']`

  Type: | string
  Default value: | `'input'`

  Defines which type of editing controls should be used for CHAR and VARCHAR columns. Possible values are:

  - input - this allows to limit size of text to size of columns in MySQL, but has problems with newlines in columns
  - textarea - no problems with newlines in columns, but also no length limitations

`$cfg['MinSizeForInputField']`

  Type: | integer
  Default value: | 4

  Defines the minimum size for input fields generated for CHAR and VARCHAR columns.

`$cfg['MaxSizeForInputField']`

  Type: | integer
  Default value: | 60

  Defines the maximum size for input fields generated for CHAR and VARCHAR columns.

`$cfg['TextareaCols']`

  Type: | integer
  Default value: | 40

`$cfg['TextareaRows']`

  Type: | integer
  Default value: | 15

`$cfg['CharTextareaCols']`

  Type: | integer
  Default value: | 40

`$cfg['CharTextareaRows']`

  Type: | integer
  Default value: | 2

  Number of columns and rows for the textareas. This value will be emphasized (*2) for SQL query textareas and (*1.25) for SQL textareas inside the query window.

  The Char* values are used for CHAR and VARCHAR editing (if configured via `$cfg['CharEditing']`).

`$cfg['LongtextDoubleTextarea']`

  Type: | boolean
  Default value: | true

  Defines whether textarea for LONGTEXT columns should have double size.

`$cfg['TextareaAutoSelect']`

  Type: | boolean
  Default value: | false

  Defines if the whole textarea of the query box will be selected on click.

## SQL query box settings

`$cfg['SQLQuery']['Edit']`

  Type: | boolean
  Default value: | true

  Whether to display an edit link to change a query in any SQL Query box.

`$cfg['SQLQuery']['Explain']`

  Type: | boolean
  Default value: | true

  Whether to display a link to explain a SELECT query in any SQL Query box.

`$cfg['SQLQuery']['ShowAsPHP']`

  Type: | boolean
  Default value: | true

  Whether to display a link to wrap a query in PHP code in any SQL Query box.

`$cfg['SQLQuery']['Validate']`

  Type: | boolean
  Default value: | false

  Whether to display a link to validate a query in any SQL Query box.

  See also

  `$cfg['SQLValidator']`

`$cfg['SQLQuery']['Refresh']`

  Type: | boolean
  Default value: | true

  Whether to display a link to refresh a query in any SQL Query box.

## Web server upload/save/import directories

`$cfg['UploadDir']`

  Type: | string
  Default value: | `''`

  The name of the directory where SQL 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.

  If you want different directory for each user, %u will be replaced with username.

  Please note that the file names must have the suffix ”.sql” (or ”.sql.bz2” or ”.sql.gz” if support for compressed formats is enabled).

  This feature is useful when your file is too big to be uploaded via HTTP, or when file uploads are disabled in PHP.

  Note

  If PHP is running in safe mode, this directory must be owned by the same user as the owner of the phpMyAdmin scripts. See also 1.16 I cannot upload big dump files (memory, HTTP or timeout problems). for alternatives.

`$cfg['SaveDir']`

  Type: | string
  Default value: | `''`

  The name of the directory where dumps can be saved.

  If you want different directory for each user, %u will be replaced with username.

  Please note that the directory must exist and has to be writable for the user running webserver.

  Note

  If PHP is running in safe mode, this directory must be owned by the same user as the owner of the phpMyAdmin scripts.

`$cfg['TempDir']`

  Type: | string
  Default value: | `''`

  The name of the directory where temporary files can be stored.

  This is needed for importing ESRI Shapefiles, see 6.30 Import: How can I import ESRI Shapefiles and to work around limitations of `open_basedir` for uploaded files, see 1.11 I get an ‘open_basedir restriction’ while uploading a file from the query box..

  If the directory where phpMyAdmin is installed is subject to an `open_basedir` 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 `index.html` file there, so that directory listing is not possible.

  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:

      chown www-data:www-data tmp
      chmod 700 tmp

  If you cannot change owner of the directory, you can achieve a similar setup using ACL:

      chmod 700 tmp
      setfacl -m "g:www-data:rwx" tmp
      setfacl -d -m "g:www-data:rwx" tmp

  If neither of above works for you, you can still make the directory chmod 777, but it might impose risk of other users on system reading and writing data in this directory.

## Various display setting

`$cfg['ShowDisplayDirection']`

  Type: | boolean
  Default value: | false

  Defines whether or not type display direction option is shown when browsing a table.

`$cfg['RepeatCells']`

  Type: | integer
  Default value: | 100

  Repeat the headers every X cells, or 0 to deactivate.

`$cfg['EditInWindow']`

  Type: | boolean
  Default value: | true

`$cfg['QueryWindowWidth']`

  Type: | integer
  Default value: | 550

`$cfg['QueryWindowHeight']`

  Type: | integer
  Default value: | 310

`$cfg['QueryHistoryDB']`

  Type: | boolean
  Default value: | false

`$cfg['QueryWindowDefTab']`

  Type: | string
  Default value: | `'sql'`

`$cfg['QueryHistoryMax']`

  Type: | integer
  Default value: | 25

  All those variables affect the query window feature. A SQL link or icon is always displayed in the navigation panel. If JavaScript is enabled in your browser, a click on this opens a distinct query window, which is a direct interface to enter SQL queries. Otherwise, the right panel changes to display a query box.

  The size of this query window can be customized with `$cfg['QueryWindowWidth']` and `$cfg['QueryWindowHeight']` - both integers for the size in pixels. Note that normally, those parameters will be modified in `layout.inc.php`` for the theme you are using.

  If `$cfg['EditInWindow']` is set to true, a click on [Edit] from the results page (in the Showing Rows section) opens the query window and puts the current query inside it. If set to false, clicking on the link puts the SQL query in the right panel’s query box.

  If `$cfg['QueryHistoryDB']` is set to `true`, all your Queries are logged to a table, which has to be created by you (see `$cfg['Servers'][$i]['history']`). 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.

  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 SQL 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.

  If `$cfg['QueryHistoryDB']` is set to `true` you can specify the amount of saved history items using `$cfg['QueryHistoryMax']`.

  The query window also has a custom tabbed look to group the features. Using the variable `$cfg['QueryWindowDefTab']` 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`.

`$cfg['BrowseMIME']`

  Type: | boolean
  Default value: | true

  Enable Transformations.

`$cfg['MaxExactCount']`

  Type: | integer
  Default value: | 0

  For InnoDB tables, determines for how large tables phpMyAdmin should get the exact row count using `SELECT COUNT`. If the approximate row count as returned by `SHOW TABLE STATUS` is smaller than this value, `SELECT COUNT` will be used, otherwise the approximate count will be used.

`$cfg['MaxExactCountViews']`

  Type: | integer
  Default value: | 0

  For VIEWs, since obtaining the exact count could have an impact on performance, this value is the maximum to be displayed, using a `SELECT COUNT ... LIMIT`. Setting this to 0 bypasses any row counting.

`$cfg['NaturalOrder']`

  Type: | boolean
  Default value: | true

  Sorts database and table names according to natural order (for example, t1, t2, t10). Currently implemented in the navigation panel and in Database view, for the table list.

`$cfg['InitialSlidersState']`

  Type: | string
  Default value: | `'closed'`

  If set to `'closed'`, the visual sliders are initially in a closed state. A value of `'open'` does the reverse. To completely disable all visual sliders, use `'disabled'`.

`$cfg['UserprefsDisallow']`

  Type: | array
  Default value: | array()

  Contains names of configuration options (keys in `$cfg` array) that users can’t set through user preferences. For possible values, refer to `libraries/config/user_preferences.forms.php`.

`$cfg['UserprefsDeveloperTab']`

  Type: | boolean
  Default value: | false

  Activates in the user preferences a tab containing options for developers of phpMyAdmin.

## Page titles

`$cfg['TitleTable']`

  Type: | string
  Default value: | `'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ / @TABLE@ | @PHPMYADMIN@'`

`$cfg['TitleDatabase']`

  Type: | string
  Default value: | `'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ | @PHPMYADMIN@'`

`$cfg['TitleServer']`

  Type: | string
  Default value: | `'@HTTP_HOST@ / @VSERVER@ | @PHPMYADMIN@'`

`$cfg['TitleDefault']`

  Type: | string
  Default value: | `'@HTTP_HOST@ | @PHPMYADMIN@'`

  Allows you to specify window’s title bar. You can use 6.27 What format strings can I use?.

## Theme manager settings

`$cfg['ThemePath']`

  Type: | string
  Default value: | `'./themes'`

  If theme manager is active, use this as the path of the subdirectory containing all the themes.

`$cfg['ThemeManager']`

  Type: | boolean
  Default value: | true

  Enables user-selectable themes. See 2.7 Using and creating themes.

`$cfg['ThemeDefault']`

  Type: | string
  Default value: | `'pmahomme'`

  The default theme (a subdirectory under `$cfg['ThemePath']`).

`$cfg['ThemePerServer']`

  Type: | boolean
  Default value: | false

  Whether to allow different theme for each server.

## Default queries

`$cfg['DefaultQueryTable']`

  Type: | string
  Default value: | `'SELECT * FROM @TABLE@ WHERE 1'`

`$cfg['DefaultQueryDatabase']`

  Type: | string
  Default value: | `''`

  Default queries that will be displayed in query boxes when user didn’t specify any. You can use standard 6.27 What format strings can I use?.

## SQL parser settings

`$cfg['SQP']['fmtType']`

  Type: | string
  Default value: | `'html'`

  The main use of the new SQL Parser is to pretty-print SQL queries. By default we use HTML to format the query, but you can disable this by setting this variable to `'none'`.

  Available options:

  - `'html'`
  - `'none'`

`$cfg['SQP']['fmtInd']`

  Type: | float
  Default value: | `'1'`

`$cfg['SQP']['fmtIndUnit']`

  Type: | string
  Default value: | `'em'`

  For the pretty-printing of SQL queries, under some cases the part of a query inside a bracket is indented. By changing `$cfg['SQP']['fmtInd']` you can change the amount of this indent.

  Related in purpose is `$cfg['SQP']['fmtIndUnit']` which specifies the units of the indent amount that you specified. This is used via stylesheets.

  You can use any HTML unit, for example:

  - `'em'`
  - `'ex'`
  - `'pt'`
  - `'px'`

`$cfg['SQP']['fmtColor']`

  Type: | array of string tuples
  Default value: |

  This array is used to define the colours for each type of element of the pretty-printed SQL queries. The tuple format is class => [HTML colour code | empty string]

  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.

  Class name key:

  comment
    Applies to all comment sub-classes
  comment_mysql
    Comments as `"#...\n"`
  comment_ansi
    Comments as `"-- ...\n"`
  comment_c
    Comments as `"/*...*/"`
  digit
    Applies to all digit sub-classes
  digit_hex
    Hexadecimal numbers
  digit_integer
    Integer numbers
  digit_float
    Floating point numbers
  punct
    Applies to all punctuation sub-classes
  punct_bracket_open_round
    Opening brackets `"("`
  punct_bracket_close_round
    Closing brackets `")"`
  punct_listsep
    List item Separator `","`
  punct_qualifier
    Table/Column Qualifier `"."`
  punct_queryend
    End of query marker `";"`
  alpha
    Applies to all alphabetic classes
  alpha_columnType
    Identifiers matching a column type
  alpha_columnAttrib
    Identifiers matching a database/table/column attribute
  alpha_functionName
    Identifiers matching a MySQL function name
  alpha_reservedWord
    Identifiers matching any other reserved word
  alpha_variable
    Identifiers matching a SQL variable `"@foo"`
  alpha_identifier
    All other identifiers
  quote
    Applies to all quotation mark classes
  quote_double
    Double quotes `"`
  quote_single
    Single quotes `'`
  quote_backtick
    Backtick quotes ```

## SQL validator settings

`$cfg['SQLValidator']`

  Type: | array
  Default value: | array(...)

`$cfg['SQLValidator']['use']`

  Type: | boolean
  Default value: | false

  phpMyAdmin now supports use of the Mimer SQL Validator service, as originally published on Slashdot. For help in setting up your system to use the service, see the 6.14 How do I set up the SQL Validator?.

`$cfg['SQLValidator']['username']`

  Type: | string
  Default value: | `''`

`$cfg['SQLValidator']['password']`

  Type: | string
  Default value: | `''`

  The SOAP service allows you to log in with `anonymous` 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.

## MySQL settings

`$cfg['DefaultFunctions']`

  Type: | array
  Default value: | array(...)

  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 `first_timestamp`, which is used for first timestamp column in table.

## Developer

Warning

These settings might have huge effect on performance or security.

`$cfg['DBG']`

  Type: | array
  Default value: | array(...)

`$cfg['DBG']['sql']`

  Type: | boolean
  Default value: | false

  Enable logging queries and execution times to be displayed in the bottom of main page (right frame).

`$cfg['Error_Handler']['display']`

  Type: | boolean
  Default value: | false

  Whether to display errors from PHP or not.

`$cfg['Error_Handler']['gather']`

  Type: | boolean
  Default value: | false

  Whether to gather errors from PHP or not.

### Navigation

- index
- next |
- previous |
- phpMyAdmin 4.0.10.1 documentation »