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