doc/config.rst

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