doc/config.rst

   1 .. index:: config.inc.php
   2
   3 .. _config:
   4
   5 Configuration
   6 =============
   7
   8 Almost all configurable data is placed in :file:`config.inc.php`. If this file
   9 does not exist, please refer to the :ref:`setup` section to create one. This
  10 file only needs to contain the parameters you want to change from their
  11 corresponding default value in :file:`libraries/config.default.php`.
  12
  13 If a directive is missing from your file, you can just add another line with
  14 the file. This file is for over-writing the defaults; if you wish to use the
  15 default value there's no need to add a line here.
  16
  17 The parameters which relate to design (like colors) are placed in
  18 :file:`themes/themename/layout.inc.php`. You might also want to create
  19 :file:`config.footer.inc.php` and :file:`config.header.inc.php` files to add
  20 your site specific code to be included on start and end of each page.
  21
  22 .. note::
  23
  24     Some distributions (eg. Debian or Ubuntu) store :file:`config.inc.php` in
  25     ``/etc/phpmyadmin`` instead of within phpMyAdmin sources.
  26
  27 .. warning::
  28
  29     :term:`Mac` users should note that if you are on a version before
  30     :term:`Mac OS X`, PHP does not seem to
  31     like :term:`Mac` end of lines character (``\r``). So
  32     ensure you choose the option that allows to use the \*nix end of line
  33     character (``\n``) in your text editor before saving a script you have
  34     modified.
  35
  36 Basic settings
  37 --------------
  38
  39 .. config:option:: $cfg['PmaAbsoluteUri']
  40
  41     :type: string
  42     :default: ``''``
  43
  44     Sets here the complete :term:`URL` (with full path) to your phpMyAdmin
  45     installation's directory. E.g.
  46     ``http://www.example.net/path_to_your_phpMyAdmin_directory/``.  Note also
  47     that the :term:`URL` on most of web servers are case–sensitive. Don’t
  48     forget the trailing slash at the end.
  49
  50     Starting with version 2.3.0, it is advisable to try leaving this blank. In
  51     most cases phpMyAdmin automatically detects the proper setting. Users of
  52     port forwarding will need to set :config:option:`$cfg['PmaAbsoluteUri']`
  53     (`more info <https://sourceforge.net/p/phpmyadmin/support-requests/795/>`_).
  54
  55     A good test is to browse a table, edit a row and save it. There should be
  56     an error message if phpMyAdmin is having trouble auto–detecting the correct
  57     value. If you get an error that this must be set or if the autodetect code
  58     fails to detect your path, please post a bug report on our bug tracker so
  59     we can improve the code.
  60
  61     .. seealso:: :ref:`faq1_40`
  62
  63 .. config:option:: $cfg['PmaNoRelation_DisableWarning']
  64
  65     :type: boolean
  66     :default: false
  67
  68     Starting with version 2.3.0 phpMyAdmin offers a lot of features to
  69     work with master / foreign – tables (see :config:option:`$cfg['Servers'][$i]['pmadb']`).
  70
  71     If you tried to set this
  72     up and it does not work for you, have a look on the :guilabel:`Structure` page
  73     of one database where you would like to use it. You will find a link
  74     that will analyze why those features have been disabled.
  75
  76     If you do not want to use those features set this variable to ``true`` to
  77     stop this message from appearing.
  78
  79 .. config:option:: $cfg['SuhosinDisableWarning']
  80
  81     :type: boolean
  82     :default: false
  83
  84     A warning is displayed on the main page if Suhosin is detected.
  85
  86     You can set this parameter to ``true`` to stop this message from appearing.
  87
  88 .. config:option:: $cfg['McryptDisableWarning']
  89
  90     :type: boolean
  91     :default: false
  92
  93     Disable the default warning that is displayed if mcrypt is missing for
  94     cookie authentication.
  95
  96     You can set this parameter to ``true`` to stop this message from appearing.
  97
  98 .. config:option:: $cfg['ServerLibraryDifference_DisableWarning']
  99
 100     :type: boolean
 101     :default: false
 102
 103     A warning is displayed on the main page if there is a difference
 104     between the MySQL library and server version.
 105
 106     You can set this parameter to ``true`` to stop this message from appearing.
 107
 108 .. config:option:: $cfg['ReservedWordDisableWarning']
 109
 110     :type: boolean
 111     :default: false
 112
 113     This warning is displayed on the Structure page of a table if one or more
 114     column names match with words which are MySQL reserved.
 115
 116     If you want to turn off this warning, you can set it to ``true`` and
 117     warning will no longer be displayed.
 118
 119 .. config:option:: $cfg['TranslationWarningThreshold']
 120
 121     :type: integer
 122     :default: 80
 123
 124     Show warning about incomplete translations on certain threshold.
 125
 126 .. config:option:: $cfg['ErrorReporting']
 127
 128     :type: boolean
 129     :default: true
 130
 131     Whenever an error is detected in the javascript execution. A an error report
 132     may be sent to phpmyadmin if user agrees.
 133
 134     You can set this parameter to ``false`` to never send error reports.
 135
 136 .. config:option:: $cfg['SendErrorReports']
 137
 138     :type: string
 139     :default: ``'ask'``
 140
 141     Whenever an error is detected in the javascript execution. A an error report
 142     may be sent to phpmyadmin. This setting sets the default behavior.
 143
 144     The default setting of ``'ask'`` will ask the user everytime there is a new
 145     error report. However you can set this parameter to ``'always'`` to send error
 146     reports without asking for confirmation or you can set it to ``'never'`` to
 147     never send error reports.
 148
 149 .. config:option:: $cfg['AllowThirdPartyFraming']
 150
 151     :type: boolean
 152     :default: false
 153
 154     Setting this to ``true`` allows phpMyAdmin to be included inside a frame,
 155     and is a potential security hole allowing cross-frame scripting attacks or
 156     clickjacking.
 157
 158 Server connection settings
 159 --------------------------
 160
 161 .. config:option:: $cfg['Servers']
 162
 163     :type: array
 164     :default: one server array with settings listed bellow
 165
 166     Since version 1.4.2, phpMyAdmin supports the administration of multiple
 167     MySQL servers. Therefore, a :config:option:`$cfg['Servers']`-array has been
 168     added which contains the login information for the different servers. The
 169     first :config:option:`$cfg['Servers'][$i]['host']` contains the hostname of
 170     the first server, the second :config:option:`$cfg['Servers'][$i]['host']`
 171     the hostname of the second server, etc. In
 172     :file:`libraries/config.default.php`, there is only one section for server
 173     definition, however you can put as many as you need in
 174     :file:`config.inc.php`, copy that block or needed parts (you don't have to
 175     define all settings, just those you need to change).
 176
 177     .. note::
 178
 179         The :config:option:`$cfg['Servers']` array starts with
 180         $cfg['Servers'][1]. Do not use $cfg['Servers'][0]. If you want more
 181         than one server, just copy following section (including $i
 182         incrementation) serveral times. There is no need to define full server
 183         array, just define values you need to change.
 184
 185
 186 .. config:option:: $cfg['Servers'][$i]['host']
 187
 188     :type: string
 189     :default: ``'localhost'``
 190
 191     The hostname or :term:`IP` address of your $i-th MySQL-server. E.g.
 192     ``localhost``.
 193
 194     Possible values are:
 195
 196     * hostname, e.g., ``'localhost'`` or ``'mydb.example.org'``
 197     * IP address, e.g., ``'127.0.0.1'`` or ``'192.168.10.1'``
 198     * dot - ``'.'``, i.e., use named pipes on windows systems
 199     * empty - ``''``, disables this server
 200
 201 .. config:option:: $cfg['Servers'][$i]['port']
 202
 203     :type: string
 204     :default: ``''``
 205
 206     The port-number of your $i-th MySQL-server. Default is 3306 (leave
 207     blank).
 208
 209     .. note::
 210
 211        If you use ``localhost`` as the hostname, MySQL ignores this port number
 212        and connects with the socket, so if you want to connect to a port
 213        different from the default port, use ``127.0.0.1`` or the real hostname
 214        in :config:option:`$cfg['Servers'][$i]['host']`.
 215
 216 .. config:option:: $cfg['Servers'][$i]['socket']
 217
 218     :type: string
 219     :default: ``''``
 220
 221     The path to the socket to use. Leave blank for default. To determine
 222     the correct socket, check your MySQL configuration or, using the
 223     :command:`mysql` command–line client, issue the ``status`` command. Among the
 224     resulting information displayed will be the socket used.
 225
 226 .. config:option:: $cfg['Servers'][$i]['ssl']
 227
 228     :type: boolean
 229     :default: false
 230
 231     Whether to enable SSL for the connection between phpMyAdmin and the MySQL server.
 232
 233     When using :config:option:`$cfg['Servers'][$i]['extension']` = ``'mysql'``,
 234     none of the remaining ``'ssl...'`` configuration options apply.
 235
 236     We strongly recommend using :config:option:`$cfg['Servers'][$i]['extension']` = ``'mysqli'``
 237     when using this option.
 238
 239 .. config:option:: $cfg['Servers'][$i]['ssl_key']
 240
 241     :type: string
 242     :default: NULL
 243
 244     Path to the key file when using SSL for connecting to the MySQL server.
 245
 246     For example:
 247
 248     .. code-block:: php
 249
 250         $cfg['Servers'][$i]['ssl_key'] = '/etc/mysql/server-key.pem';
 251
 252 .. config:option:: $cfg['Servers'][$i]['ssl_cert']
 253
 254     :type: string
 255     :default: NULL
 256
 257     Path to the cert file when using SSL for connecting to the MySQL server.
 258
 259 .. config:option:: $cfg['Servers'][$i]['ssl_ca']
 260
 261     :type: string
 262     :default: NULL
 263
 264     Path to the CA file when using SSL for connecting to the MySQL server.
 265
 266 .. config:option:: $cfg['Servers'][$i]['ssl_ca_path']
 267
 268     :type: string
 269     :default: NULL
 270
 271     Directory containing trusted SSL CA certificates in PEM format.
 272
 273 .. config:option:: $cfg['Servers'][$i]['ssl_ciphers']
 274
 275     :type: string
 276     :default: NULL
 277
 278     List of allowable ciphers for SSL connections to the MySQL server.
 279
 280 .. config:option:: $cfg['Servers'][$i]['connect_type']
 281
 282     :type: string
 283     :default: ``'tcp'``
 284
 285     What type connection to use with the MySQL server. Your options are
 286     ``'socket'`` and ``'tcp'``. It defaults to tcp as that is nearly guaranteed
 287     to be available on all MySQL servers, while sockets are not supported on
 288     some platforms. To use the socket mode, your MySQL server must be on the
 289     same machine as the Web server.
 290
 291 .. config:option:: $cfg['Servers'][$i]['extension']
 292
 293     :type: string
 294     :default: ``'mysqli'``
 295
 296     What php MySQL extension to use for the connection. Valid options are:
 297
 298     ``mysql``
 299         The classic MySQL extension.
 300
 301     ``mysqli``
 302         The improved MySQL extension. This extension became available with PHP
 303         5.0.0 and is the recommended way to connect to a server running MySQL
 304         4.1.x or newer.
 305
 306 .. config:option:: $cfg['Servers'][$i]['compress']
 307
 308     :type: boolean
 309     :default: false
 310
 311     Whether to use a compressed protocol for the MySQL server connection
 312     or not (experimental).
 313
 314 .. _controlhost:
 315 .. config:option:: $cfg['Servers'][$i]['controlhost']
 316
 317     :type: string
 318     :default: ``''``
 319
 320     Permits to use an alternate host to hold the configuration storage
 321     data.
 322
 323 .. _controlport:
 324 .. config:option:: $cfg['Servers'][$i]['controlport']
 325
 326     :type: string
 327     :default: ``''``
 328
 329     Permits to use an alternate port to connect to the host that
 330     holds the configuration storage.
 331
 332 .. _controluser:
 333 .. config:option:: $cfg['Servers'][$i]['controluser']
 334
 335     :type: string
 336     :default: ``''``
 337
 338 .. config:option:: $cfg['Servers'][$i]['controlpass']
 339
 340     :type: string
 341     :default: ``''``
 342
 343     This special account is used for 2 distinct purposes: to make possible all
 344     relational features (see :config:option:`$cfg['Servers'][$i]['pmadb']`) and,
 345     for a MySQL server running with ``--skip-show-database``, to enable a
 346     multi-user installation (:term:`HTTP` or cookie
 347     authentication mode).
 348
 349     When using :term:`HTTP` or
 350     cookie authentication modes (or 'config' authentication mode since phpMyAdmin
 351     2.2.1), you need to supply the details of a MySQL account that has ``SELECT``
 352     privilege on the *mysql.user (all columns except "Password")*, *mysql.db (all
 353     columns)* and *mysql.tables\_priv (all columns except "Grantor" and
 354     "Timestamp")* tables. This account is used to check what databases the user
 355     will see at login.
 356
 357     .. versionchanged:: 2.2.5
 358         those were called ``stduser`` and ``stdpass``
 359
 360     .. seealso:: :ref:`setup`, :ref:`authentication_modes`
 361
 362 .. config:option:: $cfg['Servers'][$i]['auth_type']
 363
 364     :type: string
 365     :default: ``'cookie'``
 366
 367     Whether config or cookie or :term:`HTTP` or signon authentication should be
 368     used for this server.
 369
 370     * 'config' authentication (``$auth_type = 'config'``) is the plain old
 371       way: username and password are stored in :file:`config.inc.php`.
 372     * 'cookie' authentication mode (``$auth_type = 'cookie'``) as
 373       introduced in 2.2.3 allows you to log in as any valid MySQL user with
 374       the help of cookies. Username and password are stored in cookies
 375       during the session and password is deleted when it ends. This can also
 376       allow you to log in in arbitrary server if :config:option:`$cfg['AllowArbitraryServer']` enabled.
 377     * 'http' authentication (was
 378       called 'advanced' in previous versions and can be written also as
 379       'http') (``$auth_type = 'http';'``) as introduced in 1.3.0 allows you to log in as any
 380       valid MySQL user via HTTP-Auth.
 381     * 'signon' authentication mode (``$auth_type = 'signon'``) as
 382       introduced in 2.10.0 allows you to log in from prepared PHP session
 383       data or using supplied PHP script. This is useful for implementing
 384       single signon from another application. Sample way how to seed session
 385       is in signon example: :file:`examples/signon.php`. There is also
 386       alternative example using OpenID - :file:`examples/openid.php` and example
 387       for scripts based solution - :file:`examples/signon-script.php`. You need
 388       to configure :config:option:`$cfg['Servers'][$i]['SignonSession']` or
 389       :config:option:`$cfg['Servers'][$i]['SignonScript']` and
 390       :config:option:`$cfg['Servers'][$i]['SignonURL']` to use this authentication
 391       method.
 392
 393     .. seealso:: :ref:`authentication_modes`
 394
 395 .. _servers_auth_http_realm:
 396 .. config:option:: $cfg['Servers'][$i]['auth_http_realm']
 397
 398     :type: string
 399     :default: ``''``
 400
 401     When using auth\_type = ``http``, this field allows to define a custom
 402     :term:`HTTP` Basic Auth Realm which will be displayed to the user. If not
 403     explicitly specified in your configuration, a string combined of
 404     "phpMyAdmin " and either :config:option:`$cfg['Servers'][$i]['verbose']` or
 405     :config:option:`$cfg['Servers'][$i]['host']` will be used.
 406
 407 .. _servers_auth_swekey_config:
 408 .. config:option:: $cfg['Servers'][$i]['auth_swekey_config']
 409
 410     :type: string
 411     :default: ``''``
 412
 413     The name of the file containing :ref:`swekey` ids and login names for hardware
 414     authentication. Leave empty to deactivate this feature.
 415
 416 .. _servers_user:
 417 .. config:option:: $cfg['Servers'][$i]['user']
 418
 419     :type: string
 420     :default: ``'root'``
 421
 422 .. config:option:: $cfg['Servers'][$i]['password']
 423
 424     :type: string
 425     :default: ``''``
 426
 427     When using :config:option:`$cfg['Servers'][$i]['auth_type']` set to
 428     'config', this is the user/password-pair which phpMyAdmin will use to
 429     connect to the MySQL server. This user/password pair is not needed when
 430     :term:`HTTP` or cookie authentication is used
 431     and should be empty.
 432
 433 .. _servers_nopassword:
 434 .. config:option:: $cfg['Servers'][$i]['nopassword']
 435
 436     :type: boolean
 437     :default: false
 438
 439     Allow attempt to log in without password when a login with password
 440     fails. This can be used together with http authentication, when
 441     authentication is done some other way and phpMyAdmin gets user name
 442     from auth and uses empty password for connecting to MySQL. Password
 443     login is still tried first, but as fallback, no password method is
 444     tried.
 445
 446 .. _servers_only_db:
 447 .. config:option:: $cfg['Servers'][$i]['only_db']
 448
 449     :type: string or array
 450     :default: ``''``
 451
 452     If set to a (an array of) database name(s), only this (these)
 453     database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
 454     this/these database(s) name(s) may contain MySQL wildcards characters
 455     ("\_" and "%"): if you want to use literal instances of these
 456     characters, escape them (I.E. use ``'my\_db'`` and not ``'my_db'``).
 457
 458     This setting is an efficient way to lower the server load since the
 459     latter does not need to send MySQL requests to build the available
 460     database list. But **it does not replace the privileges rules of the
 461     MySQL database server**. If set, it just means only these databases
 462     will be displayed but **not that all other databases can't be used.**
 463
 464     An example of using more that one database:
 465
 466     .. code-block:: php
 467
 468         $cfg['Servers'][$i]['only_db'] = array('db1', 'db2');
 469
 470     .. versionchanged:: 4.0.0
 471         Previous versions permitted to specify the display order of
 472         the database names via this directive.
 473
 474 .. config:option:: $cfg['Servers'][$i]['hide_db']
 475
 476     :type: string
 477     :default: ``''``
 478
 479     Regular expression for hiding some databases from unprivileged users.
 480     This only hides them from listing, but a user is still able to access
 481     them (using, for example, the SQL query area). To limit access, use
 482     the MySQL privilege system.  For example, to hide all databases
 483     starting with the letter "a", use
 484
 485     .. code-block:: php
 486
 487         $cfg['Servers'][$i]['hide_db'] = '^a';
 488
 489     and to hide both "db1" and "db2" use
 490
 491     .. code-block:: php
 492
 493         $cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$';
 494
 495     More information on regular expressions can be found in the `PCRE
 496     pattern syntax
 497     <http://php.net/manual/en/reference.pcre.pattern.syntax.php>`_ portion
 498     of the PHP reference manual.
 499
 500 .. config:option:: $cfg['Servers'][$i]['verbose']
 501
 502     :type: string
 503     :default: ``''``
 504
 505     Only useful when using phpMyAdmin with multiple server entries. If
 506     set, this string will be displayed instead of the hostname in the
 507     pull-down menu on the main page. This can be useful if you want to
 508     show only certain databases on your system, for example. For HTTP
 509     auth, all non-US-ASCII characters will be stripped.
 510
 511 .. config:option:: $cfg['Servers'][$i]['pmadb']
 512
 513     :type: string
 514     :default: ``''``
 515
 516     The name of the database containing the phpMyAdmin configuration
 517     storage.
 518
 519     See the :ref:`linked-tables`  section in this document to see the benefits of
 520     this feature, and for a quick way of creating this database and the needed
 521     tables.
 522
 523     If you are the only user of this phpMyAdmin installation, you can use your
 524     current database to store those special tables; in this case, just put your
 525     current database name in :config:option:`$cfg['Servers'][$i]['pmadb']`. For a
 526     multi-user installation, set this parameter to the name of your central
 527     database containing the phpMyAdmin configuration storage.
 528
 529 .. _bookmark:
 530 .. config:option:: $cfg['Servers'][$i]['bookmarktable']
 531
 532     :type: string
 533     :default: ``''``
 534
 535     Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This
 536     can be useful for queries you often run. To allow the usage of this
 537     functionality:
 538
 539     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 540     * enter the table name in :config:option:`$cfg['Servers'][$i]['bookmarktable']`
 541
 542
 543 .. _relation:
 544 .. config:option:: $cfg['Servers'][$i]['relation']
 545
 546     :type: string
 547     :default: ``''``
 548
 549     Since release 2.2.4 you can describe, in a special 'relation' table,
 550     which column is a key in another table (a foreign key). phpMyAdmin
 551     currently uses this to:
 552
 553     * make clickable, when you browse the master table, the data values that
 554       point to the foreign table;
 555     * display in an optional tool-tip the "display column" when browsing the
 556       master table, if you move the mouse to a column containing a foreign
 557       key (use also the 'table\_info' table); (see :ref:`faqdisplay`)
 558     * in edit/insert mode, display a drop-down list of possible foreign keys
 559       (key value and "display column" are shown) (see :ref:`faq6_21`)
 560     * display links on the table properties page, to check referential
 561       integrity (display missing foreign keys) for each described key;
 562     * in query-by-example, create automatic joins (see :ref:`faq6_6`)
 563     * enable you to get a :term:`PDF` schema of
 564       your database (also uses the table\_coords table).
 565
 566     The keys can be numeric or character.
 567
 568     To allow the usage of this functionality:
 569
 570     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 571     * put the relation table name in :config:option:`$cfg['Servers'][$i]['relation']`
 572     * now as normal user open phpMyAdmin and for each one of your tables
 573       where you want to use this feature, click :guilabel:`Structure/Relation view/`
 574       and choose foreign columns.
 575
 576     .. note::
 577
 578         In the current version, ``master_db`` must be the same as ``foreign_db``.
 579         Those columns have been put in future development of the cross-db
 580         relations.
 581
 582 .. _table_info:
 583 .. config:option:: $cfg['Servers'][$i]['table_info']
 584
 585     :type: string
 586     :default: ``''``
 587
 588     Since release 2.3.0 you can describe, in a special 'table\_info'
 589     table, which column is to be displayed as a tool-tip when moving the
 590     cursor over the corresponding key. This configuration variable will
 591     hold the name of this special table. To allow the usage of this
 592     functionality:
 593
 594     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 595     * put the table name in :config:option:`$cfg['Servers'][$i]['table\_info']` (e.g.
 596       ``pma__table_info``)
 597     * then for each table where you want to use this feature, click
 598       "Structure/Relation view/Choose column to display" to choose the
 599       column.
 600
 601     .. seealso:: :ref:`faqdisplay`
 602
 603 .. _table_coords:
 604 .. config:option:: $cfg['Servers'][$i]['table_coords']
 605
 606     :type: string
 607     :default: ``''``
 608
 609 .. config:option:: $cfg['Servers'][$i]['pdf_pages']
 610
 611     :type: string
 612     :default: ``''``
 613
 614     Since release 2.3.0 you can have phpMyAdmin create :term:`PDF` pages
 615     showing the relations between your tables. To do this it needs two tables
 616     "pdf\_pages" (storing information about the available :term:`PDF` pages)
 617     and "table\_coords" (storing coordinates where each table will be placed on
 618     a :term:`PDF` schema output).  You must be using the "relation" feature.
 619
 620     To allow the usage of this functionality:
 621
 622     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 623     * put the correct table names in
 624       :config:option:`$cfg['Servers'][$i]['table\_coords']` and
 625       :config:option:`$cfg['Servers'][$i]['pdf\_pages']`
 626
 627     .. seealso:: :ref:`faqpdf`.
 628
 629 .. _col_com:
 630 .. config:option:: $cfg['Servers'][$i]['column_info']
 631
 632     :type: string
 633     :default: ``''``
 634
 635     This part requires a content update!  Since release 2.3.0 you can
 636     store comments to describe each column for each table. These will then
 637     be shown on the "printview".
 638
 639     Starting with release 2.5.0, comments are consequently used on the table
 640     property pages and table browse view, showing up as tool-tips above the
 641     column name (properties page) or embedded within the header of table in
 642     browse view. They can also be shown in a table dump. Please see the
 643     relevant configuration directives later on.
 644
 645     Also new in release 2.5.0 is a MIME- transformation system which is also
 646     based on the following table structure. See :ref:`transformations` for
 647     further information. To use the MIME- transformation system, your
 648     column\_info table has to have the three new columns 'mimetype',
 649     'transformation', 'transformation\_options'.
 650
 651
 652     To allow the usage of this functionality:
 653
 654     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 655     * put the table name in :config:option:`$cfg['Servers'][$i]['column\_info']` (e.g.
 656       ``pma__column_info``)
 657     * to update your PRE-2.5.0 Column\_comments Table use this:  and
 658       remember that the Variable in :file:`config.inc.php` has been renamed from
 659       :config:option:`$cfg['Servers'][$i]['column\_comments']` to
 660       :config:option:`$cfg['Servers'][$i]['column\_info']`
 661
 662       .. code-block:: mysql
 663
 664            ALTER TABLE `pma__column_comments`
 665            ADD `mimetype` VARCHAR( 255 ) NOT NULL,
 666            ADD `transformation` VARCHAR( 255 ) NOT NULL,
 667            ADD `transformation_options` VARCHAR( 255 ) NOT NULL;
 668
 669 .. _history:
 670 .. config:option:: $cfg['Servers'][$i]['history']
 671
 672     :type: string
 673     :default: ``''``
 674
 675     Since release 2.5.0 you can store your :term:`SQL` history, which means all
 676     queries you entered manually into the phpMyAdmin interface. If you don't
 677     want to use a table-based history, you can use the JavaScript-based
 678     history.
 679
 680     Using that, all your history items are deleted when closing the window.
 681     Using :config:option:`$cfg['QueryHistoryMax']` you can specify an amount of
 682     history items you want to have on hold. On every login, this list gets cut
 683     to the maximum amount.
 684
 685     The query history is only available if JavaScript is enabled in
 686     your browser.
 687
 688     To allow the usage of this functionality:
 689
 690     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 691     * put the table name in :config:option:`$cfg['Servers'][$i]['history']` (e.g.
 692       ``pma__history``)
 693
 694 .. _recent:
 695 .. config:option:: $cfg['Servers'][$i]['recent']
 696
 697     :type: string
 698     :default: ``''``
 699
 700     Since release 3.5.0 you can show recently used tables in the
 701     navigation panel. It helps you to jump across table directly, without
 702     the need to select the database, and then select the table. Using
 703     :config:option:`$cfg['NumRecentTables']` you can configure the maximum number
 704     of recent tables shown. When you select a table from the list, it will jump to
 705     the page specified in :config:option:`$cfg['NavigationTreeDefaultTabTable']`.
 706
 707
 708     Without configuring the storage, you can still access the recently used tables,
 709     but it will disappear after you logout.
 710
 711     To allow the usage of this functionality persistently:
 712
 713     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 714     * put the table name in :config:option:`$cfg['Servers'][$i]['recent']` (e.g.
 715       ``pma__recent``)
 716
 717 .. _table_uiprefs:
 718 .. config:option:: $cfg['Servers'][$i]['table_uiprefs']
 719
 720     :type: string
 721     :default: ``''``
 722
 723     Since release 3.5.0 phpMyAdmin can be configured to remember several
 724     things (sorted column :config:option:`$cfg['RememberSorting']`, column order,
 725     and column visibility from a database table) for browsing tables. Without
 726     configuring the storage, these features still can be used, but the values will
 727     disappear after you logout.
 728
 729     To allow the usage of these functionality persistently:
 730
 731     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 732     * put the table name in :config:option:`$cfg['Servers'][$i]['table\_uiprefs']` (e.g.
 733       ``pma__table_uiprefs``)
 734
 735 .. _configurablemenus:
 736 .. config:option:: $cfg['Servers'][$i]['users']
 737
 738     :type: string
 739     :default: ``''``
 740
 741 .. config:option:: $cfg['Servers'][$i]['usergroups']
 742
 743     :type: string
 744     :default: ``''``
 745
 746     Since release 4.1.0 you can create different user groups with menu items
 747     attached to them. Users can be assigned to these groups and the logged in
 748     user would only see menu items configured to the usergroup he is assigned to.
 749     To do this it needs two tables "usergroups" (storing allowed menu items for each
 750     user group) and "users" (storing users and their assignments to user groups).
 751
 752     To allow the usage of this functionality:
 753
 754     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 755     * put the correct table names in
 756       :config:option:`$cfg['Servers'][$i]['users']` (e.g. ``pma__users``) and
 757       :config:option:`$cfg['Servers'][$i]['usergroups']` (e.g. ``pma__usergroups``)
 758
 759 .. _navigationhiding:
 760 .. config:option:: $cfg['Servers'][$i]['navigationhiding']
 761
 762     :type: string
 763     :default: ``''``
 764
 765     Since release 4.1.0 you can hide/show items in the navigation tree.
 766
 767     To allow the usage of this functionality:
 768
 769     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 770     * put the table name in :config:option:`$cfg['Servers'][$i]['navigationhiding']` (e.g.
 771       ``pma__navigationhiding``)
 772
 773 .. _tracking:
 774 .. config:option:: $cfg['Servers'][$i]['tracking']
 775
 776     :type: string
 777     :default: ``''``
 778
 779     Since release 3.3.x a tracking mechanism is available. It helps you to
 780     track every :term:`SQL` command which is
 781     executed by phpMyAdmin. The mechanism supports logging of data
 782     manipulation and data definition statements. After enabling it you can
 783     create versions of tables.
 784
 785     The creation of a version has two effects:
 786
 787     * phpMyAdmin saves a snapshot of the table, including structure and
 788       indexes.
 789     * phpMyAdmin logs all commands which change the structure and/or data of
 790       the table and links these commands with the version number.
 791
 792     Of course you can view the tracked changes. On the :guilabel:`Tracking`
 793     page a complete report is available for every version. For the report you
 794     can use filters, for example you can get a list of statements within a date
 795     range. When you want to filter usernames you can enter \* for all names or
 796     you enter a list of names separated by ','. In addition you can export the
 797     (filtered) report to a file or to a temporary database.
 798
 799     To allow the usage of this functionality:
 800
 801     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 802     * put the table name in :config:option:`$cfg['Servers'][$i]['tracking']` (e.g.
 803       ``pma__tracking``)
 804
 805
 806 .. _tracking2:
 807 .. config:option:: $cfg['Servers'][$i]['tracking_version_auto_create']
 808
 809     :type: boolean
 810     :default: false
 811
 812     Whether the tracking mechanism creates versions for tables and views
 813     automatically.
 814
 815     If this is set to true and you create a table or view with
 816
 817     * CREATE TABLE ...
 818     * CREATE VIEW ...
 819
 820     and no version exists for it, the mechanism will create a version for
 821     you automatically.
 822
 823 .. _tracking3:
 824 .. config:option:: $cfg['Servers'][$i]['tracking_default_statements']
 825
 826     :type: string
 827     :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'``
 828
 829     Defines the list of statements the auto-creation uses for new
 830     versions.
 831
 832 .. _tracking4:
 833 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_view']
 834
 835     :type: boolean
 836     :default: true
 837
 838     Whether a DROP VIEW IF EXISTS statement will be added as first line to
 839     the log when creating a view.
 840
 841 .. _tracking5:
 842 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_table']
 843
 844     :type: boolean
 845     :default: true
 846
 847     Whether a DROP TABLE IF EXISTS statement will be added as first line
 848     to the log when creating a table.
 849
 850 .. _tracking6:
 851 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_database']
 852
 853     :type: boolean
 854     :default: true
 855
 856     Whether a DROP DATABASE IF EXISTS statement will be added as first
 857     line to the log when creating a database.
 858
 859 .. _userconfig:
 860 .. config:option:: $cfg['Servers'][$i]['userconfig']
 861
 862     :type: string
 863     :default: ``''``
 864
 865     Since release 3.4.x phpMyAdmin allows users to set most preferences by
 866     themselves and store them in the database.
 867
 868     If you don't allow for storing preferences in
 869     :config:option:`$cfg['Servers'][$i]['pmadb']`, users can still personalize
 870     phpMyAdmin, but settings will be saved in browser's local storage, or, it
 871     is is unavailable, until the end of session.
 872
 873     To allow the usage of this functionality:
 874
 875     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 876     * put the table name in :config:option:`$cfg['Servers'][$i]['userconfig']`
 877
 878
 879
 880 .. _designer_coords:
 881 .. config:option:: $cfg['Servers'][$i]['designer_coords']
 882
 883     :type: string
 884     :default: ``''``
 885
 886     Since release 2.10.0 a Designer interface is available; it permits to
 887     visually manage the relations.
 888
 889     To allow the usage of this functionality:
 890
 891     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
 892     * put the table name in :config:option:`$cfg['Servers'][$i]['designer\_coords']`
 893       (e.g. ``pma__designer_coords``)
 894
 895
 896
 897 .. config:option:: $cfg['Servers'][$i]['MaxTableUiprefs']
 898
 899     :type: integer
 900     :default: 100
 901
 902     Maximum number of rows saved in
 903     :config:option:`$cfg['Servers'][$i]['table_uiprefs']` table.
 904
 905     When tables are dropped or renamed,
 906     :config:option:`$cfg['Servers'][$i]['table_uiprefs']` may contain invalid data
 907     (referring to tables which no longer exist). We only keep this number of newest
 908     rows in :config:option:`$cfg['Servers'][$i]['table_uiprefs']` and automatically
 909     delete older rows.
 910
 911 .. config:option:: $cfg['Servers'][$i]['AllowRoot']
 912
 913     :type: boolean
 914     :default: true
 915
 916     Whether to allow root access. This is just a shortcut for the
 917     :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` below.
 918
 919 .. config:option:: $cfg['Servers'][$i]['AllowNoPassword']
 920
 921     :type: boolean
 922     :default: false
 923
 924     Whether to allow logins without a password. The default value of
 925     ``false`` for this parameter prevents unintended access to a MySQL
 926     server with was left with an empty password for root or on which an
 927     anonymous (blank) user is defined.
 928
 929 .. _servers_allowdeny_order:
 930 .. config:option:: $cfg['Servers'][$i]['AllowDeny']['order']
 931
 932     :type: string
 933     :default: ``''``
 934
 935     If your rule order is empty, then :term:`IP`
 936     authorization is disabled.
 937
 938     If your rule order is set to
 939     ``'deny,allow'`` then the system applies all deny rules followed by
 940     allow rules. Access is allowed by default. Any client which does not
 941     match a Deny command or does match an Allow command will be allowed
 942     access to the server.
 943
 944     If your rule order is set to ``'allow,deny'``
 945     then the system applies all allow rules followed by deny rules. Access
 946     is denied by default. Any client which does not match an Allow
 947     directive or does match a Deny directive will be denied access to the
 948     server.
 949
 950     If your rule order is set to ``'explicit'``, authorization is
 951     performed in a similar fashion to rule order 'deny,allow', with the
 952     added restriction that your host/username combination **must** be
 953     listed in the *allow* rules, and not listed in the *deny* rules. This
 954     is the **most** secure means of using Allow/Deny rules, and was
 955     available in Apache by specifying allow and deny rules without setting
 956     any order.
 957
 958     Please also see :config:option:`$cfg['TrustedProxies']` for
 959     detecting IP address behind proxies.
 960
 961 .. _servers_allowdeny_rules:
 962 .. config:option:: $cfg['Servers'][$i]['AllowDeny']['rules']
 963
 964     :type: array of strings
 965     :default: array()
 966
 967     The general format for the rules is as such:
 968
 969     .. code-block:: none
 970
 971         <'allow' | 'deny'> <username> [from] <ipmask>
 972
 973     If you wish to match all users, it is possible to use a ``'%'`` as a
 974     wildcard in the *username* field.
 975
 976     There are a few shortcuts you can
 977     use in the *ipmask* field as well (please note that those containing
 978     SERVER\_ADDRESS might not be available on all webservers):
 979
 980     .. code-block:: none
 981
 982
 983         'all' -> 0.0.0.0/0
 984         'localhost' -> 127.0.0.1/8
 985         'localnetA' -> SERVER_ADDRESS/8
 986         'localnetB' -> SERVER_ADDRESS/16
 987         'localnetC' -> SERVER_ADDRESS/24
 988
 989     Having an empty rule list is equivalent to either using ``'allow %
 990     from all'`` if your rule order is set to ``'deny,allow'`` or ``'deny %
 991     from all'`` if your rule order is set to ``'allow,deny'`` or
 992     ``'explicit'``.
 993
 994     For the :term:`IP address` matching
 995     system, the following work:
 996
 997     * ``xxx.xxx.xxx.xxx`` (an exact :term:`IP address`)
 998     * ``xxx.xxx.xxx.[yyy-zzz]`` (an :term:`IP address` range)
 999     * ``xxx.xxx.xxx.xxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IP` addresses)
1000
1001     But the following does not work:
1002
1003     * ``xxx.xxx.xxx.xx[yyy-zzz]`` (partial :term:`IP` address range)
1004
1005     For :term:`IPv6` addresses, the following work:
1006
1007     * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx`` (an exact :term:`IPv6` address)
1008     * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:[yyyy-zzzz]`` (an :term:`IPv6` address range)
1009     * ``xxxx:xxxx:xxxx:xxxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IPv6` addresses)
1010
1011     But the following does not work:
1012
1013     * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xx[yyy-zzz]`` (partial :term:`IPv6` address range)
1014
1015 .. config:option:: $cfg['Servers'][$i]['DisableIS']
1016
1017     :type: boolean
1018     :default: true
1019
1020     Disable using ``INFORMATION_SCHEMA`` to retrieve information (use
1021     ``SHOW`` commands instead), because of speed issues when many
1022     databases are present. Currently used in some parts of the code, more
1023     to come.
1024
1025 .. config:option:: $cfg['Servers'][$i]['ShowDatabasesCommand']
1026
1027     :type: string
1028     :default: ``'SHOW DATABASES'``
1029
1030     On a server with a huge number of databases, the default ``SHOW DATABASES``
1031     command used to fetch the name of available databases will probably be too
1032     slow, so it can be replaced by faster commands. You can use ``#user#``
1033     string will be replaced by current user.
1034
1035     When using ``false``, it will disable fetching databases from the server,
1036     only databases in :config:option:`$cfg['Servers'][$i]['only_db']` will be
1037     displayed.
1038
1039     Examples:
1040
1041     * ``'SHOW DATABASES'``
1042     * ``"SHOW DATABASES LIKE '#user#\_%'"``
1043     * ``'SELECT DISTINCT TABLE_SCHEMA FROM information_schema.SCHEMA_PRIVILEGES'``
1044     * ``'SELECT SCHEMA_NAME FROM information_schema.SCHEMATA'``
1045     * ``false``
1046
1047 .. config:option:: $cfg['Servers'][$i]['SignonScript']
1048
1049     :type: string
1050     :default: ``''``
1051
1052     Name of PHP script to be sourced and executed to obtain login
1053     credentials. This is alternative approach to session based single
1054     signon. The script needs to provide function
1055     ``get_login_credentials`` which returns list of username and
1056     password, accepting single parameter of existing username (can be
1057     empty). See :file:`examples/signon-script.php` for an example.
1058
1059 .. config:option:: $cfg['Servers'][$i]['SignonSession']
1060
1061     :type: string
1062     :default: ``''``
1063
1064     Name of session which will be used for signon authentication method.
1065     You should use something different than ``phpMyAdmin``, because this
1066     is session which phpMyAdmin uses internally. Takes effect only if
1067     :config:option:`$cfg['Servers'][$i]['SignonScript']` is not configured.
1068
1069 .. config:option:: $cfg['Servers'][$i]['SignonURL']
1070
1071     :type: string
1072     :default: ``''``
1073
1074     :term:`URL` where user will be redirected
1075     to log in for signon authentication method. Should be absolute
1076     including protocol.
1077
1078 .. config:option:: $cfg['Servers'][$i]['LogoutURL']
1079
1080     :type: string
1081     :default: ``''``
1082
1083     :term:`URL` where user will be redirected
1084     after logout (doesn't affect config authentication method). Should be
1085     absolute including protocol.
1086
1087 .. config:option:: $cfg['Servers'][$i]['StatusCacheDatabases']
1088
1089     :type: array of strings
1090     :default: array()
1091
1092     Enables caching of ``TABLE STATUS`` outputs for specific databases on
1093     this server (in some cases ``TABLE STATUS`` can be very slow, so you
1094     may want to cache it). APC is used (if the PHP extension is available,
1095     if not, this setting is ignored silently). You have to provide
1096     :config:option:`$cfg['Servers'][$i]['StatusCacheLifetime']`.
1097
1098     Takes effect only if :config:option:`$cfg['Servers'][$i]['DisableIS']` is
1099     ``true``.
1100
1101 .. config:option:: $cfg['Servers'][$i]['StatusCacheLifetime']
1102
1103     :type: integer
1104     :default: 0
1105
1106     Lifetime in seconds of the ``TABLE STATUS`` cache if
1107     :config:option:`$cfg['Servers'][$i]['StatusCacheDatabases']` is used.
1108
1109 Generic settings
1110 ----------------
1111
1112 .. config:option:: $cfg['ServerDefault']
1113
1114     :type: integer
1115     :default: 1
1116
1117     If you have more than one server configured, you can set
1118     :config:option:`$cfg['ServerDefault']` to any one of them to autoconnect to that
1119     server when phpMyAdmin is started, or set it to 0 to be given a list
1120     of servers without logging in.
1121
1122     If you have only one server configured,
1123     :config:option:`$cfg['ServerDefault']` MUST be set to that server.
1124
1125 .. config:option:: $cfg['VersionCheck']
1126
1127     :type: boolean
1128     :default: true
1129
1130     Enables check for latest versions using javascript on main phpMyAdmin
1131     page.
1132
1133     .. note::
1134
1135         This setting can be adjusted by your vendor.
1136
1137 .. config:option:: $cfg['ProxyUrl']
1138
1139     :type: string
1140     :default: ""
1141
1142     The url of the proxy to be used when phpmyadmin needs to access the outside
1143     intenet such as when retrieving the latest version info or submitting error
1144     reports.  You need this if the server where phpMyAdmin is installed does not
1145     have direct access to the internet.
1146     The format is: "hostname:portnumber"
1147
1148 .. config:option:: $cfg['ProxyUser']
1149
1150     :type: string
1151     :default: ""
1152
1153     The username for authenticating with the proxy. By default, no
1154     authentication is performed. If a username is supplied, Basic
1155     Authentication will be performed. No other types of authentication
1156     are currently supported.
1157
1158 .. config:option:: $cfg['ProxyPass']
1159
1160     :type: string
1161     :default: ""
1162
1163     The password for authenticating with the proxy.
1164
1165 .. config:option:: $cfg['MaxDbList']
1166
1167     :type: integer
1168     :default: 100
1169
1170     The maximum number of database names to be displayed in the main panel's
1171     database list.
1172
1173 .. config:option:: $cfg['MaxNavigationItems']
1174
1175     :type: integer
1176     :default: 250
1177
1178     The number of items that can be displayed on each page of the
1179     navigation tree.
1180
1181 .. config:option:: $cfg['MaxTableList']
1182
1183     :type: integer
1184     :default: 250
1185
1186     The maximum number of table names to be displayed in the main panel's
1187     list (except on the Export page). This limit is also enforced in the
1188     navigation panel when in Light mode.
1189
1190 .. config:option:: $cfg['ShowHint']
1191
1192     :type: boolean
1193     :default: true
1194
1195     Whether or not to show hints (for example, hints when hovering over
1196     table headers).
1197
1198 .. config:option:: $cfg['MaxCharactersInDisplayedSQL']
1199
1200     :type: integer
1201     :default: 1000
1202
1203     The maximum number of characters when a :term:`SQL` query is displayed. The
1204     default limit of 1000 should be correct to avoid the display of tons of
1205     hexadecimal codes that represent BLOBs, but some users have real
1206     :term:`SQL` queries that are longer than 1000 characters. Also, if a
1207     query's length exceeds this limit, this query is not saved in the history.
1208
1209 .. config:option:: $cfg['PersistentConnections']
1210
1211     :type: boolean
1212     :default: false
1213
1214     Whether `persistent connections <http://php.net/manual/en/features
1215     .persistent-connections.php>`_ should be used or not. Works with
1216     following extensions:
1217
1218     * mysql (`mysql\_pconnect <http://php.net/manual/en/function.mysql-
1219       pconnect.php>`_),
1220     * mysqli (requires PHP 5.3.0 or newer, `more information
1221       <http://php.net/manual/en/mysqli.persistconns.php>`_).
1222
1223 .. config:option:: $cfg['ForceSSL']
1224
1225     :type: boolean
1226     :default: false
1227
1228     Whether to force using https while accessing phpMyAdmin.
1229
1230     .. note::
1231
1232         In some setups (like separate SSL proxy or load balancer) you might
1233         have to set :config:option:`$cfg['PmaAbsoluteUri']` for correct
1234         redirection.
1235
1236 .. config:option:: $cfg['ExecTimeLimit']
1237
1238     :type: integer [number of seconds]
1239     :default: 300
1240
1241     Set the number of seconds a script is allowed to run. If seconds is
1242     set to zero, no time limit is imposed. This setting is used while
1243     importing/exporting dump files but has
1244     no effect when PHP is running in safe mode.
1245
1246 .. config:option:: $cfg['SessionSavePath']
1247
1248     :type: string
1249     :default: ``''``
1250
1251     Path for storing session data (`session\_save\_path PHP parameter
1252     <http://php.net/session_save_path>`_).
1253
1254 .. config:option:: $cfg['MemoryLimit']
1255
1256     :type: string [number of bytes]
1257     :default: ``'-1'``
1258
1259     Set the number of bytes a script is allowed to allocate. If set to
1260     ``'-1'``, no limit is imposed.
1261
1262     This setting is used while importing/exporting dump files and at some other
1263     places in phpMyAdmin so you definitely don't want to put here a too low
1264     value. It has no effect when PHP is running in safe mode.
1265
1266     You can also use any string as in :file:`php.ini`, eg. '16M'. Ensure you
1267     don't omit the suffix (16 means 16 bytes!)
1268
1269 .. config:option:: $cfg['SkipLockedTables']
1270
1271     :type: boolean
1272     :default: false
1273
1274     Mark used tables and make it possible to show databases with locked
1275     tables (since MySQL 3.23.30).
1276
1277 .. config:option:: $cfg['ShowSQL']
1278
1279     :type: boolean
1280     :default: true
1281
1282     Defines whether :term:`SQL` queries
1283     generated by phpMyAdmin should be displayed or not.
1284
1285 .. config:option:: $cfg['RetainQueryBox']
1286
1287     :type: boolean
1288     :default: false
1289
1290     Defines whether the :term:`SQL` query box
1291     should be kept displayed after its submission.
1292
1293 .. config:option:: $cfg['CodemirrorEnable']
1294
1295     :type: boolean
1296     :default: true
1297
1298     Defines whether to use a Javascript code editor for SQL query boxes.
1299     CodeMirror provides syntax highlighting and line numbers.  However,
1300     middle-clicking for pasting the clipboard contents in some Linux
1301     distributions (such as Ubuntu) is not supported by all browsers.
1302
1303 .. config:option:: $cfg['AllowUserDropDatabase']
1304
1305     :type: boolean
1306     :default: false
1307
1308     Defines whether normal users (non-administrator) are allowed to delete
1309     their own database or not. If set as false, the link :guilabel:`Drop
1310     Database` will not be shown, and even a ``DROP DATABASE mydatabase`` will
1311     be rejected. Quite practical for :term:`ISP` 's with many customers.
1312
1313     .. note::
1314
1315         This limitation of :term:`SQL` queries is not
1316         as strict as when using MySQL privileges. This is due to nature of
1317         :term:`SQL` queries which might be quite
1318         complicated.  So this choice should be viewed as help to avoid accidental
1319         dropping rather than strict privilege limitation.
1320
1321 .. config:option:: $cfg['Confirm']
1322
1323     :type: boolean
1324     :default: true
1325
1326     Whether a warning ("Are your really sure...") should be displayed when
1327     you're about to lose data.
1328
1329 .. config:option:: $cfg['UseDbSearch']
1330
1331     :type: boolean
1332     :default: true
1333
1334     Define whether the "search string inside database" is enabled or not.
1335
1336 .. config:option:: $cfg['IgnoreMultiSubmitErrors']
1337
1338     :type: boolean
1339     :default: false
1340
1341     Define whether phpMyAdmin will continue executing a multi-query
1342     statement if one of the queries fails. Default is to abort execution.
1343
1344 Cookie authentication options
1345 -----------------------------
1346
1347 .. config:option:: $cfg['blowfish_secret']
1348
1349     :type: string
1350     :default: ``''``
1351
1352     The "cookie" auth\_type uses blowfish algorithm to encrypt the
1353     password. If you are using the "cookie" auth\_type, enter here a
1354     random passphrase of your choice. It will be used internally by the
1355     blowfish algorithm: you won’t be prompted for this passphrase. There
1356     is no maximum length for this secret.
1357
1358     .. versionchanged:: 3.1.0
1359         Since version 3.1.0 phpMyAdmin can generate this on the fly, but it
1360         makes a bit weaker security as this generated secret is stored in
1361         session and furthermore it makes impossible to recall user name from
1362         cookie.
1363
1364 .. config:option:: $cfg['LoginCookieRecall']
1365
1366     :type: boolean
1367     :default: true
1368
1369     Define whether the previous login should be recalled or not in cookie
1370     authentication mode.
1371
1372     This is automatically disabled if you do not have
1373     configured :config:option:`$cfg['blowfish_secret']`.
1374
1375 .. config:option:: $cfg['LoginCookieValidity']
1376
1377     :type: integer [number of seconds]
1378     :default: 1440
1379
1380     Define how long a login cookie is valid. Please note that php
1381     configuration option `session.gc\_maxlifetime
1382     <http://php.net/manual/en/session.configuration.php#ini.session.gc-
1383     maxlifetime>`_ might limit session validity and if the session is lost,
1384     the login cookie is also invalidated. So it is a good idea to set
1385     ``session.gc_maxlifetime`` at least to the same value of
1386     :config:option:`$cfg['LoginCookieValidity']`.
1387
1388 .. config:option:: $cfg['LoginCookieStore']
1389
1390     :type: integer [number of seconds]
1391     :default: 0
1392
1393     Define how long login cookie should be stored in browser. Default 0
1394     means that it will be kept for existing session. This is recommended
1395     for not trusted environments.
1396
1397 .. config:option:: $cfg['LoginCookieDeleteAll']
1398
1399     :type: boolean
1400     :default: true
1401
1402     If enabled (default), logout deletes cookies for all servers,
1403     otherwise only for current one. Setting this to false makes it easy to
1404     forget to log out from other server, when you are using more of them.
1405
1406 .. _AllowArbitraryServer:
1407 .. config:option:: $cfg['AllowArbitraryServer']
1408
1409     :type: boolean
1410     :default: false
1411
1412     If enabled, allows you to log in to arbitrary servers using cookie
1413     authentication.
1414
1415     .. note::
1416
1417         Please use this carefully, as this may allow users access to MySQL servers
1418         behind the firewall where your :term:`HTTP`
1419         server is placed.
1420
1421 .. config:option:: $cfg['CaptchaLoginPublicKey']
1422
1423     :type: string
1424     :default: ``''``
1425
1426     The public key for the reCaptcha service that can be obtain from
1427     http://www.google.com/recaptcha.
1428
1429     reCaptcha will be then used in :ref:`cookie`.
1430
1431 .. config:option:: $cfg['CaptchaLoginPrivateKey']
1432
1433     :type: string
1434     :default: ``''``
1435
1436     The private key for the reCaptcha service that can be obtain from
1437     http://www.google.com/recaptcha.
1438
1439     reCaptcha will be then used in :ref:`cookie`.
1440
1441 Navigation panel setup
1442 ----------------------
1443
1444 .. config:option:: $cfg['NavigationTreeEnableGrouping']
1445
1446     :type: boolean
1447     :default: true
1448
1449     Defines whether to group the databases based on a common prefix
1450     in their name :config:option:`$cfg['NavigationTreeDbSeparator']`.
1451
1452 .. config:option:: $cfg['NavigationTreeDbSeparator']
1453
1454     :type: string or array
1455     :default: ``'_'``
1456
1457     The string used to separate the parts of the database name when
1458     showing them in a tree. Alternatively you can specify more strings in
1459     an array and all of them will be used as a separator.
1460
1461 .. config:option:: $cfg['NavigationTreeTableSeparator']
1462
1463     :type: string or array
1464     :default: ``'__'``
1465
1466     Defines a string to be used to nest table spaces. This means if you have
1467     tables like ``first__second__third`` this will be shown as a three-level
1468     hierarchy like: first > second > third.  If set to false or empty, the
1469     feature is disabled. NOTE: You should not use this separator at the
1470     beginning or end of a table name or multiple times after another without
1471     any other characters in between.
1472
1473 .. config:option:: $cfg['NavigationTreeTableLevel']
1474
1475     :type: integer
1476     :default: 1
1477
1478     Defines how many sublevels should be displayed when splitting up
1479     tables by the above separator.
1480
1481 .. config:option:: $cfg['NumRecentTables']
1482
1483     :type: integer
1484     :default: 10
1485
1486     The maximum number of recently used tables shown in the navigation
1487     panel. Set this to 0 (zero) to disable the listing of recent tables.
1488
1489 .. config:option:: $cfg['NavigationDisplayLogo']
1490
1491     :type: boolean
1492     :default: true
1493
1494     Defines whether or not to display the phpMyAdmin logo at the top of
1495     the navigation panel.
1496
1497 .. config:option:: $cfg['NavigationLogoLink']
1498
1499     :type: string
1500     :default: ``'index.php'``
1501
1502     Enter :term:`URL` where logo in the
1503     navigation panel will point to. For use especially with self made
1504     theme which changes this.
1505
1506 .. config:option:: $cfg['NavigationLogoLinkWindow']
1507
1508     :type: string
1509     :default: ``'main'``
1510
1511     Whether to open the linked page in the main window (``main``) or in a
1512     new one (``new``). Note: use ``new`` if you are linking to
1513     ``phpmyadmin.net``.
1514
1515 .. config:option:: $cfg['NavigationTreeDisplayItemFilterMinimum']
1516
1517     :type: integer
1518     :default: 30
1519
1520     Defines the minimum number of items (tables, views, routines and
1521     events) to display a JavaScript filter box above the list of items in
1522     the navigation tree.
1523
1524     To disable the filter completely some high number can be used (e.g. 9999)
1525
1526 .. config:option:: $cfg['NavigationTreeDisplayDbFilterMinimum']
1527
1528     :type: integer
1529     :default: 30
1530
1531     Defines the minimum number of databases to display a JavaScript filter
1532     box above the list of databases in the navigation tree.
1533
1534     To disable the filter completely some high number can be used
1535     (e.g. 9999)
1536
1537 .. config:option:: $cfg['NavigationDisplayServers']
1538
1539     :type: boolean
1540     :default: true
1541
1542     Defines whether or not to display a server choice at the top of the
1543     navigation panel.
1544
1545 .. config:option:: $cfg['DisplayServersList']
1546
1547     :type: boolean
1548     :default: false
1549
1550     Defines whether to display this server choice as links instead of in a
1551     drop-down.
1552
1553 .. config:option:: $cfg['NavigationTreeDefaultTabTable']
1554
1555     :type: string
1556     :default: ``'tbl_structure.php'``
1557
1558     Defines the tab displayed by default when clicking the small icon next
1559     to each table name in the navigation panel. Possible values:
1560
1561     * ``tbl_structure.php``
1562     * ``tbl_sql.php``
1563     * ``tbl_select.php``
1564     * ``tbl_change.php``
1565     * ``sql.php``
1566
1567 Main panel
1568 ----------
1569
1570 .. config:option:: $cfg['ShowStats']
1571
1572     :type: boolean
1573     :default: true
1574
1575     Defines whether or not to display space usage and statistics about
1576     databases and tables. Note that statistics requires at least MySQL
1577     3.23.3 and that, at this date, MySQL doesn't return such information
1578     for Berkeley DB tables.
1579
1580 .. config:option:: $cfg['ShowServerInfo']
1581
1582     :type: boolean
1583     :default: true
1584
1585     Defines whether to display detailed server information on main page.
1586     You can additionally hide more information by using
1587     :config:option:`$cfg['Servers'][$i]['verbose']`.
1588
1589 .. config:option:: $cfg['ShowPhpInfo']
1590
1591     :type: boolean
1592     :default: false
1593
1594 .. config:option:: $cfg['ShowChgPassword']
1595
1596     :type: boolean
1597     :default: true
1598
1599 .. config:option:: $cfg['ShowCreateDb']
1600
1601     :type: boolean
1602     :default: true
1603
1604     Defines whether to display the :guilabel:`PHP information` and
1605     :guilabel:`Change password` links and form for creating database or not at
1606     the starting main (right) frame. This setting does not check MySQL commands
1607     entered directly.
1608
1609     Please note that to block the usage of ``phpinfo()`` in scripts, you have to
1610     put this in your :file:`php.ini`:
1611
1612     .. code-block:: ini
1613
1614         disable_functions = phpinfo()
1615
1616     Also note that enabling the :guilabel:`Change password` link has no effect
1617     with config authentication mode: because of the hard coded password value
1618     in the configuration file, end users can't be allowed to change their
1619     passwords.
1620
1621 Database structure
1622 ------------------
1623
1624 .. config:option:: $cfg['ShowDbStructureCreation']
1625
1626     :type: boolean
1627     :default: false
1628
1629     Defines whether the database structure page (tables list) has a
1630     "Creation" column that displays when each table was created.
1631
1632 .. config:option:: $cfg['ShowDbStructureLastUpdate']
1633
1634     :type: boolean
1635     :default: false
1636
1637     Defines whether the database structure page (tables list) has a "Last
1638     update" column that displays when each table was last updated.
1639
1640 .. config:option:: $cfg['ShowDbStructureLastCheck']
1641
1642     :type: boolean
1643     :default: false
1644
1645     Defines whether the database structure page (tables list) has a "Last
1646     check" column that displays when each table was last checked.
1647
1648 .. config:option:: $cfg['HideStructureActions']
1649
1650     :type: boolean
1651     :default: true
1652
1653     Defines whether the table structure actions are hidden under a "More"
1654     drop-down.
1655
1656 Browse mode
1657 -----------
1658
1659 .. config:option:: $cfg['TableNavigationLinksMode']
1660
1661     :type: string
1662     :default: ``'icons'``
1663
1664     Defines whether the table navigation links contain ``'icons'``, ``'text'``
1665     or ``'both'``.
1666
1667 .. config:option:: $cfg['ShowAll']
1668
1669     :type: boolean
1670     :default: false
1671
1672     Defines whether a user should be displayed a "Show all" button in browse
1673     mode or not in all cases. By default it is shown only on small tables (less
1674     than 500 rows) to avoid performance issues while getting too many rows.
1675
1676 .. config:option:: $cfg['MaxRows']
1677
1678     :type: integer
1679     :default: 25
1680
1681     Number of rows displayed when browsing a result set and no LIMIT
1682     clause is used. If the result set contains more rows, "Previous" and
1683     "Next" links will be shown. Possible values: 25,50,100,250,500.
1684
1685 .. config:option:: $cfg['Order']
1686
1687     :type: string
1688     :default: ``'SMART'``
1689
1690     Defines whether columns are displayed in ascending (``ASC``) order, in
1691     descending (``DESC``) order or in a "smart" (``SMART``) order - I.E.
1692     descending order for columns of type TIME, DATE, DATETIME and
1693     TIMESTAMP, ascending order else- by default.
1694
1695 .. config:option:: $cfg['DisplayBinaryAsHex']
1696
1697     :type: boolean
1698     :default: true
1699
1700     Defines whether the "Show binary contents as HEX" browse option is
1701     ticked by default.
1702
1703 .. config:option:: $cfg['GridEditing']
1704
1705     :type: string
1706     :default: ``'double-click'``
1707
1708     Defines which action (``double-click`` or ``click``) triggers grid
1709     editing. Can be deactived with the ``disabled`` value.
1710
1711 .. config:option:: $cfg['SaveCellsAtOnce']
1712
1713     :type: boolean
1714     :default: false
1715
1716     Defines whether or not to save all edited cells at once for grid
1717     editing.
1718
1719 Editing mode
1720 ------------
1721
1722 .. config:option:: $cfg['ProtectBinary']
1723
1724     :type: boolean or string
1725     :default: ``'blob'``
1726
1727     Defines whether ``BLOB`` or ``BINARY`` columns are protected from
1728     editing when browsing a table's content. Valid values are:
1729
1730     * ``false`` to allow editing of all columns;
1731     * ``'blob'`` to allow editing of all columns except ``BLOBS``;
1732     * ``'noblob'`` to disallow editing of all columns except ``BLOBS`` (the
1733       opposite of ``'blob'``);
1734     * ``'all'`` to disallow editing of all ``BINARY`` or ``BLOB`` columns.
1735
1736 .. config:option:: $cfg['ShowFunctionFields']
1737
1738     :type: boolean
1739     :default: true
1740
1741     Defines whether or not MySQL functions fields should be initially
1742     displayed in edit/insert mode. Since version 2.10, the user can toggle
1743     this setting from the interface.
1744
1745 .. config:option:: $cfg['ShowFieldTypesInDataEditView']
1746
1747     :type: boolean
1748     :default: true
1749
1750     Defines whether or not type fields should be initially displayed in
1751     edit/insert mode. The user can toggle this setting from the interface.
1752
1753 .. config:option:: $cfg['InsertRows']
1754
1755     :type: integer
1756     :default: 2
1757
1758     Defines the maximum number of concurrent entries for the Insert page.
1759
1760 .. config:option:: $cfg['ForeignKeyMaxLimit']
1761
1762     :type: integer
1763     :default: 100
1764
1765     If there are fewer items than this in the set of foreign keys, then a
1766     drop-down box of foreign keys is presented, in the style described by
1767     the :config:option:`$cfg['ForeignKeyDropdownOrder']` setting.
1768
1769 .. config:option:: $cfg['ForeignKeyDropdownOrder']
1770
1771     :type: array
1772     :default: array('content-id', 'id-content')
1773
1774     For the foreign key drop-down fields, there are several methods of
1775     display, offering both the key and value data. The contents of the
1776     array should be one or both of the following strings: ``content-id``,
1777     ``id-content``.
1778
1779 Export and import settings
1780 --------------------------
1781
1782 .. config:option:: $cfg['ZipDump']
1783
1784     :type: boolean
1785     :default: true
1786
1787 .. config:option:: $cfg['GZipDump']
1788
1789     :type: boolean
1790     :default: true
1791
1792 .. config:option:: $cfg['BZipDump']
1793
1794     :type: boolean
1795     :default: true
1796
1797     Defines whether to allow the use of zip/GZip/BZip2 compression when
1798     creating a dump file
1799
1800 .. config:option:: $cfg['CompressOnFly']
1801
1802     :type: boolean
1803     :default: true
1804
1805     Defines whether to allow on the fly compression for GZip/BZip2
1806     compressed exports. This doesn't affect smaller dumps and allows users
1807     to create larger dumps that won't otherwise fit in memory due to php
1808     memory limit. Produced files contain more GZip/BZip2 headers, but all
1809     normal programs handle this correctly.
1810
1811 .. config:option:: $cfg['Export']
1812
1813     :type: array
1814     :default: array(...)
1815
1816     In this array are defined default parameters for export, names of
1817     items are similar to texts seen on export page, so you can easily
1818     identify what they mean.
1819
1820 .. config:option:: $cfg['Export']['method']
1821
1822     :type: string
1823     :default: ``'quick'``
1824
1825     Defines how the export form is displayed when it loads. Valid values
1826     are:
1827
1828     * ``quick`` to display the minimum number of options to configure
1829     * ``custom`` to display every available option to configure
1830     * ``custom-no-form`` same as ``custom`` but does not display the option
1831       of using quick export
1832
1833
1834
1835 .. config:option:: $cfg['Import']
1836
1837     :type: array
1838     :default: array(...)
1839
1840     In this array are defined default parameters for import, names of
1841     items are similar to texts seen on import page, so you can easily
1842     identify what they mean.
1843
1844
1845 Tabs display settings
1846 ---------------------
1847
1848 .. config:option:: $cfg['TabsMode']
1849
1850     :type: string
1851     :default: ``'both'``
1852
1853     Defines whether the menu tabs contain ``'icons'``, ``'text'`` or ``'both'``.
1854
1855 .. config:option:: $cfg['ActionLinksMode']
1856
1857     :type: string
1858     :default: ``'both'``
1859
1860     If set to ``icons``, will display icons instead of text for db and table
1861     properties links (like :guilabel:`Browse`, :guilabel:`Select`,
1862     :guilabel:`Insert`, ...). Can be set to ``'both'``
1863     if you want icons AND text. When set to ``text``, will only show text.
1864
1865 .. config:option:: $cfg['PropertiesNumColumns']
1866
1867     :type: integer
1868     :default: 1
1869
1870     How many columns will be utilized to display the tables on the database
1871     property view? When setting this to a value larger than 1, the type of the
1872     database will be omitted for more display space.
1873
1874 .. config:option:: $cfg['DefaultTabServer']
1875
1876     :type: string
1877     :default: ``'index.php'``
1878
1879     Defines the tab displayed by default on server view. Possible values:
1880
1881     * ``main.php`` (recommended for multi-user setups)
1882     * ``server_databases.php``,
1883     * ``server_status.php``
1884     * ``server_variables.php``
1885     * ``server_privileges.php``
1886
1887 .. config:option:: $cfg['DefaultTabDatabase']
1888
1889     :type: string
1890     :default: ``'db_structure.php'``
1891
1892     Defines the tab displayed by default on database view. Possible
1893     values:
1894
1895     * ``db_structure.php``
1896     * ``db_sql.php``
1897     * ``db_search.php``.
1898
1899 .. config:option:: $cfg['DefaultTabTable']
1900
1901     :type: string
1902     :default: ``'sql.php'``
1903
1904     Defines the tab displayed by default on table view. Possible values:
1905
1906     * ``tbl_structure.php``
1907     * ``tbl_sql.php``
1908     * ``tbl_select.php``
1909     * ``tbl_change.php``
1910     * ``sql.php``
1911
1912 PDF Options
1913 -----------
1914
1915 .. config:option:: $cfg['PDFPageSizes']
1916
1917     :type: array
1918     :default: ``array('A3', 'A4', 'A5', 'letter', 'legal')``
1919
1920     Array of possible paper sizes for creating PDF pages.
1921
1922     You should never need to change this.
1923
1924 .. config:option:: $cfg['PDFDefaultPageSize']
1925
1926     :type: string
1927     :default: ``'A4'``
1928
1929     Default page size to use when creating PDF pages. Valid values are any
1930     listed in :config:option:`$cfg['PDFPageSizes']`.
1931
1932 Languages
1933 ---------
1934
1935 .. config:option:: $cfg['DefaultLang']
1936
1937     :type: string
1938     :default: ``'en'``
1939
1940     Defines the default language to use, if not browser-defined or user-
1941     defined. The corresponding language file needs to be in
1942     locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
1943
1944 .. config:option:: $cfg['DefaultConnectionCollation']
1945
1946     :type: string
1947     :default: ``'utf8_general_ci'``
1948
1949     Defines the default connection collation to use, if not user-defined.
1950     See the `MySQL documentation <http://dev.mysql.com/doc/mysql/en
1951     /charset-charsets.html>`_ for list of possible values. This setting is
1952     ignored when connected to Drizzle server.
1953
1954 .. config:option:: $cfg['Lang']
1955
1956     :type: string
1957     :default: not set
1958
1959     Force language to use. The corresponding language file needs to be in
1960     locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
1961
1962 .. config:option:: $cfg['FilterLanguages']
1963
1964     :type: string
1965     :default: ``''``
1966
1967     Limit list of available languages to those matching the given regular
1968     expression. For example if you want only Czech and English, you should
1969     set filter to ``'^(cs|en)'``.
1970
1971 .. config:option:: $cfg['RecodingEngine']
1972
1973     :type: string
1974     :default: ``'auto'``
1975
1976     You can select here which functions will be used for character set
1977     conversion. Possible values are:
1978
1979     * auto - automatically use available one (first is tested iconv, then
1980       recode)
1981     * iconv - use iconv or libiconv functions
1982     * recode - use recode\_string function
1983     * mb - use mbstring extension
1984     * none - disable encoding conversion
1985
1986     Enabled charset conversion activates a pull-down menu in the Export
1987     and Import pages, to choose the character set when exporting a file.
1988     The default value in this menu comes from
1989     :config:option:`$cfg['Export']['charset']` and :config:option:`$cfg['Import']['charset']`.
1990
1991 .. config:option:: $cfg['IconvExtraParams']
1992
1993     :type: string
1994     :default: ``'//TRANSLIT'``
1995
1996     Specify some parameters for iconv used in charset conversion. See
1997     `iconv documentation <http://www.gnu.org/software/libiconv/documentati
1998     on/libiconv/iconv_open.3.html>`_ for details. By default
1999     ``//TRANSLIT`` is used, so that invalid characters will be
2000     transliterated.
2001
2002 .. config:option:: $cfg['AvailableCharsets']
2003
2004     :type: array
2005     :default: array(..._
2006
2007     Available character sets for MySQL conversion. You can add your own
2008     (any of supported by recode/iconv) or remove these which you don't
2009     use. Character sets will be shown in same order as here listed, so if
2010     you frequently use some of these move them to the top.
2011
2012 Web server settings
2013 -------------------
2014
2015 .. config:option:: $cfg['OBGzip']
2016
2017     :type: string/boolean
2018     :default: ``'auto'``
2019
2020     Defines whether to use GZip output buffering for increased speed in
2021     :term:`HTTP` transfers. Set to
2022     true/false for enabling/disabling. When set to 'auto' (string),
2023     phpMyAdmin tries to enable output buffering and will automatically
2024     disable it if your browser has some problems with buffering. IE6 with
2025     a certain patch is known to cause data corruption when having enabled
2026     buffering.
2027
2028 .. config:option:: $cfg['TrustedProxies']
2029
2030     :type: array
2031     :default: array()
2032
2033     Lists proxies and HTTP headers which are trusted for
2034     :config:option:`$cfg['Servers'][$i]['AllowDeny']['order']`. This list is by
2035     default empty, you need to fill in some trusted proxy servers if you
2036     want to use rules for IP addresses behind proxy.
2037
2038     The following example specifies that phpMyAdmin should trust a
2039     HTTP\_X\_FORWARDED\_FOR (``X -Forwarded-For``) header coming from the proxy
2040     1.2.3.4:
2041
2042     .. code-block:: php
2043
2044         $cfg['TrustedProxies'] = array('1.2.3.4' => 'HTTP_X_FORWARDED_FOR');
2045
2046     The :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` directive uses the
2047     client's IP address as usual.
2048
2049 .. config:option:: $cfg['GD2Available']
2050
2051     :type: string
2052     :default: ``'auto'``
2053
2054     Specifies whether GD >= 2 is available. If yes it can be used for MIME
2055     transformations. Possible values are:
2056
2057     * auto - automatically detect
2058     * yes - GD 2 functions can be used
2059     * no - GD 2 function cannot be used
2060
2061 .. config:option:: $cfg['CheckConfigurationPermissions']
2062
2063     :type: boolean
2064     :default: true
2065
2066     We normally check the permissions on the configuration file to ensure
2067     it's not world writable. However, phpMyAdmin could be installed on a
2068     NTFS filesystem mounted on a non-Windows server, in which case the
2069     permissions seems wrong but in fact cannot be detected. In this case a
2070     sysadmin would set this parameter to ``false``.
2071
2072 .. config:option:: $cfg['LinkLengthLimit']
2073
2074     :type: integer
2075     :default: 1000
2076
2077     Limit for length of :term:`URL` in links.  When length would be above this
2078     limit, it is replaced by form with button. This is required as some web
2079     servers (:term:`IIS`) have problems with long :term:`URL` .
2080
2081 .. config:option:: $cfg['CSPAllow']
2082
2083     :type: string
2084     :default: ``''``
2085
2086     Additional string to include in allowed script and image sources in Content
2087     Security Policy header.
2088
2089     This can be useful when you want to include some external javascript files
2090     in :file:`config.footer.inc.php` or :file:`config.header.inc.php`, which
2091     would be normally not allowed by Content Security Policy.
2092
2093     To allow some sites, just list them within the string:
2094
2095     .. code-block:: php
2096
2097         $cfg['CSPAllow'] = 'example.com example.net';
2098
2099     .. versionadded:: 4.0.4
2100
2101 .. config:option:: $cfg['DisableMultiTableMaintenance']
2102
2103     :type: boolean
2104     :default: false
2105
2106     In the database Structure page, it's possible to mark some tables then
2107     choose an operation like optimizing for many tables. This can slow
2108     down a server; therefore, setting this to ``true`` prevents this kind
2109     of multiple maintenance operation.
2110
2111 Theme settings
2112 --------------
2113
2114 .. config:option:: $cfg['NaviWidth']
2115
2116     :type: integer
2117     :default:
2118
2119     Navigation panel width in pixels. See
2120     :file:`themes/themename/layout.inc.php`.
2121
2122 .. config:option:: $cfg['NaviBackground']
2123
2124     :type: string [CSS color for background]
2125     :default:
2126
2127 .. config:option:: $cfg['MainBackground']
2128
2129     :type: string [CSS color for background]
2130     :default:
2131
2132     The background styles used for both the frames. See
2133     :file:`themes/themename/layout.inc.php`.
2134
2135 .. config:option:: $cfg['NaviPointerBackground']
2136
2137     :type: string [CSS color for background]
2138     :default:
2139
2140 .. config:option:: $cfg['NaviPointerColor']
2141
2142     :type: string [CSS color]
2143     :default:
2144
2145     The style used for the pointer in the navigation panel. See
2146     :file:`themes/themename/layout.inc.php`.
2147
2148 .. config:option:: $cfg['Border']
2149
2150     :type: integer
2151     :default:
2152
2153     The size of a table's border. See :file:`themes/themename/layout.inc.php`.
2154
2155 .. config:option:: $cfg['ThBackground']
2156
2157     :type: string [CSS color for background]
2158     :default:
2159
2160 .. config:option:: $cfg['ThColor']
2161
2162     :type: string [CSS color]
2163     :default:
2164
2165     The style used for table headers. See
2166     :file:`themes/themename/layout.inc.php`.
2167
2168 .. _cfg_BgcolorOne:
2169 .. config:option:: $cfg['BgOne']
2170
2171     :type: string [CSS color]
2172     :default:
2173
2174     The color (HTML) #1 for table rows. See
2175     :file:`themes/themename/layout.inc.php`.
2176
2177 .. _cfg_BgcolorTwo:
2178 .. config:option:: $cfg['BgTwo']
2179
2180     :type: string [CSS color]
2181     :default:
2182
2183     The color (HTML) #2 for table rows. See
2184     :file:`themes/themename/layout.inc.php`.
2185
2186 .. config:option:: $cfg['BrowsePointerBackground']
2187
2188     :type: string [CSS color]
2189     :default:
2190
2191 .. config:option:: $cfg['BrowsePointerColor']
2192
2193     :type: string [CSS color]
2194     :default:
2195
2196 .. config:option:: $cfg['BrowseMarkerBackground']
2197
2198     :type: string [CSS color]
2199     :default:
2200
2201 .. config:option:: $cfg['BrowseMarkerColor']
2202
2203     :type: string [CSS color]
2204     :default:
2205
2206     The colors (HTML) uses for the pointer and the marker in browse mode.
2207     The former feature highlights the row over which your mouse is passing
2208     and the latter lets you visually mark/unmark rows by clicking on the
2209     corresponding checkbox. Highlighting / marking a column is done by
2210     hovering over / clicking the column's header (outside of the text).
2211     See :file:`themes/themename/layout.inc.php`.
2212
2213 .. config:option:: $cfg['FontFamily']
2214
2215     :type: string
2216     :default:
2217
2218     You put here a valid CSS font family value, for example ``arial, sans-
2219     serif``. See :file:`themes/themename/layout.inc.php`.
2220
2221 .. config:option:: $cfg['FontFamilyFixed']
2222
2223     :type: string
2224     :default:
2225
2226     You put here a valid CSS font family value, for example ``monospace``.
2227     This one is used in textarea. See :file:`themes/themename/layout.inc.php`.
2228
2229 Design customization
2230 --------------------
2231
2232 .. config:option:: $cfg['NavigationTreePointerEnable']
2233
2234     :type: boolean
2235     :default: true
2236
2237     A value of ``true`` activates the navi pointer.
2238
2239 .. config:option:: $cfg['BrowsePointerEnable']
2240
2241     :type: boolean
2242     :default: true
2243
2244     Whether to activate the browse pointer or not.
2245
2246 .. config:option:: $cfg['BrowseMarkerEnable']
2247
2248     :type: boolean
2249     :default: true
2250
2251     Whether to activate the browse marker or not.
2252
2253 .. config:option:: $cfg['LimitChars']
2254
2255     :type: integer
2256     :default: 50
2257
2258     Maximum number of characters shown in any non-numeric field on browse
2259     view. Can be turned off by a toggle button on the browse page.
2260
2261 .. config:option:: $cfg['RowActionLinks']
2262
2263     :type: string
2264     :default: ``'left'``
2265
2266     Defines the place where table row links (Edit, Copy, Delete) would be
2267     put when tables contents are displayed (you may have them displayed at
2268     the left side, right side, both sides or nowhere). "left" and "right"
2269     are parsed as "top" and "bottom" with vertical display mode.
2270
2271 .. config:option:: $cfg['DefaultDisplay']
2272
2273     :type: string
2274     :default: ``'horizonta'``
2275
2276     There are 3 display modes: horizontal, horizontalflipped and vertical.
2277     Define which one is displayed by default. The first mode displays each
2278     row on a horizontal line, the second rotates the headers by 90
2279     degrees, so you can use descriptive headers even though columns only
2280     contain small values and still print them out. The vertical mode sorts
2281     each row on a vertical lineup.
2282
2283 .. config:option:: $cfg['RememberSorting']
2284
2285     :type: boolean
2286     :default: true
2287
2288     If enabled, remember the sorting of each table when browsing them.
2289
2290 .. config:option:: $cfg['HeaderFlipType']
2291
2292     :type: string
2293     :default: ``'auto'``
2294
2295     The HeaderFlipType can be set to 'auto', 'css' or 'fake'. When using
2296     'css' the rotation of the header for horizontalflipped is done via
2297     CSS. The CSS transformation currently works only in Internet
2298     Explorer.If set to 'fake' PHP does the transformation for you, but of
2299     course this does not look as good as CSS. The 'auto' option enables
2300     CSS transformation when browser supports it and use PHP based one
2301     otherwise.
2302
2303 .. config:option:: $cfg['ShowBrowseComments']
2304
2305     :type: boolean
2306     :default: true
2307
2308 .. config:option:: $cfg['ShowPropertyComments']
2309
2310     :type: boolean
2311     :default: true
2312
2313     By setting the corresponding variable to ``true`` you can enable the
2314     display of column comments in Browse or Property display. In browse
2315     mode, the comments are shown inside the header. In property mode,
2316     comments are displayed using a CSS-formatted dashed-line below the
2317     name of the column. The comment is shown as a tool-tip for that
2318     column.
2319
2320 Text fields
2321 -----------
2322
2323 .. config:option:: $cfg['CharEditing']
2324
2325     :type: string
2326     :default: ``'input'``
2327
2328     Defines which type of editing controls should be used for CHAR and
2329     VARCHAR columns. Possible values are:
2330
2331     * input - this allows to limit size of text to size of columns in MySQL,
2332       but has problems with newlines in columns
2333     * textarea - no problems with newlines in columns, but also no length
2334       limitations
2335
2336 .. config:option:: $cfg['MinSizeForInputField']
2337
2338     :type: integer
2339     :default: 4
2340
2341     Defines the minimum size for input fields generated for CHAR and
2342     VARCHAR columns.
2343
2344 .. config:option:: $cfg['MaxSizeForInputField']
2345
2346     :type: integer
2347     :default: 60
2348
2349     Defines the maximum size for input fields generated for CHAR and
2350     VARCHAR columns.
2351
2352 .. config:option:: $cfg['TextareaCols']
2353
2354     :type: integer
2355     :default: 40
2356
2357 .. config:option:: $cfg['TextareaRows']
2358
2359     :type: integer
2360     :default: 15
2361
2362 .. config:option:: $cfg['CharTextareaCols']
2363
2364     :type: integer
2365     :default: 40
2366
2367 .. config:option:: $cfg['CharTextareaRows']
2368
2369     :type: integer
2370     :default: 2
2371
2372     Number of columns and rows for the textareas. This value will be
2373     emphasized (\*2) for :term:`SQL` query
2374     textareas and (\*1.25) for :term:`SQL`
2375     textareas inside the query window.
2376
2377     The Char\* values are used for CHAR
2378     and VARCHAR editing (if configured via :config:option:`$cfg['CharEditing']`).
2379
2380 .. config:option:: $cfg['LongtextDoubleTextarea']
2381
2382     :type: boolean
2383     :default: true
2384
2385     Defines whether textarea for LONGTEXT columns should have double size.
2386
2387 .. config:option:: $cfg['TextareaAutoSelect']
2388
2389     :type: boolean
2390     :default: false
2391
2392     Defines if the whole textarea of the query box will be selected on
2393     click.
2394
2395
2396 SQL query box settings
2397 ----------------------
2398
2399 .. config:option:: $cfg['SQLQuery']['Edit']
2400
2401     :type: boolean
2402     :default: true
2403
2404     Whether to display an edit link to change a query in any SQL Query
2405     box.
2406
2407 .. config:option:: $cfg['SQLQuery']['Explain']
2408
2409     :type: boolean
2410     :default: true
2411
2412     Whether to display a link to explain a SELECT query in any SQL Query
2413     box.
2414
2415 .. config:option:: $cfg['SQLQuery']['ShowAsPHP']
2416
2417     :type: boolean
2418     :default: true
2419
2420     Whether to display a link to wrap a query in PHP code in any SQL Query
2421     box.
2422
2423 .. config:option:: $cfg['SQLQuery']['Validate']
2424
2425     :type: boolean
2426     :default: false
2427
2428     Whether to display a link to validate a query in any SQL Query box.
2429
2430     .. seealso:: :config:option:`$cfg['SQLValidator']`
2431
2432 .. config:option:: $cfg['SQLQuery']['Refresh']
2433
2434     :type: boolean
2435     :default: true
2436
2437     Whether to display a link to refresh a query in any SQL Query box.
2438
2439 Web server upload/save/import directories
2440 -----------------------------------------
2441
2442 .. config:option:: $cfg['UploadDir']
2443
2444     :type: string
2445     :default: ``''``
2446
2447     The name of the directory where :term:`SQL` files have been uploaded by
2448     other means than phpMyAdmin (for example, ftp). Those files are available
2449     under a drop-down box when you click the database or table name, then the
2450     Import tab.
2451
2452     If
2453     you want different directory for each user, %u will be replaced with
2454     username.
2455
2456     Please note that the file names must have the suffix ".sql"
2457     (or ".sql.bz2" or ".sql.gz" if support for compressed formats is
2458     enabled).
2459
2460     This feature is useful when your file is too big to be
2461     uploaded via :term:`HTTP`, or when file
2462     uploads are disabled in PHP.
2463
2464     .. note::
2465
2466         If PHP is running in safe mode, this directory must be owned by the same
2467         user as the owner of the phpMyAdmin scripts.  See also :ref:`faq1_16` for
2468         alternatives.
2469
2470 .. config:option:: $cfg['SaveDir']
2471
2472     :type: string
2473     :default: ``''``
2474
2475     The name of the directory where dumps can be saved.
2476
2477     If you want different directory for each user, %u will be replaced with
2478     username.
2479
2480     Please note that the directory must exist and has to be writable for
2481     the user running webserver.
2482
2483     .. note::
2484
2485         If PHP is running in safe mode, this directory must be owned by the same
2486         user as the owner of the phpMyAdmin scripts.
2487
2488 .. config:option:: $cfg['TempDir']
2489
2490     :type: string
2491     :default: ``''``
2492
2493     The name of the directory where temporary files can be stored.
2494
2495     This is needed for importing ESRI Shapefiles, see :ref:`faq6_30` and to
2496     work around limitations of ``open_basedir`` for uploaded files, see
2497     :ref:`faq1_11`.
2498
2499     If the directory where phpMyAdmin is installed is
2500     subject to an ``open_basedir`` restriction, you need to create a
2501     temporary directory in some directory accessible by the web server.
2502     However for security reasons, this directory should be outside the
2503     tree published by webserver. If you cannot avoid having this directory
2504     published by webserver, place at least an empty :file:`index.html` file
2505     there, so that directory listing is not possible.
2506
2507     This directory should have as strict permissions as possible as the only
2508     user required to access this directory is the one who runs the webserver.
2509     If you have root privileges, simply make this user owner of this directory
2510     and make it accessible only by it:
2511
2512     .. code-block:: sh
2513
2514
2515         chown www-data:www-data tmp
2516         chmod 700 tmp
2517
2518     If you cannot change owner of the directory, you can achieve a similar
2519     setup using :term:`ACL`:
2520
2521     .. code-block:: sh
2522
2523         chmod 700 tmp
2524         setfacl -m "g:www-data:rwx" tmp
2525         setfacl -d -m "g:www-data:rwx" tmp
2526
2527     If neither of above works for you, you can still make the directory
2528     :command:`chmod 777`, but it might impose risk of other users on system
2529     reading and writing data in this directory.
2530
2531 Various display setting
2532 -----------------------
2533
2534 .. config:option:: $cfg['ShowDisplayDirection']
2535
2536     :type: boolean
2537     :default: false
2538
2539     Defines whether or not type display direction option is shown when
2540     browsing a table.
2541
2542 .. config:option:: $cfg['RepeatCells']
2543
2544     :type: integer
2545     :default: 100
2546
2547     Repeat the headers every X cells, or 0 to deactivate.
2548
2549 .. config:option:: $cfg['EditInWindow']
2550
2551     :type: boolean
2552     :default: true
2553
2554 .. config:option:: $cfg['QueryWindowWidth']
2555
2556     :type: integer
2557     :default: 550
2558
2559 .. config:option:: $cfg['QueryWindowHeight']
2560
2561     :type: integer
2562     :default: 310
2563
2564 .. config:option:: $cfg['QueryHistoryDB']
2565
2566     :type: boolean
2567     :default: false
2568
2569 .. config:option:: $cfg['QueryWindowDefTab']
2570
2571     :type: string
2572     :default: ``'sql'``
2573
2574 .. config:option:: $cfg['QueryHistoryMax']
2575
2576     :type: integer
2577     :default: 25
2578
2579     All those variables affect the query window feature. A :term:`SQL` link or
2580     icon is always displayed in the navigation panel. If JavaScript is enabled
2581     in your browser, a click on this opens a distinct query window, which is a
2582     direct interface to enter :term:`SQL` queries. Otherwise, the right panel
2583     changes to display a query box.
2584
2585     The size of this query window can be customized with
2586     :config:option:`$cfg['QueryWindowWidth']` and
2587     :config:option:`$cfg['QueryWindowHeight']` - both integers for the size in
2588     pixels.  Note that normally, those parameters will be modified in
2589     :file:`layout.inc.php`` for the theme you are using.
2590
2591     If :config:option:`$cfg['EditInWindow']` is set to true, a click on [Edit]
2592     from the results page (in the :guilabel:`Showing Rows` section) opens the
2593     query window and puts the current query inside it. If set to false,
2594     clicking on the link puts the :term:`SQL` query
2595     in the right panel's query box.
2596
2597     If :config:option:`$cfg['QueryHistoryDB']` is set to ``true``, all your
2598     Queries are logged to a table, which has to be created by you (see
2599     :config:option:`$cfg['Servers'][$i]['history']`). If set to false, all your
2600     queries will be appended to the form, but only as long as your window is
2601     opened they remain saved.
2602
2603     When using the JavaScript based query window, it will always get updated
2604     when you click on a new table/db to browse and will focus if you click on
2605     :guilabel:`Edit SQL` after using a query. You can suppress updating the
2606     query window by checking the box :guilabel:`Do not overwrite this query
2607     from outside the window` below the query textarea. Then you can browse
2608     tables/databases in the background without losing the contents of the
2609     textarea, so this is especially useful when composing a query with tables
2610     you first have to look in. The checkbox will get automatically checked
2611     whenever you change the contents of the textarea. Please uncheck the button
2612     whenever you definitely want the query window to get updated even though
2613     you have made alterations.
2614
2615     If :config:option:`$cfg['QueryHistoryDB']` is set to ``true`` you can
2616     specify the amount of saved history items using
2617     :config:option:`$cfg['QueryHistoryMax']`.
2618
2619     The query window also has a custom tabbed look to group the features.
2620     Using the variable :config:option:`$cfg['QueryWindowDefTab']` you can
2621     specify the default tab to be used when opening the query window. It can be
2622     set to either ``sql``, ``files``, ``history`` or ``full``.
2623
2624 .. config:option:: $cfg['BrowseMIME']
2625
2626     :type: boolean
2627     :default: true
2628
2629     Enable :ref:`transformations`.
2630
2631 .. config:option:: $cfg['MaxExactCount']
2632
2633     :type: integer
2634     :default: 0
2635
2636     For InnoDB tables, determines for how large tables phpMyAdmin should
2637     get the exact row count using ``SELECT COUNT``. If the approximate row
2638     count as returned by ``SHOW TABLE STATUS`` is smaller than this value,
2639     ``SELECT COUNT`` will be used, otherwise the approximate count will be
2640     used.
2641
2642 .. config:option:: $cfg['MaxExactCountViews']
2643
2644     :type: integer
2645     :default: 0
2646
2647     For VIEWs, since obtaining the exact count could have an impact on
2648     performance, this value is the maximum to be displayed, using a
2649     ``SELECT COUNT ... LIMIT``. Setting this to 0 bypasses any row
2650     counting.
2651
2652 .. config:option:: $cfg['NaturalOrder']
2653
2654     :type: boolean
2655     :default: true
2656
2657     Sorts database and table names according to natural order (for
2658     example, t1, t2, t10). Currently implemented in the navigation panel
2659     and in Database view, for the table list.
2660
2661 .. config:option:: $cfg['InitialSlidersState']
2662
2663     :type: string
2664     :default: ``'closed'``
2665
2666     If set to ``'closed'``, the visual sliders are initially in a closed
2667     state. A value of ``'open'`` does the reverse. To completely disable
2668     all visual sliders, use ``'disabled'``.
2669
2670 .. config:option:: $cfg['UserprefsDisallow']
2671
2672     :type: array
2673     :default: array()
2674
2675     Contains names of configuration options (keys in ``$cfg`` array) that
2676     users can't set through user preferences. For possible values, refer
2677     to :file:`libraries/config/user_preferences.forms.php`.
2678
2679 .. config:option:: $cfg['UserprefsDeveloperTab']
2680
2681     :type: boolean
2682     :default: false
2683
2684     Activates in the user preferences a tab containing options for
2685     developers of phpMyAdmin.
2686
2687 Page titles
2688 -----------
2689
2690 .. config:option:: $cfg['TitleTable']
2691
2692     :type: string
2693     :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ / @TABLE@ | @PHPMYADMIN@'``
2694
2695 .. config:option:: $cfg['TitleDatabase']
2696
2697     :type: string
2698     :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ | @PHPMYADMIN@'``
2699
2700 .. config:option:: $cfg['TitleServer']
2701
2702     :type: string
2703     :default: ``'@HTTP_HOST@ / @VSERVER@ | @PHPMYADMIN@'``
2704
2705 .. config:option:: $cfg['TitleDefault']
2706
2707     :type: string
2708     :default: ``'@HTTP_HOST@ | @PHPMYADMIN@'``
2709
2710     Allows you to specify window's title bar. You can use :ref:`faq6_27`.
2711
2712 Theme manager settings
2713 ----------------------
2714
2715 .. config:option:: $cfg['ThemePath']
2716
2717     :type: string
2718     :default: ``'./themes'``
2719
2720     If theme manager is active, use this as the path of the subdirectory
2721     containing all the themes.
2722
2723 .. config:option:: $cfg['ThemeManager']
2724
2725     :type: boolean
2726     :default: true
2727
2728     Enables user-selectable themes. See :ref:`faqthemes`.
2729
2730 .. config:option:: $cfg['ThemeDefault']
2731
2732     :type: string
2733     :default: ``'pmahomme'``
2734
2735     The default theme (a subdirectory under :config:option:`$cfg['ThemePath']`).
2736
2737 .. config:option:: $cfg['ThemePerServer']
2738
2739     :type: boolean
2740     :default: false
2741
2742     Whether to allow different theme for each server.
2743
2744 Default queries
2745 ---------------
2746
2747 .. config:option:: $cfg['DefaultQueryTable']
2748
2749     :type: string
2750     :default: ``'SELECT * FROM @TABLE@ WHERE 1'``
2751
2752 .. config:option:: $cfg['DefaultQueryDatabase']
2753
2754     :type: string
2755     :default: ``''``
2756
2757     Default queries that will be displayed in query boxes when user didn't
2758     specify any. You can use standard :ref:`faq6_27`.
2759
2760 SQL validator settings
2761 ----------------------
2762
2763 .. config:option:: $cfg['SQLValidator']
2764
2765     :type: array
2766     :default: array(...)
2767
2768
2769
2770 .. config:option:: $cfg['SQLValidator']['use']
2771
2772     :type: boolean
2773     :default: false
2774
2775     phpMyAdmin now supports use of the `Mimer SQL Validator
2776     <http://developer.mimer.com/validator/index.htm>`_ service, as originally
2777     published on `Slashdot
2778     <http://developers.slashdot.org/article.pl?sid=02/02/19/1720246>`_. For
2779     help in setting up your system to use the service, see the
2780     :ref:`faqsqlvalidator`.
2781
2782 .. config:option:: $cfg['SQLValidator']['username']
2783
2784     :type: string
2785     :default: ``''``
2786
2787 .. config:option:: $cfg['SQLValidator']['password']
2788
2789     :type: string
2790     :default: ``''``
2791
2792     The SOAP service allows you to log in with ``anonymous`` and any password,
2793     so we use those by default. Instead, if you have an account with them, you
2794     can put your login details here, and it will be used in place of the
2795     anonymous login.
2796
2797 MySQL settings
2798 --------------
2799
2800 .. config:option:: $cfg['DefaultFunctions']
2801
2802     :type: array
2803     :default: array(...)
2804
2805     Functions selected by default when inserting/changing row, Functions
2806     are defined for meta types as (FUNC\_NUMBER, FUNC\_DATE, FUNC\_CHAR,
2807     FUNC\_SPATIAL, FUNC\_UUID) and for ``first_timestamp``, which is used
2808     for first timestamp column in table.
2809
2810
2811 Developer
2812 ---------
2813
2814 .. warning::
2815
2816     These settings might have huge effect on performance or security.
2817
2818 .. config:option:: $cfg['DBG']
2819
2820     :type: array
2821     :default: array(...)
2822
2823 .. config:option:: $cfg['DBG']['sql']
2824
2825     :type: boolean
2826     :default: false
2827
2828     Enable logging queries and execution times to be
2829     displayed in the bottom of main page (right frame).
2830
2831 .. config:option:: $cfg['DBG']['demo']
2832
2833     :type: boolean
2834     :default: false
2835
2836     Enable to let server present itself as demo server.
2837     This is used for <http://demo.phpmyadmin.net/>.
2838
2839 .. config:option:: $cfg['Error_Handler']['display']
2840
2841     :type: boolean
2842     :default: false
2843
2844     Whether to display errors from PHP or not.
2845
2846 .. config:option:: $cfg['Error_Handler']['gather']
2847
2848     :type: boolean
2849     :default: false
2850
2851     Whether to gather errors from PHP or not.
2852