doc/config.rst

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