doc/config.rst

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