phpmyadmin/doc/html/_sources/config.txt

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