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