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