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