doc/config.rst

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