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