doc/config.rst

   1 .. index:: config.inc.php
   2
   3 .. _config:
   4
   5 Configuration
   6 =============
   7
   8 Almost all configurable data is placed in :file:`config.inc.php`. If this file
   9 does not exist, please refer to the :ref:`setup` section to create one. This
  10 file only needs to contain the parameters you want to change from their
  11 corresponding default value in :file:`libraries/config.default.php`.
  12
  13 If a directive is missing from your file, you can just add another line with
  14 the file. This file is for over-writing the defaults; if you wish to use the
  15 default value there's no need to add a line here.
  16
  17 The parameters which relate to design (like colors) are placed in
  18 :file:`themes/themename/layout.inc.php`. You might also want to create
  19 :file:`config.footer.inc.php` and :file:`config.header.inc.php` files to add
  20 your site specific code to be included on start and end of each page.
  21
  22 .. note::
  23
  24     Some distributions (eg. Debian or Ubuntu) store :file:`config.inc.php` in
  25     ``/etc/phpmyadmin`` instead of within phpMyAdmin sources.
  26
  27 .. warning::
  28
  29     :term:`Mac` users should note that if you are on a version before
  30     :term:`Mac OS X`, PHP does not seem to
  31     like :term:`Mac` end of lines character (``\r``). So
  32     ensure you choose the option that allows to use the \*nix end of line
  33     character (``\n``) in your text editor before saving a script you have
  34     modified.
  35
  36 Basic settings
  37 --------------
  38
  39 .. config:option:: $cfg['PmaAbsoluteUri']
  40
  41     :type: string
  42     :default: ``''``
  43
  44     Sets here the complete :term:`URL` (with full path) to your phpMyAdmin
  45     installation's directory. E.g.
  46     ``http://www.example.net/path_to_your_phpMyAdmin_directory/``.  Note also
  47     that the :term:`URL` on most of web servers are case–sensitive. Don’t
  48     forget the trailing slash at the end.
  49
  50     Starting with version 2.3.0, it is advisable to try leaving this blank. In
  51     most cases phpMyAdmin automatically detects the proper setting. Users of
  52     port forwarding will need to set :config:option:`$cfg['PmaAbsoluteUri']`
  53     (`more info <https://sourceforge.net/p/phpmyadmin/support-requests/795/>`_).
  54
  55     A good test is to browse a table, edit a row and save it. There should be
  56     an error message if phpMyAdmin is having trouble auto–detecting the correct
  57     value. If you get an error that this must be set or if the autodetect code
  58     fails to detect your path, please post a bug report on our bug tracker so
  59     we can improve the code.
  60
  61     .. seealso:: :ref:`faq1_40`
  62
  63 .. config:option:: $cfg['PmaNoRelation_DisableWarning']
  64
  65     :type: boolean
  66     :default: false
  67
  68     Starting with version 2.3.0 phpMyAdmin offers a lot of features to
  69     work with master / foreign – tables (see :config:option:`$cfg['Servers'][$i]['pmadb']`).
  70
  71     If you tried to set this
  72     up and it does not work for you, have a look on the :guilabel:`Structure` page
  73     of one database where you would like to use it. You will find a link
  74     that will analyze why those features have been disabled.
  75
  76     If you do not want to use those features set this variable to ``true`` to
  77     stop this message from appearing.
  78
  79 .. config:option:: $cfg['SuhosinDisableWarning']
  80
  81     :type: boolean
  82     :default: false
  83
  84     A warning is displayed on the main page if Suhosin is detected.
  85
  86     You can set this parameter to ``true`` to stop this message from appearing.
  87
  88 .. config:option:: $cfg['LoginCookieValidityDisableWarning']
  89
  90     :type: boolean
  91     :default: false
  92
  93     A warning is displayed on the main page if the PHP parameter
  94     session.gc_maxlifetime is lower than cookie validity configured in phpMyAdmin.
  95
  96     You can set this parameter to ``true`` to stop this message from appearing.
  97
  98 .. config:option:: $cfg['ServerLibraryDifference_DisableWarning']
  99
 100     :type: boolean
 101     :default: false
 102
 103     A warning is displayed on the main page if there is a difference
 104     between the MySQL library and server version.
 105
 106     You can set this parameter to ``true`` to stop this message from appearing.
 107
 108 .. config:option:: $cfg['ReservedWordDisableWarning']
 109
 110     :type: boolean
 111     :default: false
 112
 113     This warning is displayed on the Structure page of a table if one or more
 114     column names match with words which are MySQL reserved.
 115
 116     If you want to turn off this warning, you can set it to ``true`` and
 117     warning will no longer be displayed.
 118
 119 .. config:option:: $cfg['TranslationWarningThreshold']
 120
 121     :type: integer
 122     :default: 80
 123
 124     Show warning about incomplete translations on certain threshold.
 125
 126 .. config:option:: $cfg['SendErrorReports']
 127
 128     :type: string
 129     :default: ``'ask'``
 130
 131     Sets the default behavior for JavaScript error reporting.
 132
 133     Whenever an error is detected in the JavaScript execution, an error report
 134     may be sent to the phpMyAdmin team if the user agrees.
 135
 136     The default setting of ``'ask'`` will ask the user everytime there is a new
 137     error report. However you can set this parameter to ``'always'`` to send error
 138     reports without asking for confirmation or you can set it to ``'never'`` to
 139     never send error reports.
 140
 141     This directive is available both in the configuration file and in users
 142     preferences. If the person in charge of a multi-user installation prefers
 143     to disable this feature for all users, a value of ``'never'`` should be
 144     set, and the :config:option:`$cfg['UserprefsDisallow']` directive should
 145     contain ``'SendErrorReports'`` in one of its array values.
 146
 147 .. config:option:: $cfg['AllowThirdPartyFraming']
 148
 149     :type: boolean
 150     :default: false
 151
 152     Setting this to ``true`` allows phpMyAdmin to be included inside a frame,
 153     and is a potential security hole allowing cross-frame scripting attacks or
 154     clickjacking.
 155
 156 Server connection settings
 157 --------------------------
 158
 159 .. config:option:: $cfg['Servers']
 160
 161     :type: array
 162     :default: one server array with settings listed bellow
 163
 164     Since version 1.4.2, phpMyAdmin supports the administration of multiple
 165     MySQL servers. Therefore, a :config:option:`$cfg['Servers']`-array has been
 166     added which contains the login information for the different servers. The
 167     first :config:option:`$cfg['Servers'][$i]['host']` contains the hostname of
 168     the first server, the second :config:option:`$cfg['Servers'][$i]['host']`
 169     the hostname of the second server, etc. In
 170     :file:`libraries/config.default.php`, there is only one section for server
 171     definition, however you can put as many as you need in
 172     :file:`config.inc.php`, copy that block or needed parts (you don't have to
 173     define all settings, just those you need to change).
 174
 175     .. note::
 176
 177         The :config:option:`$cfg['Servers']` array starts with
 178         $cfg['Servers'][1]. Do not use $cfg['Servers'][0]. If you want more
 179         than one server, just copy following section (including $i
 180         incrementation) serveral times. There is no need to define full server
 181         array, just define values you need to change.
 182
 183
 184 .. config:option:: $cfg['Servers'][$i]['host']
 185
 186     :type: string
 187     :default: ``'localhost'``
 188
 189     The hostname or :term:`IP` address of your $i-th MySQL-server. E.g.
 190     ``localhost``.
 191
 192     Possible values are:
 193
 194     * hostname, e.g., ``'localhost'`` or ``'mydb.example.org'``
 195     * IP address, e.g., ``'127.0.0.1'`` or ``'192.168.10.1'``
 196     * dot - ``'.'``, i.e., use named pipes on windows systems
 197     * empty - ``''``, disables this server
 198
 199     .. note::
 200
 201         phpMyAdmin supports connecting to MySQL servers reachable via IPv6 only.
 202                 To connect to an IPv6 MySQL server, enter its IPv6 address in this field.
 203
 204 .. config:option:: $cfg['Servers'][$i]['port']
 205
 206     :type: string
 207     :default: ``''``
 208
 209     The port-number of your $i-th MySQL-server. Default is 3306 (leave
 210     blank).
 211
 212     .. note::
 213
 214        If you use ``localhost`` as the hostname, MySQL ignores this port number
 215        and connects with the socket, so if you want to connect to a port
 216        different from the default port, use ``127.0.0.1`` or the real hostname
 217        in :config:option:`$cfg['Servers'][$i]['host']`.
 218
 219 .. config:option:: $cfg['Servers'][$i]['socket']
 220
 221     :type: string
 222     :default: ``''``
 223
 224     The path to the socket to use. Leave blank for default. To determine
 225     the correct socket, check your MySQL configuration or, using the
 226     :command:`mysql` command–line client, issue the ``status`` command. Among the
 227     resulting information displayed will be the socket used.
 228
 229 .. config:option:: $cfg['Servers'][$i]['ssl']
 230
 231     :type: boolean
 232     :default: false
 233
 234     Whether to enable SSL for the connection between phpMyAdmin and the MySQL server.
 235
 236     When using the ``'mysql'`` extension,
 237     none of the remaining ``'ssl...'`` configuration options apply.
 238
 239     We strongly recommend the ``'mysqli'`` extension when using this option.
 240
 241 .. config:option:: $cfg['Servers'][$i]['ssl_key']
 242
 243     :type: string
 244     :default: NULL
 245
 246     Path to the key file when using SSL for connecting to the MySQL server.
 247
 248     For example:
 249
 250     .. code-block:: php
 251
 252         $cfg['Servers'][$i]['ssl_key'] = '/etc/mysql/server-key.pem';
 253
 254 .. config:option:: $cfg['Servers'][$i]['ssl_cert']
 255
 256     :type: string
 257     :default: NULL
 258
 259     Path to the cert file when using SSL for connecting to the MySQL server.
 260
 261 .. config:option:: $cfg['Servers'][$i]['ssl_ca']
 262
 263     :type: string
 264     :default: NULL
 265
 266     Path to the CA file when using SSL for connecting to the MySQL server.
 267
 268 .. config:option:: $cfg['Servers'][$i]['ssl_ca_path']
 269
 270     :type: string
 271     :default: NULL
 272
 273     Directory containing trusted SSL CA certificates in PEM format.
 274
 275 .. config:option:: $cfg['Servers'][$i]['ssl_ciphers']
 276
 277     :type: string
 278     :default: NULL
 279
 280     List of allowable ciphers for SSL connections to the MySQL server.
 281
 282 .. config:option:: $cfg['Servers'][$i]['connect_type']
 283
 284     :type: string
 285     :default: ``'tcp'``
 286
 287     What type connection to use with the MySQL server. Your options are
 288     ``'socket'`` and ``'tcp'``. It defaults to tcp as that is nearly guaranteed
 289     to be available on all MySQL servers, while sockets are not supported on
 290     some platforms. To use the socket mode, your MySQL server must be on the
 291     same machine as the Web server.
 292
 293 .. config:option:: $cfg['Servers'][$i]['compress']
 294
 295     :type: boolean
 296     :default: false
 297
 298     Whether to use a compressed protocol for the MySQL server connection
 299     or not (experimental).
 300
 301 .. _controlhost:
 302 .. config:option:: $cfg['Servers'][$i]['controlhost']
 303
 304     :type: string
 305     :default: ``''``
 306
 307     Permits to use an alternate host to hold the configuration storage
 308     data.
 309
 310 .. _controlport:
 311 .. config:option:: $cfg['Servers'][$i]['controlport']
 312
 313     :type: string
 314     :default: ``''``
 315
 316     Permits to use an alternate port to connect to the host that
 317     holds the configuration storage.
 318
 319 .. _controluser:
 320 .. config:option:: $cfg['Servers'][$i]['controluser']
 321
 322     :type: string
 323     :default: ``''``
 324
 325 .. config:option:: $cfg['Servers'][$i]['controlpass']
 326
 327     :type: string
 328     :default: ``''``
 329
 330     This special account is used for 2 distinct purposes: to make possible all
 331     relational features (see :config:option:`$cfg['Servers'][$i]['pmadb']`).
 332
 333     .. versionchanged:: 2.2.5
 334         those were called ``stduser`` and ``stdpass``
 335
 336     .. seealso:: :ref:`setup`, :ref:`authentication_modes`, :ref:`linked-tables`
 337
 338 .. config:option:: $cfg['Servers'][$i]['auth_type']
 339
 340     :type: string
 341     :default: ``'cookie'``
 342
 343     Whether config or cookie or :term:`HTTP` or signon authentication should be
 344     used for this server.
 345
 346     * 'config' authentication (``$auth_type = 'config'``) is the plain old
 347       way: username and password are stored in :file:`config.inc.php`.
 348     * 'cookie' authentication mode (``$auth_type = 'cookie'``) allows you to
 349       log in as any valid MySQL user with the help of cookies.
 350     * 'http' authentication allows you to log in as any
 351       valid MySQL user via HTTP-Auth.
 352     * 'signon' authentication mode (``$auth_type = 'signon'``) allows you to
 353       log in from prepared PHP session data or using supplied PHP script.
 354
 355     .. seealso:: :ref:`authentication_modes`
 356
 357 .. _servers_auth_http_realm:
 358 .. config:option:: $cfg['Servers'][$i]['auth_http_realm']
 359
 360     :type: string
 361     :default: ``''``
 362
 363     When using auth\_type = ``http``, this field allows to define a custom
 364     :term:`HTTP` Basic Auth Realm which will be displayed to the user. If not
 365     explicitly specified in your configuration, a string combined of
 366     "phpMyAdmin " and either :config:option:`$cfg['Servers'][$i]['verbose']` or
 367     :config:option:`$cfg['Servers'][$i]['host']` will be used.
 368
 369 .. _servers_auth_swekey_config:
 370 .. config:option:: $cfg['Servers'][$i]['auth_swekey_config']
 371
 372     :type: string
 373     :default: ``''``
 374
 375     The name of the file containing :ref:`swekey` ids and login names for hardware
 376     authentication. Leave empty to deactivate this feature.
 377
 378 .. _servers_user:
 379 .. config:option:: $cfg['Servers'][$i]['user']
 380
 381     :type: string
 382     :default: ``'root'``
 383
 384 .. config:option:: $cfg['Servers'][$i]['password']
 385
 386     :type: string
 387     :default: ``''``
 388
 389     When using :config:option:`$cfg['Servers'][$i]['auth_type']` set to
 390     'config', this is the user/password-pair which phpMyAdmin will use to
 391     connect to the MySQL server. This user/password pair is not needed when
 392     :term:`HTTP` or cookie authentication is used
 393     and should be empty.
 394
 395 .. _servers_nopassword:
 396 .. config:option:: $cfg['Servers'][$i]['nopassword']
 397
 398     :type: boolean
 399     :default: false
 400
 401     Allow attempt to log in without password when a login with password
 402     fails. This can be used together with http authentication, when
 403     authentication is done some other way and phpMyAdmin gets user name
 404     from auth and uses empty password for connecting to MySQL. Password
 405     login is still tried first, but as fallback, no password method is
 406     tried.
 407
 408 .. _servers_only_db:
 409 .. config:option:: $cfg['Servers'][$i]['only_db']
 410
 411     :type: string or array
 412     :default: ``''``
 413
 414     If set to a (an array of) database name(s), only this (these)
 415     database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
 416     this/these database(s) name(s) may contain MySQL wildcards characters
 417     ("\_" and "%"): if you want to use literal instances of these
 418     characters, escape them (I.E. use ``'my\_db'`` and not ``'my_db'``).
 419
 420     This setting is an efficient way to lower the server load since the
 421     latter does not need to send MySQL requests to build the available
 422     database list. But **it does not replace the privileges rules of the
 423     MySQL database server**. If set, it just means only these databases
 424     will be displayed but **not that all other databases can't be used.**
 425
 426     An example of using more that one database:
 427
 428     .. code-block:: php
 429
 430         $cfg['Servers'][$i]['only_db'] = array('db1', 'db2');
 431
 432     .. versionchanged:: 4.0.0
 433         Previous versions permitted to specify the display order of
 434         the database names via this directive.
 435
 436 .. config:option:: $cfg['Servers'][$i]['hide_db']
 437
 438     :type: string
 439     :default: ``''``
 440
 441     Regular expression for hiding some databases from unprivileged users.
 442     This only hides them from listing, but a user is still able to access
 443     them (using, for example, the SQL query area). To limit access, use
 444     the MySQL privilege system.  For example, to hide all databases
 445     starting with the letter "a", use
 446
 447     .. code-block:: php
 448
 449         $cfg['Servers'][$i]['hide_db'] = '^a';
 450
 451     and to hide both "db1" and "db2" use
 452
 453     .. code-block:: php
 454
 455         $cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$';
 456
 457     More information on regular expressions can be found in the `PCRE
 458     pattern syntax
 459     <http://php.net/manual/en/reference.pcre.pattern.syntax.php>`_ portion
 460     of the PHP reference manual.
 461
 462 .. config:option:: $cfg['Servers'][$i]['verbose']
 463
 464     :type: string
 465     :default: ``''``
 466
 467     Only useful when using phpMyAdmin with multiple server entries. If
 468     set, this string will be displayed instead of the hostname in the
 469     pull-down menu on the main page. This can be useful if you want to
 470     show only certain databases on your system, for example. For HTTP
 471     auth, all non-US-ASCII characters will be stripped.
 472
 473 .. config:option:: $cfg['Servers'][$i]['pmadb']
 474
 475     :type: string
 476     :default: ``''``
 477
 478     The name of the database containing the phpMyAdmin configuration
 479     storage.
 480
 481     See the :ref:`linked-tables`  section in this document to see the benefits of
 482     this feature, and for a quick way of creating this database and the needed
 483     tables.
 484
 485     If you are the only user of this phpMyAdmin installation, you can use your
 486     current database to store those special tables; in this case, just put your
 487     current database name in :config:option:`$cfg['Servers'][$i]['pmadb']`. For a
 488     multi-user installation, set this parameter to the name of your central
 489     database containing the phpMyAdmin configuration storage.
 490
 491 .. _bookmark:
 492 .. config:option:: $cfg['Servers'][$i]['bookmarktable']
 493
 494     :type: string
 495     :default: ``''``
 496
 497     Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This
 498     can be useful for queries you often run. To allow the usage of this
 499     functionality:
 500
 501     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 502     * enter the table name in :config:option:`$cfg['Servers'][$i]['bookmarktable']`
 503
 504
 505 .. _relation:
 506 .. config:option:: $cfg['Servers'][$i]['relation']
 507
 508     :type: string
 509     :default: ``''``
 510
 511     Since release 2.2.4 you can describe, in a special 'relation' table,
 512     which column is a key in another table (a foreign key). phpMyAdmin
 513     currently uses this to:
 514
 515     * make clickable, when you browse the master table, the data values that
 516       point to the foreign table;
 517     * display in an optional tool-tip the "display column" when browsing the
 518       master table, if you move the mouse to a column containing a foreign
 519       key (use also the 'table\_info' table); (see :ref:`faqdisplay`)
 520     * in edit/insert mode, display a drop-down list of possible foreign keys
 521       (key value and "display column" are shown) (see :ref:`faq6_21`)
 522     * display links on the table properties page, to check referential
 523       integrity (display missing foreign keys) for each described key;
 524     * in query-by-example, create automatic joins (see :ref:`faq6_6`)
 525     * enable you to get a :term:`PDF` schema of
 526       your database (also uses the table\_coords table).
 527
 528     The keys can be numeric or character.
 529
 530     To allow the usage of this functionality:
 531
 532     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 533     * put the relation table name in :config:option:`$cfg['Servers'][$i]['relation']`
 534     * now as normal user open phpMyAdmin and for each one of your tables
 535       where you want to use this feature, click :guilabel:`Structure/Relation view/`
 536       and choose foreign columns.
 537
 538     .. note::
 539
 540         In the current version, ``master_db`` must be the same as ``foreign_db``.
 541         Those columns have been put in future development of the cross-db
 542         relations.
 543
 544 .. _table_info:
 545 .. config:option:: $cfg['Servers'][$i]['table_info']
 546
 547     :type: string
 548     :default: ``''``
 549
 550     Since release 2.3.0 you can describe, in a special 'table\_info'
 551     table, which column is to be displayed as a tool-tip when moving the
 552     cursor over the corresponding key. This configuration variable will
 553     hold the name of this special table. To allow the usage of this
 554     functionality:
 555
 556     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 557     * put the table name in :config:option:`$cfg['Servers'][$i]['table\_info']` (e.g.
 558       ``pma__table_info``)
 559     * then for each table where you want to use this feature, click
 560       "Structure/Relation view/Choose column to display" to choose the
 561       column.
 562
 563     .. seealso:: :ref:`faqdisplay`
 564
 565 .. _table_coords:
 566 .. config:option:: $cfg['Servers'][$i]['table_coords']
 567
 568     :type: string
 569     :default: ``''``
 570
 571 .. config:option:: $cfg['Servers'][$i]['pdf_pages']
 572
 573     :type: string
 574     :default: ``''``
 575
 576     Since release 2.3.0 you can have phpMyAdmin create :term:`PDF` pages
 577     showing the relations between your tables. Further, the designer interface
 578     permits visually managing the relations. To do this it needs two tables
 579     "pdf\_pages" (storing information about the available :term:`PDF` pages)
 580     and "table\_coords" (storing coordinates where each table will be placed on
 581     a :term:`PDF` schema output).  You must be using the "relation" feature.
 582
 583     To allow the usage of this functionality:
 584
 585     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 586     * put the correct table names in
 587       :config:option:`$cfg['Servers'][$i]['table\_coords']` and
 588       :config:option:`$cfg['Servers'][$i]['pdf\_pages']`
 589
 590     .. seealso:: :ref:`faqpdf`.
 591
 592 .. _col_com:
 593 .. config:option:: $cfg['Servers'][$i]['column_info']
 594
 595     :type: string
 596     :default: ``''``
 597
 598     This part requires a content update!  Since release 2.3.0 you can
 599     store comments to describe each column for each table. These will then
 600     be shown on the "printview".
 601
 602     Starting with release 2.5.0, comments are consequently used on the table
 603     property pages and table browse view, showing up as tool-tips above the
 604     column name (properties page) or embedded within the header of table in
 605     browse view. They can also be shown in a table dump. Please see the
 606     relevant configuration directives later on.
 607
 608     Also new in release 2.5.0 is a MIME- transformation system which is also
 609     based on the following table structure. See :ref:`transformations` for
 610     further information. To use the MIME- transformation system, your
 611     column\_info table has to have the three new columns 'mimetype',
 612     'transformation', 'transformation\_options'.
 613
 614     Starting with release 4.3.0, a new input-oriented transformation system
 615     has been introduced. Also, backward compatibility code used in the old
 616     transformations system was removed. As a result, an update to column\_info
 617     table is necessary for previous transformations and the new input-oriented
 618     transformation system to work. phpMyAdmin will upgrade it automatically
 619     for you by analyzing your current column\_info table structure.
 620     However, if something goes wrong with the auto-upgrade then you can
 621     use the SQL script found in ``./sql/upgrade_column_info_4_3_0+.sql``
 622     to upgrade it manually.
 623
 624     To allow the usage of this functionality:
 625
 626     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 627     * put the table name in :config:option:`$cfg['Servers'][$i]['column\_info']` (e.g.
 628       ``pma__column_info``)
 629     * to update your PRE-2.5.0 Column\_comments table use this:  and
 630       remember that the Variable in :file:`config.inc.php` has been renamed from
 631       :config:option:`$cfg['Servers'][$i]['column\_comments']` to
 632       :config:option:`$cfg['Servers'][$i]['column\_info']`
 633
 634       .. code-block:: mysql
 635
 636            ALTER TABLE `pma__column_comments`
 637            ADD `mimetype` VARCHAR( 255 ) NOT NULL,
 638            ADD `transformation` VARCHAR( 255 ) NOT NULL,
 639            ADD `transformation_options` VARCHAR( 255 ) NOT NULL;
 640     * to update your PRE-4.3.0 Column\_info table manually use this
 641       ``./sql/upgrade_column_info_4_3_0+.sql`` SQL script.
 642
 643     .. note::
 644
 645         For auto-upgrade functionality to work, your
 646         ``$cfg['Servers'][$i]['controluser']`` must have ALTER privilege on
 647         ``phpmyadmin`` database. See the `MySQL documentation for GRANT
 648         <http://dev.mysql.com/doc/mysql/en/grant.html>`_ on how to
 649         ``GRANT`` privileges to a user.
 650
 651 .. _history:
 652 .. config:option:: $cfg['Servers'][$i]['history']
 653
 654     :type: string
 655     :default: ``''``
 656
 657     Since release 2.5.0 you can store your :term:`SQL` history, which means all
 658     queries you entered manually into the phpMyAdmin interface. If you don't
 659     want to use a table-based history, you can use the JavaScript-based
 660     history.
 661
 662     Using that, all your history items are deleted when closing the window.
 663     Using :config:option:`$cfg['QueryHistoryMax']` you can specify an amount of
 664     history items you want to have on hold. On every login, this list gets cut
 665     to the maximum amount.
 666
 667     The query history is only available if JavaScript is enabled in
 668     your browser.
 669
 670     To allow the usage of this functionality:
 671
 672     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 673     * put the table name in :config:option:`$cfg['Servers'][$i]['history']` (e.g.
 674       ``pma__history``)
 675
 676 .. _recent:
 677 .. config:option:: $cfg['Servers'][$i]['recent']
 678
 679     :type: string
 680     :default: ``''``
 681
 682     Since release 3.5.0 you can show recently used tables in the
 683     navigation panel. It helps you to jump across table directly, without
 684     the need to select the database, and then select the table. Using
 685     :config:option:`$cfg['NumRecentTables']` you can configure the maximum number
 686     of recent tables shown. When you select a table from the list, it will jump to
 687     the page specified in :config:option:`$cfg['NavigationTreeDefaultTabTable']`.
 688
 689
 690     Without configuring the storage, you can still access the recently used tables,
 691     but it will disappear after you logout.
 692
 693     To allow the usage of this functionality persistently:
 694
 695     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 696     * put the table name in :config:option:`$cfg['Servers'][$i]['recent']` (e.g.
 697       ``pma__recent``)
 698
 699 .. _table_uiprefs:
 700 .. config:option:: $cfg['Servers'][$i]['table_uiprefs']
 701
 702     :type: string
 703     :default: ``''``
 704
 705     Since release 3.5.0 phpMyAdmin can be configured to remember several
 706     things (sorted column :config:option:`$cfg['RememberSorting']`, column order,
 707     and column visibility from a database table) for browsing tables. Without
 708     configuring the storage, these features still can be used, but the values will
 709     disappear after you logout.
 710
 711     To allow the usage of these functionality persistently:
 712
 713     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 714     * put the table name in :config:option:`$cfg['Servers'][$i]['table\_uiprefs']` (e.g.
 715       ``pma__table_uiprefs``)
 716
 717 .. _configurablemenus:
 718 .. config:option:: $cfg['Servers'][$i]['users']
 719
 720     :type: string
 721     :default: ``''``
 722
 723 .. config:option:: $cfg['Servers'][$i]['usergroups']
 724
 725     :type: string
 726     :default: ``''``
 727
 728     Since release 4.1.0 you can create different user groups with menu items
 729     attached to them. Users can be assigned to these groups and the logged in
 730     user would only see menu items configured to the usergroup he is assigned to.
 731     To do this it needs two tables "usergroups" (storing allowed menu items for each
 732     user group) and "users" (storing users and their assignments to user groups).
 733
 734     To allow the usage of this functionality:
 735
 736     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 737     * put the correct table names in
 738       :config:option:`$cfg['Servers'][$i]['users']` (e.g. ``pma__users``) and
 739       :config:option:`$cfg['Servers'][$i]['usergroups']` (e.g. ``pma__usergroups``)
 740
 741 .. _navigationhiding:
 742 .. config:option:: $cfg['Servers'][$i]['navigationhiding']
 743
 744     :type: string
 745     :default: ``''``
 746
 747     Since release 4.1.0 you can hide/show items in the navigation tree.
 748
 749     To allow the usage of this functionality:
 750
 751     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 752     * put the table name in :config:option:`$cfg['Servers'][$i]['navigationhiding']` (e.g.
 753       ``pma__navigationhiding``)
 754
 755 .. _central_columns:
 756 .. config:option:: $cfg['Servers'][$i]['central_columns']
 757
 758     :type: string
 759     :default: ``''``
 760
 761     Since release 4.3.0 you can have a central list of columns per database.
 762     You can add/remove columns to the list as per your requirement. These columns
 763     in the central list will be available to use while you create a new column for
 764     a table or create a table itself. You can select a column from central list
 765     while creating a new column, it will save you from writing the same column definition
 766     over again or from writing different names for similar column.
 767
 768     To allow the usage of this functionality:
 769
 770     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 771     * put the table name in :config:option:`$cfg['Servers'][$i]['central_columns']` (e.g.
 772       ``pma__central_columns``)
 773
 774 .. _savedsearches:
 775 .. config:option:: $cfg['Servers'][$i]['savedsearches']
 776
 777     :type: string
 778     :default: ``''``
 779
 780     Since release 4.2.0 you can save and load query-by-example searches from the Database > Query panel.
 781
 782     To allow the usage of this functionality:
 783
 784     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 785     * put the table name in :config:option:`$cfg['Servers'][$i]['savedsearches']` (e.g.
 786       ``pma__savedsearches``)
 787
 788 .. _tracking:
 789 .. config:option:: $cfg['Servers'][$i]['tracking']
 790
 791     :type: string
 792     :default: ``''``
 793
 794     Since release 3.3.x a tracking mechanism is available. It helps you to
 795     track every :term:`SQL` command which is
 796     executed by phpMyAdmin. The mechanism supports logging of data
 797     manipulation and data definition statements. After enabling it you can
 798     create versions of tables.
 799
 800     The creation of a version has two effects:
 801
 802     * phpMyAdmin saves a snapshot of the table, including structure and
 803       indexes.
 804     * phpMyAdmin logs all commands which change the structure and/or data of
 805       the table and links these commands with the version number.
 806
 807     Of course you can view the tracked changes. On the :guilabel:`Tracking`
 808     page a complete report is available for every version. For the report you
 809     can use filters, for example you can get a list of statements within a date
 810     range. When you want to filter usernames you can enter \* for all names or
 811     you enter a list of names separated by ','. In addition you can export the
 812     (filtered) report to a file or to a temporary database.
 813
 814     To allow the usage of this functionality:
 815
 816     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 817     * put the table name in :config:option:`$cfg['Servers'][$i]['tracking']` (e.g.
 818       ``pma__tracking``)
 819
 820
 821 .. _tracking2:
 822 .. config:option:: $cfg['Servers'][$i]['tracking_version_auto_create']
 823
 824     :type: boolean
 825     :default: false
 826
 827     Whether the tracking mechanism creates versions for tables and views
 828     automatically.
 829
 830     If this is set to true and you create a table or view with
 831
 832     * CREATE TABLE ...
 833     * CREATE VIEW ...
 834
 835     and no version exists for it, the mechanism will create a version for
 836     you automatically.
 837
 838 .. _tracking3:
 839 .. config:option:: $cfg['Servers'][$i]['tracking_default_statements']
 840
 841     :type: string
 842     :default: ``'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'``
 843
 844     Defines the list of statements the auto-creation uses for new
 845     versions.
 846
 847 .. _tracking4:
 848 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_view']
 849
 850     :type: boolean
 851     :default: true
 852
 853     Whether a DROP VIEW IF EXISTS statement will be added as first line to
 854     the log when creating a view.
 855
 856 .. _tracking5:
 857 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_table']
 858
 859     :type: boolean
 860     :default: true
 861
 862     Whether a DROP TABLE IF EXISTS statement will be added as first line
 863     to the log when creating a table.
 864
 865 .. _tracking6:
 866 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_database']
 867
 868     :type: boolean
 869     :default: true
 870
 871     Whether a DROP DATABASE IF EXISTS statement will be added as first
 872     line to the log when creating a database.
 873
 874 .. _userconfig:
 875 .. config:option:: $cfg['Servers'][$i]['userconfig']
 876
 877     :type: string
 878     :default: ``''``
 879
 880     Since release 3.4.x phpMyAdmin allows users to set most preferences by
 881     themselves and store them in the database.
 882
 883     If you don't allow for storing preferences in
 884     :config:option:`$cfg['Servers'][$i]['pmadb']`, users can still personalize
 885     phpMyAdmin, but settings will be saved in browser's local storage, or, it
 886     is is unavailable, until the end of session.
 887
 888     To allow the usage of this functionality:
 889
 890     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 891     * put the table name in :config:option:`$cfg['Servers'][$i]['userconfig']`
 892
 893 .. config:option:: $cfg['Servers'][$i]['MaxTableUiprefs']
 894
 895     :type: integer
 896     :default: 100
 897
 898     Maximum number of rows saved in
 899     :config:option:`$cfg['Servers'][$i]['table_uiprefs']` table.
 900
 901     When tables are dropped or renamed,
 902     :config:option:`$cfg['Servers'][$i]['table_uiprefs']` may contain invalid data
 903     (referring to tables which no longer exist). We only keep this number of newest
 904     rows in :config:option:`$cfg['Servers'][$i]['table_uiprefs']` and automatically
 905     delete older rows.
 906
 907 .. config:option:: $cfg['Servers'][$i]['SessionTimeZone']
 908
 909     :type: string
 910     :default: ``''``
 911
 912     Sets the time zone used by phpMyAdmin. Leave blank to use the time zone of your
 913     database server. Possible values are explained at
 914     http://dev.mysql.com/doc/refman/5.7/en/time-zone-support.html
 915
 916     This is useful when your database server uses a time zone which is different from the
 917     time zone you want to use in phpMyAdmin.
 918
 919 .. config:option:: $cfg['Servers'][$i]['AllowRoot']
 920
 921     :type: boolean
 922     :default: true
 923
 924     Whether to allow root access. This is just a shortcut for the
 925     :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` below.
 926
 927 .. config:option:: $cfg['Servers'][$i]['AllowNoPassword']
 928
 929     :type: boolean
 930     :default: false
 931
 932     Whether to allow logins without a password. The default value of
 933     ``false`` for this parameter prevents unintended access to a MySQL
 934     server with was left with an empty password for root or on which an
 935     anonymous (blank) user is defined.
 936
 937 .. _servers_allowdeny_order:
 938 .. config:option:: $cfg['Servers'][$i]['AllowDeny']['order']
 939
 940     :type: string
 941     :default: ``''``
 942
 943     If your rule order is empty, then :term:`IP`
 944     authorization is disabled.
 945
 946     If your rule order is set to
 947     ``'deny,allow'`` then the system applies all deny rules followed by
 948     allow rules. Access is allowed by default. Any client which does not
 949     match a Deny command or does match an Allow command will be allowed
 950     access to the server.
 951
 952     If your rule order is set to ``'allow,deny'``
 953     then the system applies all allow rules followed by deny rules. Access
 954     is denied by default. Any client which does not match an Allow
 955     directive or does match a Deny directive will be denied access to the
 956     server.
 957
 958     If your rule order is set to ``'explicit'``, authorization is
 959     performed in a similar fashion to rule order 'deny,allow', with the
 960     added restriction that your host/username combination **must** be
 961     listed in the *allow* rules, and not listed in the *deny* rules. This
 962     is the **most** secure means of using Allow/Deny rules, and was
 963     available in Apache by specifying allow and deny rules without setting
 964     any order.
 965
 966     Please also see :config:option:`$cfg['TrustedProxies']` for
 967     detecting IP address behind proxies.
 968
 969 .. _servers_allowdeny_rules:
 970 .. config:option:: $cfg['Servers'][$i]['AllowDeny']['rules']
 971
 972     :type: array of strings
 973     :default: array()
 974
 975     The general format for the rules is as such:
 976
 977     .. code-block:: none
 978
 979         <'allow' | 'deny'> <username> [from] <ipmask>
 980
 981     If you wish to match all users, it is possible to use a ``'%'`` as a
 982     wildcard in the *username* field.
 983
 984     There are a few shortcuts you can
 985     use in the *ipmask* field as well (please note that those containing
 986     SERVER\_ADDRESS might not be available on all webservers):
 987
 988     .. code-block:: none
 989
 990
 991         'all' -> 0.0.0.0/0
 992         'localhost' -> 127.0.0.1/8
 993         'localnetA' -> SERVER_ADDRESS/8
 994         'localnetB' -> SERVER_ADDRESS/16
 995         'localnetC' -> SERVER_ADDRESS/24
 996
 997     Having an empty rule list is equivalent to either using ``'allow %
 998     from all'`` if your rule order is set to ``'deny,allow'`` or ``'deny %
 999     from all'`` if your rule order is set to ``'allow,deny'`` or
1000     ``'explicit'``.
1001
1002     For the :term:`IP address` matching
1003     system, the following work:
1004
1005     * ``xxx.xxx.xxx.xxx`` (an exact :term:`IP address`)
1006     * ``xxx.xxx.xxx.[yyy-zzz]`` (an :term:`IP address` range)
1007     * ``xxx.xxx.xxx.xxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IP` addresses)
1008
1009     But the following does not work:
1010
1011     * ``xxx.xxx.xxx.xx[yyy-zzz]`` (partial :term:`IP` address range)
1012
1013     For :term:`IPv6` addresses, the following work:
1014
1015     * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx`` (an exact :term:`IPv6` address)
1016     * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:[yyyy-zzzz]`` (an :term:`IPv6` address range)
1017     * ``xxxx:xxxx:xxxx:xxxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IPv6` addresses)
1018
1019     But the following does not work:
1020
1021     * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xx[yyy-zzz]`` (partial :term:`IPv6` address range)
1022
1023 .. config:option:: $cfg['Servers'][$i]['DisableIS']
1024
1025     :type: boolean
1026     :default: false
1027
1028     Disable using ``INFORMATION_SCHEMA`` to retrieve information (use
1029     ``SHOW`` commands instead), because of speed issues when many
1030     databases are present. Currently used in some parts of the code, more
1031     to come.
1032
1033 .. config:option:: $cfg['Servers'][$i]['SignonScript']
1034
1035     :type: string
1036     :default: ``''``
1037
1038     Name of PHP script to be sourced and executed to obtain login
1039     credentials. This is alternative approach to session based single
1040     signon. The script has to provide a function called
1041     ``get_login_credentials`` which returns list of username and
1042     password, accepting single parameter of existing username (can be
1043     empty). See :file:`examples/signon-script.php` for an example:
1044
1045     .. literalinclude:: ../examples/signon-script.php
1046         :language: php
1047
1048     .. seealso:: :ref:`auth_signon`
1049
1050 .. config:option:: $cfg['Servers'][$i]['SignonSession']
1051
1052     :type: string
1053     :default: ``''``
1054
1055     Name of session which will be used for signon authentication method.
1056     You should use something different than ``phpMyAdmin``, because this
1057     is session which phpMyAdmin uses internally. Takes effect only if
1058     :config:option:`$cfg['Servers'][$i]['SignonScript']` is not configured.
1059
1060     .. seealso:: :ref:`auth_signon`
1061
1062 .. config:option:: $cfg['Servers'][$i]['SignonURL']
1063
1064     :type: string
1065     :default: ``''``
1066
1067     :term:`URL` where user will be redirected
1068     to log in for signon authentication method. Should be absolute
1069     including protocol.
1070
1071     .. seealso:: :ref:`auth_signon`
1072
1073 .. config:option:: $cfg['Servers'][$i]['LogoutURL']
1074
1075     :type: string
1076     :default: ``''``
1077
1078     :term:`URL` where user will be redirected
1079     after logout (doesn't affect config authentication method). Should be
1080     absolute including protocol.
1081
1082 Generic settings
1083 ----------------
1084
1085 .. config:option:: $cfg['ServerDefault']
1086
1087     :type: integer
1088     :default: 1
1089
1090     If you have more than one server configured, you can set
1091     :config:option:`$cfg['ServerDefault']` to any one of them to autoconnect to that
1092     server when phpMyAdmin is started, or set it to 0 to be given a list
1093     of servers without logging in.
1094
1095     If you have only one server configured,
1096     :config:option:`$cfg['ServerDefault']` MUST be set to that server.
1097
1098 .. config:option:: $cfg['VersionCheck']
1099
1100     :type: boolean
1101     :default: true
1102
1103     Enables check for latest versions using javascript on main phpMyAdmin
1104     page.
1105
1106     .. note::
1107
1108         This setting can be adjusted by your vendor.
1109
1110 .. config:option:: $cfg['ProxyUrl']
1111
1112     :type: string
1113     :default: ""
1114
1115     The url of the proxy to be used when phpmyadmin needs to access the outside
1116     internet such as when retrieving the latest version info or submitting error
1117     reports.  You need this if the server where phpMyAdmin is installed does not
1118     have direct access to the internet.
1119     The format is: "hostname:portnumber"
1120
1121 .. config:option:: $cfg['ProxyUser']
1122
1123     :type: string
1124     :default: ""
1125
1126     The username for authenticating with the proxy. By default, no
1127     authentication is performed. If a username is supplied, Basic
1128     Authentication will be performed. No other types of authentication
1129     are currently supported.
1130
1131 .. config:option:: $cfg['ProxyPass']
1132
1133     :type: string
1134     :default: ""
1135
1136     The password for authenticating with the proxy.
1137
1138 .. config:option:: $cfg['MaxDbList']
1139
1140     :type: integer
1141     :default: 100
1142
1143     The maximum number of database names to be displayed in the main panel's
1144     database list.
1145
1146 .. config:option:: $cfg['MaxTableList']
1147
1148     :type: integer
1149     :default: 250
1150
1151     The maximum number of table names to be displayed in the main panel's
1152     list (except on the Export page). This limit is also enforced in the
1153     navigation panel when in Light mode.
1154
1155 .. config:option:: $cfg['ShowHint']
1156
1157     :type: boolean
1158     :default: true
1159
1160     Whether or not to show hints (for example, hints when hovering over
1161     table headers).
1162
1163 .. config:option:: $cfg['MaxCharactersInDisplayedSQL']
1164
1165     :type: integer
1166     :default: 1000
1167
1168     The maximum number of characters when a :term:`SQL` query is displayed. The
1169     default limit of 1000 should be correct to avoid the display of tons of
1170     hexadecimal codes that represent BLOBs, but some users have real
1171     :term:`SQL` queries that are longer than 1000 characters. Also, if a
1172     query's length exceeds this limit, this query is not saved in the history.
1173
1174 .. config:option:: $cfg['PersistentConnections']
1175
1176     :type: boolean
1177     :default: false
1178
1179     Whether `persistent connections <http://php.net/manual/en/features
1180     .persistent-connections.php>`_ should be used or not. Works with
1181     following extensions:
1182
1183     * mysql (`mysql\_pconnect <http://php.net/manual/en/function.mysql-
1184       pconnect.php>`_),
1185     * mysqli (requires PHP 5.3.0 or newer, `more information
1186       <http://php.net/manual/en/mysqli.persistconns.php>`_).
1187
1188 .. config:option:: $cfg['ForceSSL']
1189
1190     :type: boolean
1191     :default: false
1192
1193     Whether to force using https while accessing phpMyAdmin. In a reverse
1194     proxy setup, setting this to ``true`` is not supported.
1195
1196     .. note::
1197
1198         In some setups (like separate SSL proxy or load balancer) you might
1199         have to set :config:option:`$cfg['PmaAbsoluteUri']` for correct
1200         redirection.
1201
1202 .. config:option:: $cfg['ExecTimeLimit']
1203
1204     :type: integer [number of seconds]
1205     :default: 300
1206
1207     Set the number of seconds a script is allowed to run. If seconds is
1208     set to zero, no time limit is imposed. This setting is used while
1209     importing/exporting dump files but has
1210     no effect when PHP is running in safe mode.
1211
1212 .. config:option:: $cfg['SessionSavePath']
1213
1214     :type: string
1215     :default: ``''``
1216
1217     Path for storing session data (`session\_save\_path PHP parameter
1218     <http://php.net/session_save_path>`_).
1219
1220 .. config:option:: $cfg['MemoryLimit']
1221
1222     :type: string [number of bytes]
1223     :default: ``'-1'``
1224
1225     Set the number of bytes a script is allowed to allocate. If set to
1226     ``'-1'``, no limit is imposed.
1227
1228     This setting is used while importing/exporting dump files and at some other
1229     places in phpMyAdmin so you definitely don't want to put here a too low
1230     value. It has no effect when PHP is running in safe mode.
1231
1232     You can also use any string as in :file:`php.ini`, eg. '16M'. Ensure you
1233     don't omit the suffix (16 means 16 bytes!)
1234
1235 .. config:option:: $cfg['SkipLockedTables']
1236
1237     :type: boolean
1238     :default: false
1239
1240     Mark used tables and make it possible to show databases with locked
1241     tables (since MySQL 3.23.30).
1242
1243 .. config:option:: $cfg['ShowSQL']
1244
1245     :type: boolean
1246     :default: true
1247
1248     Defines whether :term:`SQL` queries
1249     generated by phpMyAdmin should be displayed or not.
1250
1251 .. config:option:: $cfg['RetainQueryBox']
1252
1253     :type: boolean
1254     :default: false
1255
1256     Defines whether the :term:`SQL` query box
1257     should be kept displayed after its submission.
1258
1259 .. config:option:: $cfg['CodemirrorEnable']
1260
1261     :type: boolean
1262     :default: true
1263
1264     Defines whether to use a Javascript code editor for SQL query boxes.
1265     CodeMirror provides syntax highlighting and line numbers.  However,
1266     middle-clicking for pasting the clipboard contents in some Linux
1267     distributions (such as Ubuntu) is not supported by all browsers.
1268
1269 .. config:option:: $cfg['AllowUserDropDatabase']
1270
1271     :type: boolean
1272     :default: false
1273
1274     Defines whether normal users (non-administrator) are allowed to delete
1275     their own database or not. If set as false, the link :guilabel:`Drop
1276     Database` will not be shown, and even a ``DROP DATABASE mydatabase`` will
1277     be rejected. Quite practical for :term:`ISP` 's with many customers.
1278
1279     .. note::
1280
1281         This limitation of :term:`SQL` queries is not
1282         as strict as when using MySQL privileges. This is due to nature of
1283         :term:`SQL` queries which might be quite
1284         complicated.  So this choice should be viewed as help to avoid accidental
1285         dropping rather than strict privilege limitation.
1286
1287 .. config:option:: $cfg['Confirm']
1288
1289     :type: boolean
1290     :default: true
1291
1292     Whether a warning ("Are your really sure...") should be displayed when
1293     you're about to lose data.
1294
1295 .. config:option:: $cfg['UseDbSearch']
1296
1297     :type: boolean
1298     :default: true
1299
1300     Define whether the "search string inside database" is enabled or not.
1301
1302 .. config:option:: $cfg['IgnoreMultiSubmitErrors']
1303
1304     :type: boolean
1305     :default: false
1306
1307     Define whether phpMyAdmin will continue executing a multi-query
1308     statement if one of the queries fails. Default is to abort execution.
1309
1310 Cookie authentication options
1311 -----------------------------
1312
1313 .. config:option:: $cfg['blowfish_secret']
1314
1315     :type: string
1316     :default: ``''``
1317
1318     The "cookie" auth\_type uses AES algorithm to encrypt the password. If you
1319     are using the "cookie" auth\_type, enter here a random passphrase of your
1320     choice. It will be used internally by the AES algorithm: you won’t be
1321     prompted for this passphrase. There is no maximum length for this secret.
1322
1323     .. note::
1324
1325         The configuration is called blowfish_secret for historical reasons as
1326         Blowfish algorithm was originally used to do the encryption.
1327
1328     .. versionchanged:: 3.1.0
1329         Since version 3.1.0 phpMyAdmin can generate this on the fly, but it
1330         makes a bit weaker security as this generated secret is stored in
1331         session and furthermore it makes impossible to recall user name from
1332         cookie.
1333
1334 .. config:option:: $cfg['LoginCookieRecall']
1335
1336     :type: boolean
1337     :default: true
1338
1339     Define whether the previous login should be recalled or not in cookie
1340     authentication mode.
1341
1342     This is automatically disabled if you do not have
1343     configured :config:option:`$cfg['blowfish_secret']`.
1344
1345 .. config:option:: $cfg['LoginCookieValidity']
1346
1347     :type: integer [number of seconds]
1348     :default: 1440
1349
1350     Define how long a login cookie is valid. Please note that php
1351     configuration option `session.gc\_maxlifetime
1352     <http://php.net/manual/en/session.configuration.php#ini.session.gc-
1353     maxlifetime>`_ might limit session validity and if the session is lost,
1354     the login cookie is also invalidated. So it is a good idea to set
1355     ``session.gc_maxlifetime`` at least to the same value of
1356     :config:option:`$cfg['LoginCookieValidity']`.
1357
1358 .. config:option:: $cfg['LoginCookieStore']
1359
1360     :type: integer [number of seconds]
1361     :default: 0
1362
1363     Define how long login cookie should be stored in browser. Default 0
1364     means that it will be kept for existing session. This is recommended
1365     for not trusted environments.
1366
1367 .. config:option:: $cfg['LoginCookieDeleteAll']
1368
1369     :type: boolean
1370     :default: true
1371
1372     If enabled (default), logout deletes cookies for all servers,
1373     otherwise only for current one. Setting this to false makes it easy to
1374     forget to log out from other server, when you are using more of them.
1375
1376 .. _AllowArbitraryServer:
1377 .. config:option:: $cfg['AllowArbitraryServer']
1378
1379     :type: boolean
1380     :default: false
1381
1382     If enabled, allows you to log in to arbitrary servers using cookie
1383     authentication.
1384
1385     .. note::
1386
1387         Please use this carefully, as this may allow users access to MySQL servers
1388         behind the firewall where your :term:`HTTP` server is placed.
1389         See also :config:option:`$cfg['ArbitraryServerRegexp']`.
1390
1391 .. config:option:: $cfg['ArbitraryServerRegexp']
1392
1393     :type: string
1394     :default: ``''``
1395
1396     Restricts the MySQL servers to which the user can log in when
1397     :config:option:`$cfg['AllowArbitraryServer']` is enabled by
1398     matching the :term:`IP` or the hostname of the MySQL server
1399     to the given regular expression. The regular expression must be enclosed
1400     with a delimiter character.
1401
1402 .. config:option:: $cfg['CaptchaLoginPublicKey']
1403
1404     :type: string
1405     :default: ``''``
1406
1407     The public key for the reCaptcha service that can be obtained from
1408     http://www.google.com/recaptcha.
1409
1410     reCaptcha will be then used in :ref:`cookie`.
1411
1412 .. config:option:: $cfg['CaptchaLoginPrivateKey']
1413
1414     :type: string
1415     :default: ``''``
1416
1417     The private key for the reCaptcha service that can be obtain from
1418     http://www.google.com/recaptcha.
1419
1420     reCaptcha will be then used in :ref:`cookie`.
1421
1422 Navigation panel setup
1423 ----------------------
1424
1425 .. config:option:: $cfg['ShowDatabasesNavigationAsTree']
1426
1427     :type: boolean
1428     :default: true
1429
1430     In the navigation panel, replaces the database tree with a selector
1431
1432 .. config:option:: $cfg['FirstLevelNavigationItems']
1433
1434     :type: integer
1435     :default: 100
1436
1437     The number of first level databases that can be displayed on each page
1438     of navigation tree.
1439
1440 .. config:option:: $cfg['MaxNavigationItems']
1441
1442     :type: integer
1443     :default: 50
1444
1445     The number of items (tables, columns, indexes) that can be displayed on each
1446     page of the navigation tree.
1447
1448 .. config:option:: $cfg['NavigationTreeEnableGrouping']
1449
1450     :type: boolean
1451     :default: true
1452
1453     Defines whether to group the databases based on a common prefix
1454     in their name :config:option:`$cfg['NavigationTreeDbSeparator']`.
1455
1456 .. config:option:: $cfg['NavigationTreeDbSeparator']
1457
1458     :type: string or array
1459     :default: ``'_'``
1460
1461     The string used to separate the parts of the database name when
1462     showing them in a tree. Alternatively you can specify more strings in
1463     an array and all of them will be used as a separator.
1464
1465 .. config:option:: $cfg['NavigationTreeTableSeparator']
1466
1467     :type: string or array
1468     :default: ``'__'``
1469
1470     Defines a string to be used to nest table spaces. This means if you have
1471     tables like ``first__second__third`` this will be shown as a three-level
1472     hierarchy like: first > second > third.  If set to false or empty, the
1473     feature is disabled. NOTE: You should not use this separator at the
1474     beginning or end of a table name or multiple times after another without
1475     any other characters in between.
1476
1477 .. config:option:: $cfg['NavigationTreeTableLevel']
1478
1479     :type: integer
1480     :default: 1
1481
1482     Defines how many sublevels should be displayed when splitting up
1483     tables by the above separator.
1484
1485 .. config:option:: $cfg['NumRecentTables']
1486
1487     :type: integer
1488     :default: 10
1489
1490     The maximum number of recently used tables shown in the navigation
1491     panel. Set this to 0 (zero) to disable the listing of recent tables.
1492
1493 .. config:option:: $cfg['ZeroConf']
1494
1495     :type: boolean
1496     :default: true
1497
1498     Enables Zero Configuration mode in which the user will be offered a choice to
1499     create phpMyAdmin configuration storage in the current database
1500     or use the existing one, if already present.
1501
1502     This setting has no effect if the phpMyAdmin configuration storage database
1503     is properly created and the related configuration directives (such as
1504     :config:option:`$cfg['Servers'][$i]['pmadb']` and so on) are configured.
1505
1506 .. config:option:: $cfg['NavigationLinkWithMainPanel']
1507
1508     :type: boolean
1509     :default: true
1510
1511     Defines whether or not to link with main panel by highlighting
1512     the current database or table.
1513
1514 .. config:option:: $cfg['NavigationDisplayLogo']
1515
1516     :type: boolean
1517     :default: true
1518
1519     Defines whether or not to display the phpMyAdmin logo at the top of
1520     the navigation panel.
1521
1522 .. config:option:: $cfg['NavigationLogoLink']
1523
1524     :type: string
1525     :default: ``'index.php'``
1526
1527     Enter :term:`URL` where logo in the navigation panel will point to.
1528     For use especially with self made theme which changes this.
1529     For external :term:`URL`s, you should include URL scheme as well.
1530
1531 .. config:option:: $cfg['NavigationLogoLinkWindow']
1532
1533     :type: string
1534     :default: ``'main'``
1535
1536     Whether to open the linked page in the main window (``main``) or in a
1537     new one (``new``). Note: use ``new`` if you are linking to
1538     ``phpmyadmin.net``.
1539
1540 .. config:option:: $cfg['NavigationTreeDisplayItemFilterMinimum']
1541
1542     :type: integer
1543     :default: 30
1544
1545     Defines the minimum number of items (tables, views, routines and
1546     events) to display a JavaScript filter box above the list of items in
1547     the navigation tree.
1548
1549     To disable the filter completely some high number can be used (e.g. 9999)
1550
1551 .. config:option:: $cfg['NavigationTreeDisplayDbFilterMinimum']
1552
1553     :type: integer
1554     :default: 30
1555
1556     Defines the minimum number of databases to display a JavaScript filter
1557     box above the list of databases in the navigation tree.
1558
1559     To disable the filter completely some high number can be used
1560     (e.g. 9999)
1561
1562 .. config:option:: $cfg['NavigationDisplayServers']
1563
1564     :type: boolean
1565     :default: true
1566
1567     Defines whether or not to display a server choice at the top of the
1568     navigation panel.
1569
1570 .. config:option:: $cfg['DisplayServersList']
1571
1572     :type: boolean
1573     :default: false
1574
1575     Defines whether to display this server choice as links instead of in a
1576     drop-down.
1577
1578 .. config:option:: $cfg['NavigationTreeDefaultTabTable']
1579
1580     :type: string
1581     :default: ``'tbl_structure.php'``
1582
1583     Defines the tab displayed by default when clicking the small icon next
1584     to each table name in the navigation panel. Possible values:
1585
1586     * ``tbl_structure.php``
1587     * ``tbl_sql.php``
1588     * ``tbl_select.php``
1589     * ``tbl_change.php``
1590     * ``sql.php``
1591
1592 .. config:option:: $cfg['NavigationTreeDefaultTabTable2']
1593
1594     :type: string
1595     :default: null
1596
1597     Defines the tab displayed by default when clicking the second small icon next
1598     to each table name in the navigation panel. Possible values:
1599
1600     * ``(empty)``
1601     * ``tbl_structure.php``
1602     * ``tbl_sql.php``
1603     * ``tbl_select.php``
1604     * ``tbl_change.php``
1605     * ``sql.php``
1606
1607 .. config:option:: $cfg['NavigationTreeEnableExpansion']
1608
1609     :type: boolean
1610     :default: false
1611
1612     Whether to offer the possibility of tree expansion in the navigation panel.
1613
1614 Main panel
1615 ----------
1616
1617 .. config:option:: $cfg['ShowStats']
1618
1619     :type: boolean
1620     :default: true
1621
1622     Defines whether or not to display space usage and statistics about
1623     databases and tables. Note that statistics requires at least MySQL
1624     3.23.3 and that, at this date, MySQL doesn't return such information
1625     for Berkeley DB tables.
1626
1627 .. config:option:: $cfg['ShowServerInfo']
1628
1629     :type: boolean
1630     :default: true
1631
1632     Defines whether to display detailed server information on main page.
1633     You can additionally hide more information by using
1634     :config:option:`$cfg['Servers'][$i]['verbose']`.
1635
1636 .. config:option:: $cfg['ShowPhpInfo']
1637
1638     :type: boolean
1639     :default: false
1640
1641 .. config:option:: $cfg['ShowChgPassword']
1642
1643     :type: boolean
1644     :default: true
1645
1646 .. config:option:: $cfg['ShowCreateDb']
1647
1648     :type: boolean
1649     :default: true
1650
1651     Defines whether to display the :guilabel:`PHP information` and
1652     :guilabel:`Change password` links and form for creating database or not at
1653     the starting main (right) frame. This setting does not check MySQL commands
1654     entered directly.
1655
1656     Please note that to block the usage of ``phpinfo()`` in scripts, you have to
1657     put this in your :file:`php.ini`:
1658
1659     .. code-block:: ini
1660
1661         disable_functions = phpinfo()
1662
1663     Also note that enabling the :guilabel:`Change password` link has no effect
1664     with config authentication mode: because of the hard coded password value
1665     in the configuration file, end users can't be allowed to change their
1666     passwords.
1667
1668 Database structure
1669 ------------------
1670
1671 .. config:option:: $cfg['ShowDbStructureCreation']
1672
1673     :type: boolean
1674     :default: false
1675
1676     Defines whether the database structure page (tables list) has a
1677     "Creation" column that displays when each table was created.
1678
1679 .. config:option:: $cfg['ShowDbStructureLastUpdate']
1680
1681     :type: boolean
1682     :default: false
1683
1684     Defines whether the database structure page (tables list) has a "Last
1685     update" column that displays when each table was last updated.
1686
1687 .. config:option:: $cfg['ShowDbStructureLastCheck']
1688
1689     :type: boolean
1690     :default: false
1691
1692     Defines whether the database structure page (tables list) has a "Last
1693     check" column that displays when each table was last checked.
1694
1695 .. config:option:: $cfg['HideStructureActions']
1696
1697     :type: boolean
1698     :default: true
1699
1700     Defines whether the table structure actions are hidden under a "More"
1701     drop-down.
1702
1703 Browse mode
1704 -----------
1705
1706 .. config:option:: $cfg['TableNavigationLinksMode']
1707
1708     :type: string
1709     :default: ``'icons'``
1710
1711     Defines whether the table navigation links contain ``'icons'``, ``'text'``
1712     or ``'both'``.
1713
1714 .. config:option:: $cfg['ActionLinksMode']
1715
1716     :type: string
1717     :default: ``'both'``
1718
1719     If set to ``icons``, will display icons instead of text for db and table
1720     properties links (like :guilabel:`Browse`, :guilabel:`Select`,
1721     :guilabel:`Insert`, ...). Can be set to ``'both'``
1722     if you want icons AND text. When set to ``text``, will only show text.
1723
1724 .. config:option:: $cfg['RowActionType']
1725
1726     :type: string
1727     :default: ``'both'``
1728
1729     Whether to display icons or text or both icons and text in table row action
1730     segment. Value can be either of ``'icons'``, ``'text'`` or ``'both'``.
1731
1732 .. config:option:: $cfg['ShowAll']
1733
1734     :type: boolean
1735     :default: false
1736
1737     Defines whether a user should be displayed a "Show all" button in browse
1738     mode or not in all cases. By default it is shown only on small tables (less
1739     than 500 rows) to avoid performance issues while getting too many rows.
1740
1741 .. config:option:: $cfg['MaxRows']
1742
1743     :type: integer
1744     :default: 25
1745
1746     Number of rows displayed when browsing a result set and no LIMIT
1747     clause is used. If the result set contains more rows, "Previous" and
1748     "Next" links will be shown. Possible values: 25,50,100,250,500.
1749
1750 .. config:option:: $cfg['Order']
1751
1752     :type: string
1753     :default: ``'SMART'``
1754
1755     Defines whether columns are displayed in ascending (``ASC``) order, in
1756     descending (``DESC``) order or in a "smart" (``SMART``) order - I.E.
1757     descending order for columns of type TIME, DATE, DATETIME and
1758     TIMESTAMP, ascending order else- by default.
1759
1760 .. config:option:: $cfg['GridEditing']
1761
1762     :type: string
1763     :default: ``'double-click'``
1764
1765     Defines which action (``double-click`` or ``click``) triggers grid
1766     editing. Can be deactivated with the ``disabled`` value.
1767
1768 .. config:option:: $cfg['RelationalDisplay']
1769
1770     :type: string
1771     :default: ``'K'``
1772
1773     Defines the initial behavior for Options > Relational. ``K``, which
1774     is the default, displays the key while ``D`` shows the display column.
1775
1776 .. config:option:: $cfg['SaveCellsAtOnce']
1777
1778     :type: boolean
1779     :default: false
1780
1781     Defines whether or not to save all edited cells at once for grid
1782     editing.
1783
1784 Editing mode
1785 ------------
1786
1787 .. config:option:: $cfg['ProtectBinary']
1788
1789     :type: boolean or string
1790     :default: ``'blob'``
1791
1792     Defines whether ``BLOB`` or ``BINARY`` columns are protected from
1793     editing when browsing a table's content. Valid values are:
1794
1795     * ``false`` to allow editing of all columns;
1796     * ``'blob'`` to allow editing of all columns except ``BLOBS``;
1797     * ``'noblob'`` to disallow editing of all columns except ``BLOBS`` (the
1798       opposite of ``'blob'``);
1799     * ``'all'`` to disallow editing of all ``BINARY`` or ``BLOB`` columns.
1800
1801 .. config:option:: $cfg['ShowFunctionFields']
1802
1803     :type: boolean
1804     :default: true
1805
1806     Defines whether or not MySQL functions fields should be initially
1807     displayed in edit/insert mode. Since version 2.10, the user can toggle
1808     this setting from the interface.
1809
1810 .. config:option:: $cfg['ShowFieldTypesInDataEditView']
1811
1812     :type: boolean
1813     :default: true
1814
1815     Defines whether or not type fields should be initially displayed in
1816     edit/insert mode. The user can toggle this setting from the interface.
1817
1818 .. config:option:: $cfg['InsertRows']
1819
1820     :type: integer
1821     :default: 2
1822
1823     Defines the maximum number of concurrent entries for the Insert page.
1824
1825 .. config:option:: $cfg['ForeignKeyMaxLimit']
1826
1827     :type: integer
1828     :default: 100
1829
1830     If there are fewer items than this in the set of foreign keys, then a
1831     drop-down box of foreign keys is presented, in the style described by
1832     the :config:option:`$cfg['ForeignKeyDropdownOrder']` setting.
1833
1834 .. config:option:: $cfg['ForeignKeyDropdownOrder']
1835
1836     :type: array
1837     :default: array('content-id', 'id-content')
1838
1839     For the foreign key drop-down fields, there are several methods of
1840     display, offering both the key and value data. The contents of the
1841     array should be one or both of the following strings: ``content-id``,
1842     ``id-content``.
1843
1844 Export and import settings
1845 --------------------------
1846
1847 .. config:option:: $cfg['ZipDump']
1848
1849     :type: boolean
1850     :default: true
1851
1852 .. config:option:: $cfg['GZipDump']
1853
1854     :type: boolean
1855     :default: true
1856
1857 .. config:option:: $cfg['BZipDump']
1858
1859     :type: boolean
1860     :default: true
1861
1862     Defines whether to allow the use of zip/GZip/BZip2 compression when
1863     creating a dump file
1864
1865 .. config:option:: $cfg['CompressOnFly']
1866
1867     :type: boolean
1868     :default: true
1869
1870     Defines whether to allow on the fly compression for GZip/BZip2
1871     compressed exports. This doesn't affect smaller dumps and allows users
1872     to create larger dumps that won't otherwise fit in memory due to php
1873     memory limit. Produced files contain more GZip/BZip2 headers, but all
1874     normal programs handle this correctly.
1875
1876 .. config:option:: $cfg['Export']
1877
1878     :type: array
1879     :default: array(...)
1880
1881     In this array are defined default parameters for export, names of
1882     items are similar to texts seen on export page, so you can easily
1883     identify what they mean.
1884
1885 .. config:option:: $cfg['Export']['method']
1886
1887     :type: string
1888     :default: ``'quick'``
1889
1890     Defines how the export form is displayed when it loads. Valid values
1891     are:
1892
1893     * ``quick`` to display the minimum number of options to configure
1894     * ``custom`` to display every available option to configure
1895     * ``custom-no-form`` same as ``custom`` but does not display the option
1896       of using quick export
1897
1898
1899
1900 .. config:option:: $cfg['Import']
1901
1902     :type: array
1903     :default: array(...)
1904
1905     In this array are defined default parameters for import, names of
1906     items are similar to texts seen on import page, so you can easily
1907     identify what they mean.
1908
1909
1910 Tabs display settings
1911 ---------------------
1912
1913 .. config:option:: $cfg['TabsMode']
1914
1915     :type: string
1916     :default: ``'both'``
1917
1918     Defines whether the menu tabs contain ``'icons'``, ``'text'`` or ``'both'``.
1919
1920 .. config:option:: $cfg['PropertiesNumColumns']
1921
1922     :type: integer
1923     :default: 1
1924
1925     How many columns will be utilized to display the tables on the database
1926     property view? When setting this to a value larger than 1, the type of the
1927     database will be omitted for more display space.
1928
1929 .. config:option:: $cfg['DefaultTabServer']
1930
1931     :type: string
1932     :default: ``'index.php'``
1933
1934     Defines the tab displayed by default on server view. Possible values:
1935
1936     * ``main.php`` (recommended for multi-user setups)
1937     * ``server_databases.php``,
1938     * ``server_status.php``
1939     * ``server_variables.php``
1940     * ``server_privileges.php``
1941
1942 .. config:option:: $cfg['DefaultTabDatabase']
1943
1944     :type: string
1945     :default: ``'db_structure.php'``
1946
1947     Defines the tab displayed by default on database view. Possible
1948     values:
1949
1950     * ``db_structure.php``
1951     * ``db_sql.php``
1952     * ``db_search.php``.
1953
1954 .. config:option:: $cfg['DefaultTabTable']
1955
1956     :type: string
1957     :default: ``'sql.php'``
1958
1959     Defines the tab displayed by default on table view. Possible values:
1960
1961     * ``tbl_structure.php``
1962     * ``tbl_sql.php``
1963     * ``tbl_select.php``
1964     * ``tbl_change.php``
1965     * ``sql.php``
1966
1967 PDF Options
1968 -----------
1969
1970 .. config:option:: $cfg['PDFPageSizes']
1971
1972     :type: array
1973     :default: ``array('A3', 'A4', 'A5', 'letter', 'legal')``
1974
1975     Array of possible paper sizes for creating PDF pages.
1976
1977     You should never need to change this.
1978
1979 .. config:option:: $cfg['PDFDefaultPageSize']
1980
1981     :type: string
1982     :default: ``'A4'``
1983
1984     Default page size to use when creating PDF pages. Valid values are any
1985     listed in :config:option:`$cfg['PDFPageSizes']`.
1986
1987 Languages
1988 ---------
1989
1990 .. config:option:: $cfg['DefaultLang']
1991
1992     :type: string
1993     :default: ``'en'``
1994
1995     Defines the default language to use, if not browser-defined or user-
1996     defined. The corresponding language file needs to be in
1997     locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
1998
1999 .. config:option:: $cfg['DefaultConnectionCollation']
2000
2001     :type: string
2002     :default: ``'utf8_general_ci'``
2003
2004     Defines the default connection collation to use, if not user-defined.
2005     See the `MySQL documentation for charsets
2006     <http://dev.mysql.com/doc/mysql/en/charset-charsets.html>`_
2007     for list of possible values. This setting is
2008     ignored when connected to Drizzle server.
2009
2010 .. config:option:: $cfg['Lang']
2011
2012     :type: string
2013     :default: not set
2014
2015     Force language to use. The corresponding language file needs to be in
2016     locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
2017
2018 .. config:option:: $cfg['FilterLanguages']
2019
2020     :type: string
2021     :default: ``''``
2022
2023     Limit list of available languages to those matching the given regular
2024     expression. For example if you want only Czech and English, you should
2025     set filter to ``'^(cs|en)'``.
2026
2027 .. config:option:: $cfg['RecodingEngine']
2028
2029     :type: string
2030     :default: ``'auto'``
2031
2032     You can select here which functions will be used for character set
2033     conversion. Possible values are:
2034
2035     * auto - automatically use available one (first is tested iconv, then
2036       recode)
2037     * iconv - use iconv or libiconv functions
2038     * recode - use recode\_string function
2039     * mb - use mbstring extension
2040     * none - disable encoding conversion
2041
2042     Enabled charset conversion activates a pull-down menu in the Export
2043     and Import pages, to choose the character set when exporting a file.
2044     The default value in this menu comes from
2045     :config:option:`$cfg['Export']['charset']` and :config:option:`$cfg['Import']['charset']`.
2046
2047 .. config:option:: $cfg['IconvExtraParams']
2048
2049     :type: string
2050     :default: ``'//TRANSLIT'``
2051
2052     Specify some parameters for iconv used in charset conversion. See
2053     `iconv documentation <http://www.gnu.org/software/libiconv/documentati
2054     on/libiconv/iconv_open.3.html>`_ for details. By default
2055     ``//TRANSLIT`` is used, so that invalid characters will be
2056     transliterated.
2057
2058 .. config:option:: $cfg['AvailableCharsets']
2059
2060     :type: array
2061     :default: array(...)
2062
2063     Available character sets for MySQL conversion. You can add your own
2064     (any of supported by recode/iconv) or remove these which you don't
2065     use. Character sets will be shown in same order as here listed, so if
2066     you frequently use some of these move them to the top.
2067
2068 Web server settings
2069 -------------------
2070
2071 .. config:option:: $cfg['OBGzip']
2072
2073     :type: string/boolean
2074     :default: ``'auto'``
2075
2076     Defines whether to use GZip output buffering for increased speed in
2077     :term:`HTTP` transfers. Set to
2078     true/false for enabling/disabling. When set to 'auto' (string),
2079     phpMyAdmin tries to enable output buffering and will automatically
2080     disable it if your browser has some problems with buffering. IE6 with
2081     a certain patch is known to cause data corruption when having enabled
2082     buffering.
2083
2084 .. config:option:: $cfg['TrustedProxies']
2085
2086     :type: array
2087     :default: array()
2088
2089     Lists proxies and HTTP headers which are trusted for
2090     :config:option:`$cfg['Servers'][$i]['AllowDeny']['order']`. This list is by
2091     default empty, you need to fill in some trusted proxy servers if you
2092     want to use rules for IP addresses behind proxy.
2093
2094     The following example specifies that phpMyAdmin should trust a
2095     HTTP\_X\_FORWARDED\_FOR (``X -Forwarded-For``) header coming from the proxy
2096     1.2.3.4:
2097
2098     .. code-block:: php
2099
2100         $cfg['TrustedProxies'] = array('1.2.3.4' => 'HTTP_X_FORWARDED_FOR');
2101
2102     The :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` directive uses the
2103     client's IP address as usual.
2104
2105 .. config:option:: $cfg['GD2Available']
2106
2107     :type: string
2108     :default: ``'auto'``
2109
2110     Specifies whether GD >= 2 is available. If yes it can be used for MIME
2111     transformations. Possible values are:
2112
2113     * auto - automatically detect
2114     * yes - GD 2 functions can be used
2115     * no - GD 2 function cannot be used
2116
2117 .. config:option:: $cfg['CheckConfigurationPermissions']
2118
2119     :type: boolean
2120     :default: true
2121
2122     We normally check the permissions on the configuration file to ensure
2123     it's not world writable. However, phpMyAdmin could be installed on a
2124     NTFS filesystem mounted on a non-Windows server, in which case the
2125     permissions seems wrong but in fact cannot be detected. In this case a
2126     sysadmin would set this parameter to ``false``.
2127
2128 .. config:option:: $cfg['LinkLengthLimit']
2129
2130     :type: integer
2131     :default: 1000
2132
2133     Limit for length of :term:`URL` in links.  When length would be above this
2134     limit, it is replaced by form with button. This is required as some web
2135     servers (:term:`IIS`) have problems with long :term:`URL` .
2136
2137 .. config:option:: $cfg['CSPAllow']
2138
2139     :type: string
2140     :default: ``''``
2141
2142     Additional string to include in allowed script and image sources in Content
2143     Security Policy header.
2144
2145     This can be useful when you want to include some external javascript files
2146     in :file:`config.footer.inc.php` or :file:`config.header.inc.php`, which
2147     would be normally not allowed by Content Security Policy.
2148
2149     To allow some sites, just list them within the string:
2150
2151     .. code-block:: php
2152
2153         $cfg['CSPAllow'] = 'example.com example.net';
2154
2155     .. versionadded:: 4.0.4
2156
2157 .. config:option:: $cfg['DisableMultiTableMaintenance']
2158
2159     :type: boolean
2160     :default: false
2161
2162     In the database Structure page, it's possible to mark some tables then
2163     choose an operation like optimizing for many tables. This can slow
2164     down a server; therefore, setting this to ``true`` prevents this kind
2165     of multiple maintenance operation.
2166
2167 Theme settings
2168 --------------
2169
2170 .. config:option:: $cfg['NaviWidth']
2171
2172     :type: integer
2173     :default:
2174
2175     Navigation panel width in pixels. See
2176     :file:`themes/themename/layout.inc.php`.
2177
2178 .. config:option:: $cfg['NaviBackground']
2179
2180     :type: string [CSS color for background]
2181     :default:
2182
2183 .. config:option:: $cfg['MainBackground']
2184
2185     :type: string [CSS color for background]
2186     :default:
2187
2188     The background styles used for both the frames. See
2189     :file:`themes/themename/layout.inc.php`.
2190
2191 .. config:option:: $cfg['NaviPointerBackground']
2192
2193     :type: string [CSS color for background]
2194     :default:
2195
2196 .. config:option:: $cfg['NaviPointerColor']
2197
2198     :type: string [CSS color]
2199     :default:
2200
2201     The style used for the pointer in the navigation panel. See
2202     :file:`themes/themename/layout.inc.php`.
2203
2204 .. config:option:: $cfg['Border']
2205
2206     :type: integer
2207     :default:
2208
2209     The size of a table's border. See :file:`themes/themename/layout.inc.php`.
2210
2211 .. config:option:: $cfg['ThBackground']
2212
2213     :type: string [CSS color for background]
2214     :default:
2215
2216 .. config:option:: $cfg['ThColor']
2217
2218     :type: string [CSS color]
2219     :default:
2220
2221     The style used for table headers. See
2222     :file:`themes/themename/layout.inc.php`.
2223
2224 .. _cfg_BgcolorOne:
2225 .. config:option:: $cfg['BgOne']
2226
2227     :type: string [CSS color]
2228     :default:
2229
2230     The color (HTML) #1 for table rows. See
2231     :file:`themes/themename/layout.inc.php`.
2232
2233 .. _cfg_BgcolorTwo:
2234 .. config:option:: $cfg['BgTwo']
2235
2236     :type: string [CSS color]
2237     :default:
2238
2239     The color (HTML) #2 for table rows. See
2240     :file:`themes/themename/layout.inc.php`.
2241
2242 .. config:option:: $cfg['BrowsePointerBackground']
2243
2244     :type: string [CSS color]
2245     :default:
2246
2247     The background color used when hovering over a row in the Browse panel.
2248     See :file:`themes/themename/layout.inc.php`.
2249
2250 .. config:option:: $cfg['BrowsePointerColor']
2251
2252     :type: string [CSS color]
2253     :default:
2254
2255     The text color used when hovering over a row in the Browse panel.
2256     Used when :config:option:`$cfg['BrowsePointerEnable']` is true.
2257     See :file:`themes/themename/layout.inc.php`.
2258
2259 .. config:option:: $cfg['BrowseMarkerBackground']
2260
2261     :type: string [CSS color]
2262     :default:
2263
2264     The background color used to highlight a row selected by checkbox in the Browse panel or
2265     when a column is selected.
2266     Used when :config:option:`$cfg['BrowsePointerEnable']` is true.
2267     See :file:`themes/themename/layout.inc.php`.
2268
2269 .. config:option:: $cfg['BrowseMarkerColor']
2270
2271     :type: string [CSS color]
2272     :default:
2273
2274     The color used when you visually mark a row or column in the Browse panel.
2275     Rows can be marked by clicking the checkbox to the left of the row and columns can be
2276     marked by clicking the column's header (outside of the header text).
2277     See :file:`themes/themename/layout.inc.php`.
2278
2279 .. config:option:: $cfg['FontFamily']
2280
2281     :type: string
2282     :default:
2283
2284     You put here a valid CSS font family value, for example ``arial, sans-
2285     serif``. See :file:`themes/themename/layout.inc.php`.
2286
2287 .. config:option:: $cfg['FontFamilyFixed']
2288
2289     :type: string
2290     :default:
2291
2292     You put here a valid CSS font family value, for example ``monospace``.
2293     This one is used in textarea. See :file:`themes/themename/layout.inc.php`.
2294
2295 Design customization
2296 --------------------
2297
2298 .. config:option:: $cfg['NavigationTreePointerEnable']
2299
2300     :type: boolean
2301     :default: true
2302
2303     When set to true, hovering over an item in the navigation panel causes that item to be marked
2304     (the background is highlighted).
2305
2306 .. config:option:: $cfg['BrowsePointerEnable']
2307
2308     :type: boolean
2309     :default: true
2310
2311     When set to true, hovering over a row in the Browse page causes that row to be marked (the background
2312     is highlighted).
2313
2314 .. config:option:: $cfg['BrowseMarkerEnable']
2315
2316     :type: boolean
2317     :default: true
2318
2319     When set to true, a data row is marked (the background is highlighted) when the row is selected
2320     with the checkbox.
2321
2322 .. config:option:: $cfg['LimitChars']
2323
2324     :type: integer
2325     :default: 50
2326
2327     Maximum number of characters shown in any non-numeric field on browse
2328     view. Can be turned off by a toggle button on the browse page.
2329
2330 .. config:option:: $cfg['RowActionLinks']
2331
2332     :type: string
2333     :default: ``'left'``
2334
2335     Defines the place where table row links (Edit, Copy, Delete) would be
2336     put when tables contents are displayed (you may have them displayed at
2337     the left side, right side, both sides or nowhere).
2338
2339 .. config:option:: $cfg['RememberSorting']
2340
2341     :type: boolean
2342     :default: true
2343
2344     If enabled, remember the sorting of each table when browsing them.
2345
2346 .. config:option:: $cfg['TablePrimaryKeyOrder']
2347
2348     :type: string
2349     :default: ``'NONE'``
2350
2351     This defines the default sort order for the tables, having a primary key,
2352     when there is no sort order defines externally.
2353     Acceptable values : ['NONE', 'ASC', 'DESC']
2354
2355 .. config:option:: $cfg['ShowBrowseComments']
2356
2357     :type: boolean
2358     :default: true
2359
2360 .. config:option:: $cfg['ShowPropertyComments']
2361
2362     :type: boolean
2363     :default: true
2364
2365     By setting the corresponding variable to ``true`` you can enable the
2366     display of column comments in Browse or Property display. In browse
2367     mode, the comments are shown inside the header. In property mode,
2368     comments are displayed using a CSS-formatted dashed-line below the
2369     name of the column. The comment is shown as a tool-tip for that
2370     column.
2371
2372 Text fields
2373 -----------
2374
2375 .. config:option:: $cfg['CharEditing']
2376
2377     :type: string
2378     :default: ``'input'``
2379
2380     Defines which type of editing controls should be used for CHAR and
2381     VARCHAR columns. Applies to data editing and also to the default values
2382     in structure editing. Possible values are:
2383
2384     * input - this allows to limit size of text to size of columns in MySQL,
2385       but has problems with newlines in columns
2386     * textarea - no problems with newlines in columns, but also no length
2387       limitations
2388
2389 .. config:option:: $cfg['MinSizeForInputField']
2390
2391     :type: integer
2392     :default: 4
2393
2394     Defines the minimum size for input fields generated for CHAR and
2395     VARCHAR columns.
2396
2397 .. config:option:: $cfg['MaxSizeForInputField']
2398
2399     :type: integer
2400     :default: 60
2401
2402     Defines the maximum size for input fields generated for CHAR and
2403     VARCHAR columns.
2404
2405 .. config:option:: $cfg['TextareaCols']
2406
2407     :type: integer
2408     :default: 40
2409
2410 .. config:option:: $cfg['TextareaRows']
2411
2412     :type: integer
2413     :default: 15
2414
2415 .. config:option:: $cfg['CharTextareaCols']
2416
2417     :type: integer
2418     :default: 40
2419
2420 .. config:option:: $cfg['CharTextareaRows']
2421
2422     :type: integer
2423     :default: 2
2424
2425     Number of columns and rows for the textareas. This value will be
2426     emphasized (\*2) for :term:`SQL` query
2427     textareas and (\*1.25) for :term:`SQL`
2428     textareas inside the query window.
2429
2430     The Char\* values are used for CHAR
2431     and VARCHAR editing (if configured via :config:option:`$cfg['CharEditing']`).
2432
2433 .. config:option:: $cfg['LongtextDoubleTextarea']
2434
2435     :type: boolean
2436     :default: true
2437
2438     Defines whether textarea for LONGTEXT columns should have double size.
2439
2440 .. config:option:: $cfg['TextareaAutoSelect']
2441
2442     :type: boolean
2443     :default: false
2444
2445     Defines if the whole textarea of the query box will be selected on
2446     click.
2447
2448
2449 SQL query box settings
2450 ----------------------
2451
2452 .. config:option:: $cfg['SQLQuery']['Edit']
2453
2454     :type: boolean
2455     :default: true
2456
2457     Whether to display an edit link to change a query in any SQL Query
2458     box.
2459
2460 .. config:option:: $cfg['SQLQuery']['Explain']
2461
2462     :type: boolean
2463     :default: true
2464
2465     Whether to display a link to explain a SELECT query in any SQL Query
2466     box.
2467
2468 .. config:option:: $cfg['SQLQuery']['ShowAsPHP']
2469
2470     :type: boolean
2471     :default: true
2472
2473     Whether to display a link to wrap a query in PHP code in any SQL Query
2474     box.
2475
2476 .. config:option:: $cfg['SQLQuery']['Refresh']
2477
2478     :type: boolean
2479     :default: true
2480
2481     Whether to display a link to refresh a query in any SQL Query box.
2482
2483 Web server upload/save/import directories
2484 -----------------------------------------
2485
2486 .. config:option:: $cfg['UploadDir']
2487
2488     :type: string
2489     :default: ``''``
2490
2491     The name of the directory where :term:`SQL` files have been uploaded by
2492     other means than phpMyAdmin (for example, ftp). Those files are available
2493     under a drop-down box when you click the database or table name, then the
2494     Import tab.
2495
2496     If
2497     you want different directory for each user, %u will be replaced with
2498     username.
2499
2500     Please note that the file names must have the suffix ".sql"
2501     (or ".sql.bz2" or ".sql.gz" if support for compressed formats is
2502     enabled).
2503
2504     This feature is useful when your file is too big to be
2505     uploaded via :term:`HTTP`, or when file
2506     uploads are disabled in PHP.
2507
2508     .. note::
2509
2510         If PHP is running in safe mode, this directory must be owned by the same
2511         user as the owner of the phpMyAdmin scripts.  See also :ref:`faq1_16` for
2512         alternatives.
2513
2514 .. config:option:: $cfg['SaveDir']
2515
2516     :type: string
2517     :default: ``''``
2518
2519     The name of the directory where dumps can be saved.
2520
2521     If you want different directory for each user, %u will be replaced with
2522     username.
2523
2524     Please note that the directory must exist and has to be writable for
2525     the user running webserver.
2526
2527     .. note::
2528
2529         If PHP is running in safe mode, this directory must be owned by the same
2530         user as the owner of the phpMyAdmin scripts.
2531
2532 .. config:option:: $cfg['TempDir']
2533
2534     :type: string
2535     :default: ``''``
2536
2537     The name of the directory where temporary files can be stored.
2538
2539     This is needed for importing ESRI Shapefiles, see :ref:`faq6_30` and to
2540     work around limitations of ``open_basedir`` for uploaded files, see
2541     :ref:`faq1_11`.
2542
2543     If the directory where phpMyAdmin is installed is
2544     subject to an ``open_basedir`` restriction, you need to create a
2545     temporary directory in some directory accessible by the web server.
2546     However for security reasons, this directory should be outside the
2547     tree published by webserver. If you cannot avoid having this directory
2548     published by webserver, place at least an empty :file:`index.html` file
2549     there, so that directory listing is not possible.
2550
2551     This directory should have as strict permissions as possible as the only
2552     user required to access this directory is the one who runs the webserver.
2553     If you have root privileges, simply make this user owner of this directory
2554     and make it accessible only by it:
2555
2556     .. code-block:: sh
2557
2558
2559         chown www-data:www-data tmp
2560         chmod 700 tmp
2561
2562     If you cannot change owner of the directory, you can achieve a similar
2563     setup using :term:`ACL`:
2564
2565     .. code-block:: sh
2566
2567         chmod 700 tmp
2568         setfacl -m "g:www-data:rwx" tmp
2569         setfacl -d -m "g:www-data:rwx" tmp
2570
2571     If neither of above works for you, you can still make the directory
2572     :command:`chmod 777`, but it might impose risk of other users on system
2573     reading and writing data in this directory.
2574
2575 Various display setting
2576 -----------------------
2577
2578 .. config:option:: $cfg['RepeatCells']
2579
2580     :type: integer
2581     :default: 100
2582
2583     Repeat the headers every X cells, or 0 to deactivate.
2584
2585 .. config:option:: $cfg['QueryHistoryDB']
2586
2587     :type: boolean
2588     :default: false
2589
2590 .. config:option:: $cfg['QueryHistoryMax']
2591
2592     :type: integer
2593     :default: 25
2594
2595     If :config:option:`$cfg['QueryHistoryDB']` is set to ``true``, all your
2596     Queries are logged to a table, which has to be created by you (see
2597     :config:option:`$cfg['Servers'][$i]['history']`). If set to false, all your
2598     queries will be appended to the form, but only as long as your window is
2599     opened they remain saved.
2600
2601     When using the JavaScript based query window, it will always get updated
2602     when you click on a new table/db to browse and will focus if you click on
2603     :guilabel:`Edit SQL` after using a query. You can suppress updating the
2604     query window by checking the box :guilabel:`Do not overwrite this query
2605     from outside the window` below the query textarea. Then you can browse
2606     tables/databases in the background without losing the contents of the
2607     textarea, so this is especially useful when composing a query with tables
2608     you first have to look in. The checkbox will get automatically checked
2609     whenever you change the contents of the textarea. Please uncheck the button
2610     whenever you definitely want the query window to get updated even though
2611     you have made alterations.
2612
2613     If :config:option:`$cfg['QueryHistoryDB']` is set to ``true`` you can
2614     specify the amount of saved history items using
2615     :config:option:`$cfg['QueryHistoryMax']`.
2616
2617 .. config:option:: $cfg['BrowseMIME']
2618
2619     :type: boolean
2620     :default: true
2621
2622     Enable :ref:`transformations`.
2623
2624 .. config:option:: $cfg['MaxExactCount']
2625
2626     :type: integer
2627     :default: 500000
2628
2629     For InnoDB tables, determines for how large tables phpMyAdmin should
2630     get the exact row count using ``SELECT COUNT``. If the approximate row
2631     count as returned by ``SHOW TABLE STATUS`` is smaller than this value,
2632     ``SELECT COUNT`` will be used, otherwise the approximate count will be
2633     used.
2634
2635 .. config:option:: $cfg['MaxExactCountViews']
2636
2637     :type: integer
2638     :default: 0
2639
2640     For VIEWs, since obtaining the exact count could have an impact on
2641     performance, this value is the maximum to be displayed, using a
2642     ``SELECT COUNT ... LIMIT``. Setting this to 0 bypasses any row
2643     counting.
2644
2645 .. config:option:: $cfg['NaturalOrder']
2646
2647     :type: boolean
2648     :default: true
2649
2650     Sorts database and table names according to natural order (for
2651     example, t1, t2, t10). Currently implemented in the navigation panel
2652     and in Database view, for the table list.
2653
2654 .. config:option:: $cfg['InitialSlidersState']
2655
2656     :type: string
2657     :default: ``'closed'``
2658
2659     If set to ``'closed'``, the visual sliders are initially in a closed
2660     state. A value of ``'open'`` does the reverse. To completely disable
2661     all visual sliders, use ``'disabled'``.
2662
2663 .. config:option:: $cfg['UserprefsDisallow']
2664
2665     :type: array
2666     :default: array()
2667
2668     Contains names of configuration options (keys in ``$cfg`` array) that
2669     users can't set through user preferences. For possible values, refer
2670     to :file:`libraries/config/user_preferences.forms.php`.
2671
2672 .. config:option:: $cfg['UserprefsDeveloperTab']
2673
2674     :type: boolean
2675     :default: false
2676
2677     Activates in the user preferences a tab containing options for
2678     developers of phpMyAdmin.
2679
2680 Page titles
2681 -----------
2682
2683 .. config:option:: $cfg['TitleTable']
2684
2685     :type: string
2686     :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ / @TABLE@ | @PHPMYADMIN@'``
2687
2688 .. config:option:: $cfg['TitleDatabase']
2689
2690     :type: string
2691     :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ | @PHPMYADMIN@'``
2692
2693 .. config:option:: $cfg['TitleServer']
2694
2695     :type: string
2696     :default: ``'@HTTP_HOST@ / @VSERVER@ | @PHPMYADMIN@'``
2697
2698 .. config:option:: $cfg['TitleDefault']
2699
2700     :type: string
2701     :default: ``'@HTTP_HOST@ | @PHPMYADMIN@'``
2702
2703     Allows you to specify window's title bar. You can use :ref:`faq6_27`.
2704
2705 Theme manager settings
2706 ----------------------
2707
2708 .. config:option:: $cfg['ThemePath']
2709
2710     :type: string
2711     :default: ``'./themes'``
2712
2713     If theme manager is active, use this as the path of the subdirectory
2714     containing all the themes.
2715
2716 .. config:option:: $cfg['ThemeManager']
2717
2718     :type: boolean
2719     :default: true
2720
2721     Enables user-selectable themes. See :ref:`faqthemes`.
2722
2723 .. config:option:: $cfg['ThemeDefault']
2724
2725     :type: string
2726     :default: ``'pmahomme'``
2727
2728     The default theme (a subdirectory under :config:option:`$cfg['ThemePath']`).
2729
2730 .. config:option:: $cfg['ThemePerServer']
2731
2732     :type: boolean
2733     :default: false
2734
2735     Whether to allow different theme for each server.
2736
2737 Default queries
2738 ---------------
2739
2740 .. config:option:: $cfg['DefaultQueryTable']
2741
2742     :type: string
2743     :default: ``'SELECT * FROM @TABLE@ WHERE 1'``
2744
2745 .. config:option:: $cfg['DefaultQueryDatabase']
2746
2747     :type: string
2748     :default: ``''``
2749
2750     Default queries that will be displayed in query boxes when user didn't
2751     specify any. You can use standard :ref:`faq6_27`.
2752
2753
2754 MySQL settings
2755 --------------
2756
2757 .. config:option:: $cfg['DefaultFunctions']
2758
2759     :type: array
2760     :default: array(...)
2761
2762     Functions selected by default when inserting/changing row, Functions
2763     are defined for meta types as (FUNC\_NUMBER, FUNC\_DATE, FUNC\_CHAR,
2764     FUNC\_SPATIAL, FUNC\_UUID) and for ``first_timestamp``, which is used
2765     for first timestamp column in table.
2766
2767
2768 Developer
2769 ---------
2770
2771 .. warning::
2772
2773     These settings might have huge effect on performance or security.
2774
2775 .. config:option:: $cfg['DBG']
2776
2777     :type: array
2778     :default: array(...)
2779
2780 .. config:option:: $cfg['DBG']['sql']
2781
2782     :type: boolean
2783     :default: false
2784
2785     Enable logging queries and execution times to be
2786     displayed in the bottom of main page (right frame).
2787
2788 .. config:option:: $cfg['DBG']['demo']
2789
2790     :type: boolean
2791     :default: false
2792
2793     Enable to let server present itself as demo server.
2794     This is used for <http://demo.phpmyadmin.net/>.
2795