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