Translated using Weblate (Greek)
[phpmyadmin.git] / doc / config.rst
blobf728df1d0921a33ecf06627bc381ceea1f305b94
1 .. index:: config.inc.php
3 .. _config:
5 Configuration
6 =============
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`.
13 The parameters which relate to design (like colors) are placed in
14 :file:`themes/themename/layout.inc.php`. You might also want to create
15 :file:`config.footer.inc.php` and :file:`config.header.inc.php` files to add
16 your site specific code to be included on start and end of each page.
18 .. note::
20     Some distributions (eg. Debian or Ubuntu) store :file:`config.inc.php` in
21     ``/etc/phpmyadmin`` instead of within phpMyAdmin sources.
23 .. warning::
25     :term:`Mac` users should note that if you are on a version before
26     :term:`Mac OS X`, PHP does not seem to
27     like :term:`Mac` end of lines character (``\r``). So
28     ensure you choose the option that allows to use the \*nix end of line
29     character (``\n``) in your text editor before saving a script you have
30     modified.
32 Basic settings
33 --------------
35 .. config:option:: $cfg['PmaAbsoluteUri']
37     :type: string
38     :default: ``''``
40     Sets here the complete :term:`URL` (with full path) to your phpMyAdmin
41     installation's directory. E.g.
42     ``http://www.example.net/path_to_your_phpMyAdmin_directory/``.  Note also
43     that the :term:`URL` on some web servers are case–sensitive. Don’t forget
44     the trailing slash at the end.
46     Starting with version 2.3.0, it is advisable to try leaving this blank. In
47     most cases phpMyAdmin automatically detects the proper setting. Users of
48     port forwarding will need to set :config:option:`$cfg['PmaAbsoluteUri']`
49     (`more info <https://sourceforge.net/p/phpmyadmin/support-requests/795/>`_).
51     A good test is to browse a table, edit a row and save it. There should be
52     an error message if phpMyAdmin is having trouble auto–detecting the correct
53     value. If you get an error that this must be set or if the autodetect code
54     fails to detect your path, please post a bug report on our bug tracker so
55     we can improve the code.
57     .. seealso:: :ref:`faq1_40`
59 .. config:option:: $cfg['PmaNoRelation_DisableWarning']
61     :type: boolean
62     :default: false
64     Starting with version 2.3.0 phpMyAdmin offers a lot of features to
65     work with master / foreign – tables (see :config:option:`$cfg['Servers'][$i]['pmadb']`).
67     If you tried to set this
68     up and it does not work for you, have a look on the :guilabel:`Structure` page
69     of one database where you would like to use it. You will find a link
70     that will analyze why those features have been disabled.
72     If you do not want to use those features set this variable to ``true`` to
73     stop this message from appearing.
75 .. config:option:: $cfg['SuhosinDisableWarning']
77     :type: boolean
78     :default: false
80     A warning is displayed on the main page if Suhosin is detected.
82     You can set this parameter to ``true`` to stop this message from appearing.
84 .. config:option:: $cfg['McryptDisableWarning']
86     :type: boolean
87     :default: false
89     Disable the default warning that is displayed if mcrypt is missing for
90     cookie authentication.
92     You can set this parameter to ``true`` to stop this message from appearing.
94 .. config:option:: $cfg['ServerLibraryDifference_DisableWarning']
96     :type: boolean
97     :default: false
99     A warning is displayed on the main page if there is a difference
100     between the MySQL library and server version.
102     You can set this parameter to ``true`` to stop this message from appearing.
104 .. config:option:: $cfg['ReservedWordDisableWarning']
106     :type: boolean
107     :default: false
109     This warning is displayed on the Structure page of a table if one or more
110     column names match with words which are MySQL reserved.
112     If you want to turn off this warning, you can set it to ``true`` and
113     warning will no longer be displayed.
115 .. config:option:: $cfg['TranslationWarningThreshold']
117     :type: integer
118     :default: 80
120     Show warning about incomplete translations on certain threshold.
122 .. config:option:: $cfg['AllowThirdPartyFraming']
124     :type: boolean
125     :default: false
126     
127     Setting this to ``true`` allows phpMyAdmin to be included inside a frame,
128     and is a potential security hole allowing cross-frame scripting attacks or
129     clickjacking.
131 Server connection settings
132 --------------------------
134 .. config:option:: $cfg['Servers']
136     :type: array
137     :default: one server array with settings listed bellow
139     Since version 1.4.2, phpMyAdmin supports the administration of multiple
140     MySQL servers. Therefore, a :config:option:`$cfg['Servers']`-array has been
141     added which contains the login information for the different servers. The
142     first :config:option:`$cfg['Servers'][$i]['host']` contains the hostname of
143     the first server, the second :config:option:`$cfg['Servers'][$i]['host']`
144     the hostname of the second server, etc. In
145     :file:`libraries/config.default.php`, there is only one section for server
146     definition, however you can put as many as you need in
147     :file:`config.inc.php`, copy that block or needed parts (you don't have to
148     define all settings, just those you need to change).
150     .. note::
152         The :config:option:`$cfg['Servers']` array starts with
153         $cfg['Servers'][1]. Do not use $cfg['Servers'][0]. If you want more
154         than one server, just copy following section (including $i
155         incrementation) serveral times. There is no need to define full server
156         array, just define values you need to change.
159 .. config:option:: $cfg['Servers'][$i]['host']
161     :type: string
162     :default: ``'localhost'``
164     The hostname or :term:`IP` address of your $i-th MySQL-server. E.g.
165     ``localhost``.
167     Possible values are:
169     * hostname, e.g., ``'localhost'`` or ``'mydb.example.org'``
170     * IP address, e.g., ``'127.0.0.1'`` or ``'192.168.10.1'``
171     * dot - ``'.'``, i.e., use named pipes on windows systems
172     * empty - ``''``, disables this server
174 .. config:option:: $cfg['Servers'][$i]['port']
176     :type: string
177     :default: ``''``
179     The port-number of your $i-th MySQL-server. Default is 3306 (leave
180     blank).
182     .. note::
184        If you use ``localhost`` as the hostname, MySQL ignores this port number
185        and connects with the socket, so if you want to connect to a port
186        different from the default port, use ``127.0.0.1`` or the real hostname
187        in :config:option:`$cfg['Servers'][$i]['host']`.
189 .. config:option:: $cfg['Servers'][$i]['socket']
191     :type: string
192     :default: ``''``
194     The path to the socket to use. Leave blank for default. To determine
195     the correct socket, check your MySQL configuration or, using the
196     :command:`mysql` command–line client, issue the ``status`` command. Among the
197     resulting information displayed will be the socket used.
199 .. config:option:: $cfg['Servers'][$i]['ssl']
201     :type: boolean
202     :default: false
204     Whether to enable SSL for connection to MySQL server.
206 .. config:option:: $cfg['Servers'][$i]['connect_type']
208     :type: string
209     :default: ``'tcp'``
211     What type connection to use with the MySQL server. Your options are
212     ``'socket'`` and ``'tcp'``. It defaults to tcp as that is nearly guaranteed
213     to be available on all MySQL servers, while sockets are not supported on
214     some platforms. To use the socket mode, your MySQL server must be on the
215     same machine as the Web server.
217 .. config:option:: $cfg['Servers'][$i]['extension']
219     :type: string
220     :default: ``'mysqli'``
222     What php MySQL extension to use for the connection. Valid options are:
224     ``mysql``
225         The classic MySQL extension.
227     ``mysqli``
228         The improved MySQL extension. This extension became available with PHP
229         5.0.0 and is the recommended way to connect to a server running MySQL
230         4.1.x or newer.
232 .. config:option:: $cfg['Servers'][$i]['compress']
234     :type: boolean
235     :default: false
237     Whether to use a compressed protocol for the MySQL server connection
238     or not (experimental).
240 .. _controlhost:
241 .. config:option:: $cfg['Servers'][$i]['controlhost']
243     :type: string
244     :default: ``''``
246     Permits to use an alternate host to hold the configuration storage
247     data.
249 .. _controlport:
250 .. config:option:: $cfg['Servers'][$i]['controlport']
252     :type: string
253     :default: ``''``
255     Permits to use an alternate port to connect to the host that
256     holds the configuration storage.
258 .. _controluser:
259 .. config:option:: $cfg['Servers'][$i]['controluser']
261     :type: string
262     :default: ``''``
264 .. config:option:: $cfg['Servers'][$i]['controlpass']
266     :type: string
267     :default: ``''``
269     This special account is used for 2 distinct purposes: to make possible all
270     relational features (see :config:option:`$cfg['Servers'][$i]['pmadb']`) and,
271     for a MySQL server running with ``--skip-show-database``, to enable a
272     multi-user installation (:term:`HTTP` or cookie
273     authentication mode).
275     When using :term:`HTTP` or
276     cookie authentication modes (or 'config' authentication mode since phpMyAdmin
277     2.2.1), you need to supply the details of a MySQL account that has ``SELECT``
278     privilege on the *mysql.user (all columns except "Password")*, *mysql.db (all
279     columns)* and *mysql.tables\_priv (all columns except "Grantor" and
280     "Timestamp")* tables. This account is used to check what databases the user
281     will see at login.
283     .. versionchanged:: 2.2.5
284         those were called ``stduser`` and ``stdpass``
286     .. seealso:: :ref:`setup`, :ref:`authentication_modes`
288 .. config:option:: $cfg['Servers'][$i]['auth_type']
290     :type: string
291     :default: ``'cookie'``
293     Whether config or cookie or :term:`HTTP` or signon authentication should be
294     used for this server.
296     * 'config' authentication (``$auth_type = 'config'``) is the plain old
297       way: username and password are stored in :file:`config.inc.php`.
298     * 'cookie' authentication mode (``$auth_type = 'cookie'``) as
299       introduced in 2.2.3 allows you to log in as any valid MySQL user with
300       the help of cookies. Username and password are stored in cookies
301       during the session and password is deleted when it ends. This can also
302       allow you to log in in arbitrary server if :config:option:`$cfg['AllowArbitraryServer']` enabled.
303     * 'http' authentication (was
304       called 'advanced' in previous versions and can be written also as
305       'http') (``$auth_type = 'http';'``) as introduced in 1.3.0 allows you to log in as any
306       valid MySQL user via HTTP-Auth.
307     * 'signon' authentication mode (``$auth_type = 'signon'``) as
308       introduced in 2.10.0 allows you to log in from prepared PHP session
309       data or using supplied PHP script. This is useful for implementing
310       single signon from another application. Sample way how to seed session
311       is in signon example: :file:`examples/signon.php`. There is also
312       alternative example using OpenID - :file:`examples/openid.php` and example
313       for scripts based solution - :file:`examples/signon-script.php`. You need
314       to configure :config:option:`$cfg['Servers'][$i]['SignonSession']` or
315       :config:option:`$cfg['Servers'][$i]['SignonScript']` and
316       :config:option:`$cfg['Servers'][$i]['SignonURL']` to use this authentication
317       method.
319     .. seealso:: :ref:`authentication_modes`
321 .. _servers_auth_http_realm:
322 .. config:option:: $cfg['Servers'][$i]['auth_http_realm']
324     :type: string
325     :default: ``''``
327     When using auth\_type = ``http``, this field allows to define a custom
328     :term:`HTTP` Basic Auth Realm which will be displayed to the user. If not
329     explicitly specified in your configuration, a string combined of
330     "phpMyAdmin " and either :config:option:`$cfg['Servers'][$i]['verbose']` or
331     :config:option:`$cfg['Servers'][$i]['host']` will be used.
333 .. _servers_auth_swekey_config:
334 .. config:option:: $cfg['Servers'][$i]['auth_swekey_config']
336     :type: string
337     :default: ``''``
339     The name of the file containing :ref:`swekey` ids and login names for hardware
340     authentication. Leave empty to deactivate this feature.
342 .. _servers_user:
343 .. config:option:: $cfg['Servers'][$i]['user']
345     :type: string
346     :default: ``'root'``
348 .. config:option:: $cfg['Servers'][$i]['password']
350     :type: string
351     :default: ``''``
353     When using :config:option:`$cfg['Servers'][$i]['auth_type']` set to
354     'config', this is the user/password-pair which phpMyAdmin will use to
355     connect to the MySQL server. This user/password pair is not needed when
356     :term:`HTTP` or cookie authentication is used
357     and should be empty.
359 .. _servers_nopassword:
360 .. config:option:: $cfg['Servers'][$i]['nopassword']
362     :type: boolean
363     :default: false
365     Allow attempt to log in without password when a login with password
366     fails. This can be used together with http authentication, when
367     authentication is done some other way and phpMyAdmin gets user name
368     from auth and uses empty password for connecting to MySQL. Password
369     login is still tried first, but as fallback, no password method is
370     tried.
372 .. _servers_only_db:
373 .. config:option:: $cfg['Servers'][$i]['only_db']
375     :type: string or array
376     :default: ``''``
378     If set to a (an array of) database name(s), only this (these)
379     database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
380     this/these database(s) name(s) may contain MySQL wildcards characters
381     ("\_" and "%"): if you want to use literal instances of these
382     characters, escape them (I.E. use ``'my\_db'`` and not ``'my_db'``).
384     This setting is an efficient way to lower the server load since the
385     latter does not need to send MySQL requests to build the available
386     database list. But **it does not replace the privileges rules of the
387     MySQL database server**. If set, it just means only these databases
388     will be displayed but **not that all other databases can't be used.**
390     An example of using more that one database:
392     .. code-block:: php
394         $cfg['Servers'][$i]['only_db'] = array('db1', 'db2');
396     .. versionchanged:: 4.0.0
397         Previous versions permitted to specify the display order of
398         the database names via this directive.
400 .. config:option:: $cfg['Servers'][$i]['hide_db']
402     :type: string
403     :default: ``''``
405     Regular expression for hiding some databases from unprivileged users.
406     This only hides them from listing, but a user is still able to access
407     them (using, for example, the SQL query area). To limit access, use
408     the MySQL privilege system.  For example, to hide all databases
409     starting with the letter "a", use
411     .. code-block:: php
413         $cfg['Servers'][$i]['hide_db'] = '^a';
415     and to hide both "db1" and "db2" use
417     .. code-block:: php
419         $cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$';
421     More information on regular expressions can be found in the `PCRE
422     pattern syntax
423     <http://php.net/manual/en/reference.pcre.pattern.syntax.php>`_ portion
424     of the PHP reference manual.
426 .. config:option:: $cfg['Servers'][$i]['verbose']
428     :type: string
429     :default: ``''``
431     Only useful when using phpMyAdmin with multiple server entries. If
432     set, this string will be displayed instead of the hostname in the
433     pull-down menu on the main page. This can be useful if you want to
434     show only certain databases on your system, for example. For HTTP
435     auth, all non-US-ASCII characters will be stripped.
437 .. config:option:: $cfg['Servers'][$i]['pmadb']
439     :type: string
440     :default: ``''``
442     The name of the database containing the phpMyAdmin configuration
443     storage.
445     See the :ref:`linked-tables`  section in this document to see the benefits of
446     this feature, and for a quick way of creating this database and the needed
447     tables.
449     If you are the only user of this phpMyAdmin installation, you can use your
450     current database to store those special tables; in this case, just put your
451     current database name in :config:option:`$cfg['Servers'][$i]['pmadb']`. For a
452     multi-user installation, set this parameter to the name of your central
453     database containing the phpMyAdmin configuration storage.
455 .. _bookmark:
456 .. config:option:: $cfg['Servers'][$i]['bookmarktable']
458     :type: string
459     :default: ``''``
461     Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This
462     can be useful for queries you often run. To allow the usage of this
463     functionality:
465     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
466     * enter the table name in :config:option:`$cfg['Servers'][$i]['bookmarktable']`
469 .. _relation:
470 .. config:option:: $cfg['Servers'][$i]['relation']
472     :type: string
473     :default: ``''``
475     Since release 2.2.4 you can describe, in a special 'relation' table,
476     which column is a key in another table (a foreign key). phpMyAdmin
477     currently uses this to:
479     * make clickable, when you browse the master table, the data values that
480       point to the foreign table;
481     * display in an optional tool-tip the "display column" when browsing the
482       master table, if you move the mouse to a column containing a foreign
483       key (use also the 'table\_info' table); (see :ref:`faqdisplay`)
484     * in edit/insert mode, display a drop-down list of possible foreign keys
485       (key value and "display column" are shown) (see :ref:`faq6_21`)
486     * display links on the table properties page, to check referential
487       integrity (display missing foreign keys) for each described key;
488     * in query-by-example, create automatic joins (see :ref:`faq6_6`)
489     * enable you to get a :term:`PDF` schema of
490       your database (also uses the table\_coords table).
492     The keys can be numeric or character.
494     To allow the usage of this functionality:
496     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
497     * put the relation table name in :config:option:`$cfg['Servers'][$i]['relation']`
498     * now as normal user open phpMyAdmin and for each one of your tables
499       where you want to use this feature, click :guilabel:`Structure/Relation view/`
500       and choose foreign columns.
502     .. note::
504         In the current version, ``master_db`` must be the same as ``foreign_db``.
505         Those columns have been put in future development of the cross-db
506         relations.
508 .. _table_info:
509 .. config:option:: $cfg['Servers'][$i]['table_info']
511     :type: string
512     :default: ``''``
514     Since release 2.3.0 you can describe, in a special 'table\_info'
515     table, which column is to be displayed as a tool-tip when moving the
516     cursor over the corresponding key. This configuration variable will
517     hold the name of this special table. To allow the usage of this
518     functionality:
520     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
521     * put the table name in :config:option:`$cfg['Servers'][$i]['table\_info']` (e.g.
522       ``pma__table_info``)
523     * then for each table where you want to use this feature, click
524       "Structure/Relation view/Choose column to display" to choose the
525       column.
527     .. seealso:: :ref:`faqdisplay`
529 .. _table_coords:
530 .. config:option:: $cfg['Servers'][$i]['table_coords']
532     :type: string
533     :default: ``''``
535 .. config:option:: $cfg['Servers'][$i]['pdf_pages']
537     :type: string
538     :default: ``''``
540     Since release 2.3.0 you can have phpMyAdmin create :term:`PDF` pages
541     showing the relations between your tables. To do this it needs two tables
542     "pdf\_pages" (storing information about the available :term:`PDF` pages)
543     and "table\_coords" (storing coordinates where each table will be placed on
544     a :term:`PDF` schema output).  You must be using the "relation" feature.
546     To allow the usage of this functionality:
548     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
549     * put the correct table names in
550       :config:option:`$cfg['Servers'][$i]['table\_coords']` and
551       :config:option:`$cfg['Servers'][$i]['pdf\_pages']`
553     .. seealso:: :ref:`faqpdf`.
555 .. _col_com:
556 .. config:option:: $cfg['Servers'][$i]['column_info']
558     :type: string
559     :default: ``''``
561     This part requires a content update!  Since release 2.3.0 you can
562     store comments to describe each column for each table. These will then
563     be shown on the "printview".
565     Starting with release 2.5.0, comments are consequently used on the table
566     property pages and table browse view, showing up as tool-tips above the
567     column name (properties page) or embedded within the header of table in
568     browse view. They can also be shown in a table dump. Please see the
569     relevant configuration directives later on.
571     Also new in release 2.5.0 is a MIME- transformation system which is also
572     based on the following table structure. See :ref:`transformations` for
573     further information. To use the MIME- transformation system, your
574     column\_info table has to have the three new columns 'mimetype',
575     'transformation', 'transformation\_options'.
578     To allow the usage of this functionality:
580     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
581     * put the table name in :config:option:`$cfg['Servers'][$i]['column\_info']` (e.g.
582       ``pma__column_info``)
583     * to update your PRE-2.5.0 Column\_comments Table use this:  and
584       remember that the Variable in :file:`config.inc.php` has been renamed from
585       :config:option:`$cfg['Servers'][$i]['column\_comments']` to
586       :config:option:`$cfg['Servers'][$i]['column\_info']`
588       .. code-block:: mysql
590            ALTER TABLE `pma__column_comments`
591            ADD `mimetype` VARCHAR( 255 ) NOT NULL,
592            ADD `transformation` VARCHAR( 255 ) NOT NULL,
593            ADD `transformation_options` VARCHAR( 255 ) NOT NULL;
595 .. _history:
596 .. config:option:: $cfg['Servers'][$i]['history']
598     :type: string
599     :default: ``''``
601     Since release 2.5.0 you can store your :term:`SQL` history, which means all
602     queries you entered manually into the phpMyAdmin interface. If you don't
603     want to use a table-based history, you can use the JavaScript-based
604     history.
606     Using that, all your history items are deleted when closing the window.
607     Using :config:option:`$cfg['QueryHistoryMax']` you can specify an amount of
608     history items you want to have on hold. On every login, this list gets cut
609     to the maximum amount.
611     The query history is only available if JavaScript is enabled in
612     your browser.
614     To allow the usage of this functionality:
616     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
617     * put the table name in :config:option:`$cfg['Servers'][$i]['history']` (e.g.
618       ``pma__history``)
620 .. _recent:
621 .. config:option:: $cfg['Servers'][$i]['recent']
623     :type: string
624     :default: ``''``
626     Since release 3.5.0 you can show recently used tables in the
627     navigation panel. It helps you to jump across table directly, without
628     the need to select the database, and then select the table. Using
629     :config:option:`$cfg['NumRecentTables']` you can configure the maximum number
630     of recent tables shown. When you select a table from the list, it will jump to
631     the page specified in :config:option:`$cfg['NavigationTreeDefaultTabTable']`.
634     Without configuring the storage, you can still access the recently used tables,
635     but it will disappear after you logout.
637     To allow the usage of this functionality persistently:
639     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
640     * put the table name in :config:option:`$cfg['Servers'][$i]['recent']` (e.g.
641       ``pma__recent``)
643 .. _table_uiprefs:
644 .. config:option:: $cfg['Servers'][$i]['table_uiprefs']
646     :type: string
647     :default: ``''``
649     Since release 3.5.0 phpMyAdmin can be configured to remember several
650     things (sorted column :config:option:`$cfg['RememberSorting']`, column order,
651     and column visibility from a database table) for browsing tables. Without
652     configuring the storage, these features still can be used, but the values will
653     disappear after you logout.
655     To allow the usage of these functionality persistently:
657     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
658     * put the table name in :config:option:`$cfg['Servers'][$i]['table\_uiprefs']` (e.g.
659       ``pma__table_uiprefs``)
661 .. _configurablemenus:
662 .. config:option:: $cfg['Servers'][$i]['users']
664     :type: string
665     :default: ``''``
667 .. config:option:: $cfg['Servers'][$i]['usergroups']
669     :type: string
670     :default: ``''``
672     Since release 4.1.0 you can create different user groups with menu items
673     attached to them. Users can be assigned to these groups and the logged in
674     user would only see menu items configured to the usergroup he is assigned to.
675     To do this it needs two tables "usergroups" (storing allowed menu items for each
676     user group) and "users" (storing users and their assignments to user groups).
678     To allow the usage of this functionality:
680     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
681     * put the correct table names in
682       :config:option:`$cfg['Servers'][$i]['users']` (e.g. ``pma__users``) and
683       :config:option:`$cfg['Servers'][$i]['usergroups']` (e.g. ``pma__usergroups``)
685 .. _navigationhiding:
686 .. config:option:: $cfg['Servers'][$i]['navigationhiding']
688     :type: string
689     :default: ``''``
691     Since release 4.1.0 you can hide/show items in the navigation tree.
693     To allow the usage of this functionality:
695     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
696     * put the table name in :config:option:`$cfg['Servers'][$i]['navigationhiding']` (e.g.
697       ``pma__navigationhiding``)
699 .. _tracking:
700 .. config:option:: $cfg['Servers'][$i]['tracking']
702     :type: string
703     :default: ``''``
705     Since release 3.3.x a tracking mechanism is available. It helps you to
706     track every :term:`SQL` command which is
707     executed by phpMyAdmin. The mechanism supports logging of data
708     manipulation and data definition statements. After enabling it you can
709     create versions of tables.
711     The creation of a version has two effects:
713     * phpMyAdmin saves a snapshot of the table, including structure and
714       indexes.
715     * phpMyAdmin logs all commands which change the structure and/or data of
716       the table and links these commands with the version number.
718     Of course you can view the tracked changes. On the :guilabel:`Tracking`
719     page a complete report is available for every version. For the report you
720     can use filters, for example you can get a list of statements within a date
721     range. When you want to filter usernames you can enter \* for all names or
722     you enter a list of names separated by ','. In addition you can export the
723     (filtered) report to a file or to a temporary database.
725     To allow the usage of this functionality:
727     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
728     * put the table name in :config:option:`$cfg['Servers'][$i]['tracking']` (e.g.
729       ``pma__tracking``)
732 .. _tracking2:
733 .. config:option:: $cfg['Servers'][$i]['tracking_version_auto_create']
735     :type: boolean
736     :default: false
738     Whether the tracking mechanism creates versions for tables and views
739     automatically.
741     If this is set to true and you create a table or view with
743     * CREATE TABLE ...
744     * CREATE VIEW ...
746     and no version exists for it, the mechanism will create a version for
747     you automatically.
749 .. _tracking3:
750 .. config:option:: $cfg['Servers'][$i]['tracking_default_statements']
752     :type: string
753     :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'``
755     Defines the list of statements the auto-creation uses for new
756     versions.
758 .. _tracking4:
759 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_view']
761     :type: boolean
762     :default: true
764     Whether a DROP VIEW IF EXISTS statement will be added as first line to
765     the log when creating a view.
767 .. _tracking5:
768 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_table']
770     :type: boolean
771     :default: true
773     Whether a DROP TABLE IF EXISTS statement will be added as first line
774     to the log when creating a table.
776 .. _tracking6:
777 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_database']
779     :type: boolean
780     :default: true
782     Whether a DROP DATABASE IF EXISTS statement will be added as first
783     line to the log when creating a database.
785 .. _userconfig:
786 .. config:option:: $cfg['Servers'][$i]['userconfig']
788     :type: string
789     :default: ``''``
791     Since release 3.4.x phpMyAdmin allows users to set most preferences by
792     themselves and store them in the database.
794     If you don't allow for storing preferences in
795     :config:option:`$cfg['Servers'][$i]['pmadb']`, users can still personalize
796     phpMyAdmin, but settings will be saved in browser's local storage, or, it
797     is is unavailable, until the end of session.
799     To allow the usage of this functionality:
801     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
802     * put the table name in :config:option:`$cfg['Servers'][$i]['userconfig']`
806 .. _designer_coords:
807 .. config:option:: $cfg['Servers'][$i]['designer_coords']
809     :type: string
810     :default: ``''``
812     Since release 2.10.0 a Designer interface is available; it permits to
813     visually manage the relations.
815     To allow the usage of this functionality:
817     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
818     * put the table name in :config:option:`$cfg['Servers'][$i]['designer\_coords']`
819       (e.g. ``pma__designer_coords``)
823 .. config:option:: $cfg['Servers'][$i]['MaxTableUiprefs']
825     :type: integer
826     :default: 100
828     Maximum number of rows saved in
829     :config:option:`$cfg['Servers'][$i]['table_uiprefs']` table.
831     When tables are dropped or renamed,
832     :config:option:`$cfg['Servers'][$i]['table_uiprefs']` may contain invalid data
833     (referring to tables which no longer exist). We only keep this number of newest
834     rows in :config:option:`$cfg['Servers'][$i]['table_uiprefs']` and automatically
835     delete older rows.
837 .. config:option:: $cfg['Servers'][$i]['AllowRoot']
839     :type: boolean
840     :default: true
842     Whether to allow root access. This is just a shortcut for the
843     :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` below.
845 .. config:option:: $cfg['Servers'][$i]['AllowNoPassword']
847     :type: boolean
848     :default: false
850     Whether to allow logins without a password. The default value of
851     ``false`` for this parameter prevents unintended access to a MySQL
852     server with was left with an empty password for root or on which an
853     anonymous (blank) user is defined.
855 .. _servers_allowdeny_order:
856 .. config:option:: $cfg['Servers'][$i]['AllowDeny']['order']
858     :type: string
859     :default: ``''``
861     If your rule order is empty, then :term:`IP`
862     authorization is disabled.
864     If your rule order is set to
865     ``'deny,allow'`` then the system applies all deny rules followed by
866     allow rules. Access is allowed by default. Any client which does not
867     match a Deny command or does match an Allow command will be allowed
868     access to the server.
870     If your rule order is set to ``'allow,deny'``
871     then the system applies all allow rules followed by deny rules. Access
872     is denied by default. Any client which does not match an Allow
873     directive or does match a Deny directive will be denied access to the
874     server.
876     If your rule order is set to ``'explicit'``, authorization is
877     performed in a similar fashion to rule order 'deny,allow', with the
878     added restriction that your host/username combination **must** be
879     listed in the *allow* rules, and not listed in the *deny* rules. This
880     is the **most** secure means of using Allow/Deny rules, and was
881     available in Apache by specifying allow and deny rules without setting
882     any order.
884     Please also see :config:option:`$cfg['TrustedProxies']` for
885     detecting IP address behind proxies.
887 .. _servers_allowdeny_rules:
888 .. config:option:: $cfg['Servers'][$i]['AllowDeny']['rules']
890     :type: array of strings
891     :default: array()
893     The general format for the rules is as such:
895     .. code-block:: none
897         <'allow' | 'deny'> <username> [from] <ipmask>
899     If you wish to match all users, it is possible to use a ``'%'`` as a
900     wildcard in the *username* field.
902     There are a few shortcuts you can
903     use in the *ipmask* field as well (please note that those containing
904     SERVER\_ADDRESS might not be available on all webservers):
906     .. code-block:: none
909         'all' -> 0.0.0.0/0
910         'localhost' -> 127.0.0.1/8
911         'localnetA' -> SERVER_ADDRESS/8
912         'localnetB' -> SERVER_ADDRESS/16
913         'localnetC' -> SERVER_ADDRESS/24
915     Having an empty rule list is equivalent to either using ``'allow %
916     from all'`` if your rule order is set to ``'deny,allow'`` or ``'deny %
917     from all'`` if your rule order is set to ``'allow,deny'`` or
918     ``'explicit'``.
920     For the :term:`IP address` matching
921     system, the following work:
923     * ``xxx.xxx.xxx.xxx`` (an exact :term:`IP address`)
924     * ``xxx.xxx.xxx.[yyy-zzz]`` (an :term:`IP address` range)
925     * ``xxx.xxx.xxx.xxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IP` addresses)
927     But the following does not work:
929     * ``xxx.xxx.xxx.xx[yyy-zzz]`` (partial :term:`IP` address range)
931     For :term:`IPv6` addresses, the following work:
933     * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx`` (an exact :term:`IPv6` address)
934     * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:[yyyy-zzzz]`` (an :term:`IPv6` address range)
935     * ``xxxx:xxxx:xxxx:xxxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IPv6` addresses)
937     But the following does not work:
939     * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xx[yyy-zzz]`` (partial :term:`IPv6` address range)
941 .. config:option:: $cfg['Servers'][$i]['DisableIS']
943     :type: boolean
944     :default: true
946     Disable using ``INFORMATION_SCHEMA`` to retrieve information (use
947     ``SHOW`` commands instead), because of speed issues when many
948     databases are present. Currently used in some parts of the code, more
949     to come.
951 .. config:option:: $cfg['Servers'][$i]['ShowDatabasesCommand']
953     :type: string
954     :default: ``'SHOW DATABASES'``
956     On a server with a huge number of databases, the default ``SHOW DATABASES``
957     command used to fetch the name of available databases will probably be too
958     slow, so it can be replaced by faster commands. You can use ``#user#``
959     string will be replaced by current user.
961     When using ``false``, it will disable fetching databases from the server,
962     only databases in :config:option:`$cfg['Servers'][$i]['only_db']` will be
963     displayed.
965     Examples:
967     * ``'SHOW DATABASES'``
968     * ``"SHOW DATABASES LIKE '#user#\_%'"``
969     * ``'SELECT DISTINCT TABLE_SCHEMA FROM information_schema.SCHEMA_PRIVILEGES'``
970     * ``'SELECT SCHEMA_NAME FROM information_schema.SCHEMATA'``
971     * ``false``
973 .. config:option:: $cfg['Servers'][$i]['SignonScript']
975     :type: string
976     :default: ``''``
978     Name of PHP script to be sourced and executed to obtain login
979     credentials. This is alternative approach to session based single
980     signon. The script needs to provide function
981     ``get_login_credentials`` which returns list of username and
982     password, accepting single parameter of existing username (can be
983     empty). See :file:`examples/signon-script.php` for an example.
985 .. config:option:: $cfg['Servers'][$i]['SignonSession']
987     :type: string
988     :default: ``''``
990     Name of session which will be used for signon authentication method.
991     You should use something different than ``phpMyAdmin``, because this
992     is session which phpMyAdmin uses internally. Takes effect only if
993     :config:option:`$cfg['Servers'][$i]['SignonScript']` is not configured.
995 .. config:option:: $cfg['Servers'][$i]['SignonURL']
997     :type: string
998     :default: ``''``
1000     :term:`URL` where user will be redirected
1001     to log in for signon authentication method. Should be absolute
1002     including protocol.
1004 .. config:option:: $cfg['Servers'][$i]['LogoutURL']
1006     :type: string
1007     :default: ``''``
1009     :term:`URL` where user will be redirected
1010     after logout (doesn't affect config authentication method). Should be
1011     absolute including protocol.
1013 .. config:option:: $cfg['Servers'][$i]['StatusCacheDatabases']
1015     :type: array of strings
1016     :default: array()
1018     Enables caching of ``TABLE STATUS`` outputs for specific databases on
1019     this server (in some cases ``TABLE STATUS`` can be very slow, so you
1020     may want to cache it). APC is used (if the PHP extension is available,
1021     if not, this setting is ignored silently). You have to provide
1022     :config:option:`$cfg['Servers'][$i]['StatusCacheLifetime']`.
1024     Takes effect only if :config:option:`$cfg['Servers'][$i]['DisableIS']` is
1025     ``true``.
1027 .. config:option:: $cfg['Servers'][$i]['StatusCacheLifetime']
1029     :type: integer
1030     :default: 0
1032     Lifetime in seconds of the ``TABLE STATUS`` cache if
1033     :config:option:`$cfg['Servers'][$i]['StatusCacheDatabases']` is used.
1035 Generic settings
1036 ----------------
1038 .. config:option:: $cfg['ServerDefault']
1040     :type: integer
1041     :default: 1
1043     If you have more than one server configured, you can set
1044     :config:option:`$cfg['ServerDefault']` to any one of them to autoconnect to that
1045     server when phpMyAdmin is started, or set it to 0 to be given a list
1046     of servers without logging in.
1048     If you have only one server configured,
1049     :config:option:`$cfg['ServerDefault']` MUST be set to that server.
1051 .. config:option:: $cfg['VersionCheck']
1053     :type: boolean
1054     :default: true
1056     Enables check for latest versions using javascript on main phpMyAdmin
1057     page.
1059     .. note::
1061         This setting can be adjusted by your vendor.
1063 .. config:option:: $cfg['VersionCheckProxyUrl']
1065     :type: string
1066     :default: ""
1068     The url of the proxy to be used when retrieving the information about
1069     the latest version of phpMyAdmin. You need this if the server where
1070     phpMyAdmin is installed does not have direct access to the internet.
1071     The format is: "hostname:portnumber"
1073 .. config:option:: $cfg['VersionCheckProxyUser']
1075     :type: string
1076     :default: ""
1078     The username for authenticating with the proxy. By default, no
1079     authentication is performed. If a username is supplied, Basic
1080     Authentication will be performed. No other types of authentication
1081     are currently supported.
1083 .. config:option:: $cfg['VersionCheckProxyPass']
1085     :type: string
1086     :default: ""
1088     The password for authenticating with the proxy.
1090 .. config:option:: $cfg['MaxDbList']
1092     :type: integer
1093     :default: 100
1095     The maximum number of database names to be displayed in the main panel's
1096     database list.
1098 .. config:option:: $cfg['MaxNavigationItems']
1100     :type: integer
1101     :default: 25
1103     The number of items that can be displayed on each page of the
1104     navigation tree.
1106 .. config:option:: $cfg['MaxTableList']
1108     :type: integer
1109     :default: 250
1111     The maximum number of table names to be displayed in the main panel's
1112     list (except on the Export page). This limit is also enforced in the
1113     navigation panel when in Light mode.
1115 .. config:option:: $cfg['ShowHint']
1117     :type: boolean
1118     :default: true
1120     Whether or not to show hints (for example, hints when hovering over
1121     table headers).
1123 .. config:option:: $cfg['MaxCharactersInDisplayedSQL']
1125     :type: integer
1126     :default: 1000
1128     The maximum number of characters when a :term:`SQL` query is displayed. The
1129     default limit of 1000 should be correct to avoid the display of tons of
1130     hexadecimal codes that represent BLOBs, but some users have real
1131     :term:`SQL` queries that are longer than 1000 characters. Also, if a
1132     query's length exceeds this limit, this query is not saved in the history.
1134 .. config:option:: $cfg['PersistentConnections']
1136     :type: boolean
1137     :default: false
1139     Whether `persistent connections <http://php.net/manual/en/features
1140     .persistent-connections.php>`_ should be used or not. Works with
1141     following extensions:
1143     * mysql (`mysql\_pconnect <http://php.net/manual/en/function.mysql-
1144       pconnect.php>`_),
1145     * mysqli (requires PHP 5.3.0 or newer, `more information
1146       <http://php.net/manual/en/mysqli.persistconns.php>`_).
1148 .. config:option:: $cfg['ForceSSL']
1150     :type: boolean
1151     :default: false
1153     Whether to force using https while accessing phpMyAdmin.
1155 .. config:option:: $cfg['ExecTimeLimit']
1157     :type: integer [number of seconds]
1158     :default: 300
1160     Set the number of seconds a script is allowed to run. If seconds is
1161     set to zero, no time limit is imposed. This setting is used while
1162     importing/exporting dump files but has
1163     no effect when PHP is running in safe mode.
1165 .. config:option:: $cfg['SessionSavePath']
1167     :type: string
1168     :default: ``''``
1170     Path for storing session data (`session\_save\_path PHP parameter
1171     <http://php.net/session_save_path>`_).
1173 .. config:option:: $cfg['MemoryLimit']
1175     :type: string [number of bytes]
1176     :default: ``'0'``
1178     Set the number of bytes a script is allowed to allocate. If set to
1179     zero, no limit is imposed.
1181     This setting is used while importing/exporting dump files and at some other
1182     places in phpMyAdmin so you definitely don't want to put here a too low
1183     value. It has no effect when PHP is running in safe mode.
1185     You can also use any string as in :file:`php.ini`, eg. '16M'. Ensure you
1186     don't omit the suffix (16 means 16 bytes!)
1188 .. config:option:: $cfg['SkipLockedTables']
1190     :type: boolean
1191     :default: false
1193     Mark used tables and make it possible to show databases with locked
1194     tables (since MySQL 3.23.30).
1196 .. config:option:: $cfg['ShowSQL']
1198     :type: boolean
1199     :default: true
1201     Defines whether :term:`SQL` queries
1202     generated by phpMyAdmin should be displayed or not.
1204 .. config:option:: $cfg['RetainQueryBox']
1206     :type: boolean
1207     :default: false
1209     Defines whether the :term:`SQL` query box
1210     should be kept displayed after its submission.
1212 .. config:option:: $cfg['CodemirrorEnable']
1214     :type: boolean
1215     :default: true
1217     Defines whether to use a Javascript code editor for SQL query boxes.
1218     CodeMirror provides syntax highlighting and line numbers.  However,
1219     middle-clicking for pasting the clipboard contents in some Linux
1220     distributions (such as Ubuntu) is not supported by all browsers.
1222 .. config:option:: $cfg['AllowUserDropDatabase']
1224     :type: boolean
1225     :default: false
1227     Defines whether normal users (non-administrator) are allowed to delete
1228     their own database or not. If set as false, the link :guilabel:`Drop
1229     Database` will not be shown, and even a ``DROP DATABASE mydatabase`` will
1230     be rejected. Quite practical for :term:`ISP` 's with many customers.
1232     .. note::
1234         This limitation of :term:`SQL` queries is not
1235         as strict as when using MySQL privileges. This is due to nature of
1236         :term:`SQL` queries which might be quite
1237         complicated.  So this choice should be viewed as help to avoid accidental
1238         dropping rather than strict privilege limitation.
1240 .. config:option:: $cfg['Confirm']
1242     :type: boolean
1243     :default: true
1245     Whether a warning ("Are your really sure...") should be displayed when
1246     you're about to lose data.
1248 .. config:option:: $cfg['UseDbSearch']
1250     :type: boolean
1251     :default: true
1253     Define whether the "search string inside database" is enabled or not.
1255 .. config:option:: $cfg['IgnoreMultiSubmitErrors']
1257     :type: boolean
1258     :default: false
1260     Define whether phpMyAdmin will continue executing a multi-query
1261     statement if one of the queries fails. Default is to abort execution.
1263 Cookie authentication options
1264 -----------------------------
1266 .. config:option:: $cfg['blowfish_secret']
1268     :type: string
1269     :default: ``''``
1271     The "cookie" auth\_type uses blowfish algorithm to encrypt the
1272     password. If you are using the "cookie" auth\_type, enter here a
1273     random passphrase of your choice. It will be used internally by the
1274     blowfish algorithm: you won’t be prompted for this passphrase. There
1275     is no maximum length for this secret.
1277     .. versionchanged:: 3.1.0
1278         Since version 3.1.0 phpMyAdmin can generate this on the fly, but it
1279         makes a bit weaker security as this generated secret is stored in
1280         session and furthermore it makes impossible to recall user name from
1281         cookie.
1283 .. config:option:: $cfg['LoginCookieRecall']
1285     :type: boolean
1286     :default: true
1288     Define whether the previous login should be recalled or not in cookie
1289     authentication mode.
1291     This is automatically disabled if you do not have
1292     configured :config:option:`$cfg['blowfish_secret']`.
1294 .. config:option:: $cfg['LoginCookieValidity']
1296     :type: integer [number of seconds]
1297     :default: 1440
1299     Define how long a login cookie is valid. Please note that php
1300     configuration option `session.gc\_maxlifetime
1301     <http://php.net/manual/en/session.configuration.php#ini.session.gc-
1302     maxlifetime>`_ might limit session validity and if the session is lost,
1303     the login cookie is also invalidated. So it is a good idea to set
1304     ``session.gc_maxlifetime`` at least to the same value of
1305     :config:option:`$cfg['LoginCookieValidity']`.
1307 .. config:option:: $cfg['LoginCookieStore']
1309     :type: integer [number of seconds]
1310     :default: 0
1312     Define how long login cookie should be stored in browser. Default 0
1313     means that it will be kept for existing session. This is recommended
1314     for not trusted environments.
1316 .. config:option:: $cfg['LoginCookieDeleteAll']
1318     :type: boolean
1319     :default: true
1321     If enabled (default), logout deletes cookies for all servers,
1322     otherwise only for current one. Setting this to false makes it easy to
1323     forget to log out from other server, when you are using more of them.
1325 .. _AllowArbitraryServer:
1326 .. config:option:: $cfg['AllowArbitraryServer']
1328     :type: boolean
1329     :default: false
1331     If enabled, allows you to log in to arbitrary servers using cookie
1332     authentication.
1334     .. note::
1336         Please use this carefully, as this may allow users access to MySQL servers
1337         behind the firewall where your :term:`HTTP`
1338         server is placed.
1340 .. config:option:: $cfg['CaptchaLoginPublicKey']
1342     :type: string
1343     :default: ``''``
1345     The public key for the reCaptcha service that can be obtain from
1346     http://www.google.com/recaptcha.
1348     reCaptcha will be then used in :ref:`cookie`.
1350 .. config:option:: $cfg['CaptchaLoginPrivateKey']
1352     :type: string
1353     :default: ``''``
1355     The private key for the reCaptcha service that can be obtain from
1356     http://www.google.com/recaptcha.
1358     reCaptcha will be then used in :ref:`cookie`.
1360 Navigation panel setup
1361 ----------------------
1363 .. config:option:: $cfg['NavigationTreeEnableGrouping']
1365     :type: boolean
1366     :default: true
1368     Defines whether to group the databases based on a common prefix
1369     in their name :config:option:`$cfg['NavigationTreeDbSeparator']`.
1371 .. config:option:: $cfg['NavigationTreeDbSeparator']
1373     :type: string or array
1374     :default: ``'_'``
1376     The string used to separate the parts of the database name when
1377     showing them in a tree. Alternatively you can specify more strings in
1378     an array and all of them will be used as a separator.
1380 .. config:option:: $cfg['NavigationTreeTableSeparator']
1382     :type: string or array
1383     :default: ``'__'``
1385     Defines a string to be used to nest table spaces. This means if you have
1386     tables like ``first__second__third`` this will be shown as a three-level
1387     hierarchy like: first > second > third.  If set to false or empty, the
1388     feature is disabled. NOTE: You should not use this separator at the
1389     beginning or end of a table name or multiple times after another without
1390     any other characters in between.
1392 .. config:option:: $cfg['NavigationTreeTableLevel']
1394     :type: integer
1395     :default: 1
1397     Defines how many sublevels should be displayed when splitting up
1398     tables by the above separator.
1400 .. config:option:: $cfg['NumRecentTables']
1402     :type: integer
1403     :default: 10
1405     The maximum number of recently used tables shown in the navigation
1406     panel. Set this to 0 (zero) to disable the listing of recent tables.
1408 .. config:option:: $cfg['ShowTooltip']
1410     :type: boolean
1411     :default: true
1413     Defines whether to display item comments as tooltips in navigation
1414     panel or not.
1416 .. config:option:: $cfg['NavigationDisplayLogo']
1418     :type: boolean
1419     :default: true
1421     Defines whether or not to display the phpMyAdmin logo at the top of
1422     the navigation panel.
1424 .. config:option:: $cfg['NavigationLogoLink']
1426     :type: string
1427     :default: ``'index.php'``
1429     Enter :term:`URL` where logo in the
1430     navigation panel will point to. For use especially with self made
1431     theme which changes this.
1433 .. config:option:: $cfg['NavigationLogoLinkWindow']
1435     :type: string
1436     :default: ``'main'``
1438     Whether to open the linked page in the main window (``main``) or in a
1439     new one (``new``). Note: use ``new`` if you are linking to
1440     ``phpmyadmin.net``.
1442 .. config:option:: $cfg['NavigationTreeDisplayItemFilterMinimum']
1444     :type: integer
1445     :default: 30
1447     Defines the minimum number of items (tables, views, routines and
1448     events) to display a JavaScript filter box above the list of items in
1449     the navigation tree.
1451     To disable the filter completely some high number can be used (e.g. 9999)
1453 .. config:option:: $cfg['NavigationTreeDisplayDbFilterMinimum']
1455     :type: integer
1456     :default: 30
1458     Defines the minimum number of databases to display a JavaScript filter
1459     box above the list of databases in the navigation tree.
1461     To disable the filter completely some high number can be used
1462     (e.g. 9999)
1464 .. config:option:: $cfg['NavigationDisplayServers']
1466     :type: boolean
1467     :default: true
1469     Defines whether or not to display a server choice at the top of the
1470     navigation panel.
1472 .. config:option:: $cfg['DisplayServersList']
1474     :type: boolean
1475     :default: false
1477     Defines whether to display this server choice as links instead of in a
1478     drop-down.
1480 .. config:option:: $cfg['NavigationTreeDefaultTabTable']
1482     :type: string
1483     :default: ``'tbl_structure.php'``
1485     Defines the tab displayed by default when clicking the small icon next
1486     to each table name in the navigation panel. Possible values:
1488     * ``tbl_structure.php``
1489     * ``tbl_sql.php``
1490     * ``tbl_select.php``
1491     * ``tbl_change.php``
1492     * ``sql.php``
1494 Main panel
1495 ----------
1497 .. config:option:: $cfg['ShowStats']
1499     :type: boolean
1500     :default: true
1502     Defines whether or not to display space usage and statistics about
1503     databases and tables. Note that statistics requires at least MySQL
1504     3.23.3 and that, at this date, MySQL doesn't return such information
1505     for Berkeley DB tables.
1507 .. config:option:: $cfg['ShowServerInfo']
1509     :type: boolean
1510     :default: true
1512     Defines whether to display detailed server information on main page.
1513     You can additionally hide more information by using
1514     :config:option:`$cfg['Servers'][$i]['verbose']`.
1516 .. config:option:: $cfg['ShowPhpInfo']
1518     :type: boolean
1519     :default: false
1521 .. config:option:: $cfg['ShowChgPassword']
1523     :type: boolean
1524     :default: true
1526 .. config:option:: $cfg['ShowCreateDb']
1528     :type: boolean
1529     :default: true
1531     Defines whether to display the :guilabel:`PHP information` and
1532     :guilabel:`Change password` links and form for creating database or not at
1533     the starting main (right) frame. This setting does not check MySQL commands
1534     entered directly.
1536     Please note that to block the usage of ``phpinfo()`` in scripts, you have to
1537     put this in your :file:`php.ini`:
1539     .. code-block:: ini
1541         disable_functions = phpinfo()
1543     Also note that enabling the :guilabel:`Change password` link has no effect
1544     with config authentication mode: because of the hard coded password value
1545     in the configuration file, end users can't be allowed to change their
1546     passwords.
1548 Database structure
1549 ------------------
1551 .. config:option:: $cfg['ShowDbStructureCreation']
1553     :type: boolean
1554     :default: false
1556     Defines whether the database structure page (tables list) has a
1557     "Creation" column that displays when each table was created.
1559 .. config:option:: $cfg['ShowDbStructureLastUpdate']
1561     :type: boolean
1562     :default: false
1564     Defines whether the database structure page (tables list) has a "Last
1565     update" column that displays when each table was last updated.
1567 .. config:option:: $cfg['ShowDbStructureLastCheck']
1569     :type: boolean
1570     :default: false
1572     Defines whether the database structure page (tables list) has a "Last
1573     check" column that displays when each table was last checked.
1575 .. config:option:: $cfg['HideStructureActions']
1577     :type: boolean
1578     :default: true
1580     Defines whether the table structure actions are hidden under a "More"
1581     drop-down.
1583 Browse mode
1584 -----------
1586 .. config:option:: $cfg['TableNavigationLinksMode']
1588     :type: string
1589     :default: ``'icons'``
1591     Defines whether the table navigation links contain ``'icons'``, ``'text'`` 
1592     or ``'both'``. 
1594 .. config:option:: $cfg['ShowAll']
1596     :type: boolean
1597     :default: false
1599     Defines whether a user should be displayed a "Show all" button in browse
1600     mode or not in all cases. By default it is shown only on small tables (less
1601     than 500 rows) to avoid performance issues while getting too many rows.
1603 .. config:option:: $cfg['MaxRows']
1605     :type: integer
1606     :default: 25
1608     Number of rows displayed when browsing a result set and no LIMIT
1609     clause is used. If the result set contains more rows, "Previous" and
1610     "Next" links will be shown. Possible values: 25,50,100,250,500.
1612 .. config:option:: $cfg['Order']
1614     :type: string
1615     :default: ``'SMART'``
1617     Defines whether columns are displayed in ascending (``ASC``) order, in
1618     descending (``DESC``) order or in a "smart" (``SMART``) order - I.E.
1619     descending order for columns of type TIME, DATE, DATETIME and
1620     TIMESTAMP, ascending order else- by default.
1622 .. config:option:: $cfg['DisplayBinaryAsHex']
1624     :type: boolean
1625     :default: true
1627     Defines whether the "Show binary contents as HEX" browse option is
1628     ticked by default.
1630 .. config:option:: $cfg['GridEditing']
1632     :type: string
1633     :default: ``'double-click'``
1635     Defines which action (``double-click`` or ``click``) triggers grid
1636     editing. Can be deactived with the ``disabled`` value.
1638 .. config:option:: $cfg['SaveCellsAtOnce']
1640     :type: boolean
1641     :default: false
1643     Defines whether or not to save all edited cells at once for grid
1644     editing.
1646 Editing mode
1647 ------------
1649 .. config:option:: $cfg['ProtectBinary']
1651     :type: boolean or string
1652     :default: ``'blob'``
1654     Defines whether ``BLOB`` or ``BINARY`` columns are protected from
1655     editing when browsing a table's content. Valid values are:
1657     * ``false`` to allow editing of all columns;
1658     * ``'blob'`` to allow editing of all columns except ``BLOBS``;
1659     * ``'noblob'`` to disallow editing of all columns except ``BLOBS`` (the
1660       opposite of ``'blob'``);
1661     * ``'all'`` to disallow editing of all ``BINARY`` or ``BLOB`` columns.
1663 .. config:option:: $cfg['ShowFunctionFields']
1665     :type: boolean
1666     :default: true
1668     Defines whether or not MySQL functions fields should be initially
1669     displayed in edit/insert mode. Since version 2.10, the user can toggle
1670     this setting from the interface.
1672 .. config:option:: $cfg['ShowFieldTypesInDataEditView']
1674     :type: boolean
1675     :default: true
1677     Defines whether or not type fields should be initially displayed in
1678     edit/insert mode. The user can toggle this setting from the interface.
1680 .. config:option:: $cfg['InsertRows']
1682     :type: integer
1683     :default: 2
1685     Defines the maximum number of concurrent entries for the Insert page.
1687 .. config:option:: $cfg['ForeignKeyMaxLimit']
1689     :type: integer
1690     :default: 100
1692     If there are fewer items than this in the set of foreign keys, then a
1693     drop-down box of foreign keys is presented, in the style described by
1694     the :config:option:`$cfg['ForeignKeyDropdownOrder']` setting.
1696 .. config:option:: $cfg['ForeignKeyDropdownOrder']
1698     :type: array
1699     :default: array('content-id', 'id-content')
1701     For the foreign key drop-down fields, there are several methods of
1702     display, offering both the key and value data. The contents of the
1703     array should be one or both of the following strings: ``content-id``,
1704     ``id-content``.
1706 Export and import settings
1707 --------------------------
1709 .. config:option:: $cfg['ZipDump']
1711     :type: boolean
1712     :default: true
1714 .. config:option:: $cfg['GZipDump']
1716     :type: boolean
1717     :default: true
1719 .. config:option:: $cfg['BZipDump']
1721     :type: boolean
1722     :default: true
1724     Defines whether to allow the use of zip/GZip/BZip2 compression when
1725     creating a dump file
1727 .. config:option:: $cfg['CompressOnFly']
1729     :type: boolean
1730     :default: true
1732     Defines whether to allow on the fly compression for GZip/BZip2
1733     compressed exports. This doesn't affect smaller dumps and allows users
1734     to create larger dumps that won't otherwise fit in memory due to php
1735     memory limit. Produced files contain more GZip/BZip2 headers, but all
1736     normal programs handle this correctly.
1738 .. config:option:: $cfg['Export']
1740     :type: array
1741     :default: array(...)
1743     In this array are defined default parameters for export, names of
1744     items are similar to texts seen on export page, so you can easily
1745     identify what they mean.
1747 .. config:option:: $cfg['Export']['method']
1749     :type: string
1750     :default: ``'quick'``
1752     Defines how the export form is displayed when it loads. Valid values
1753     are:
1755     * ``quick`` to display the minimum number of options to configure
1756     * ``custom`` to display every available option to configure
1757     * ``custom-no-form`` same as ``custom`` but does not display the option
1758       of using quick export
1762 .. config:option:: $cfg['Import']
1764     :type: array
1765     :default: array(...)
1767     In this array are defined default parameters for import, names of
1768     items are similar to texts seen on import page, so you can easily
1769     identify what they mean.
1772 Tabs display settings
1773 ---------------------
1775 .. config:option:: $cfg['TabsMode']
1777     :type: string
1778     :default: ``'both'``
1780     Defines whether the menu tabs contain ``'icons'``, ``'text'`` or ``'both'``. 
1782 .. config:option:: $cfg['ActionLinksMode']
1784     :type: string
1785     :default: ``'both'``
1787     If set to ``icons``, will display icons instead of text for db and table
1788     properties links (like :guilabel:`Browse`, :guilabel:`Select`,
1789     :guilabel:`Insert`, ...). Can be set to ``'both'`` 
1790     if you want icons AND text. When set to ``text``, will only show text.
1792 .. config:option:: $cfg['PropertiesNumColumns']
1794     :type: integer
1795     :default: 1
1797     How many columns will be utilized to display the tables on the database
1798     property view? When setting this to a value larger than 1, the type of the
1799     database will be omitted for more display space.
1801 .. config:option:: $cfg['DefaultTabServer']
1803     :type: string
1804     :default: ``'index.php'``
1806     Defines the tab displayed by default on server view. Possible values:
1808     * ``main.php`` (recommended for multi-user setups)
1809     * ``server_databases.php``,
1810     * ``server_status.php``
1811     * ``server_variables.php``
1812     * ``server_privileges.php``
1814 .. config:option:: $cfg['DefaultTabDatabase']
1816     :type: string
1817     :default: ``'db_structure.php'``
1819     Defines the tab displayed by default on database view. Possible
1820     values:
1822     * ``db_structure.php``
1823     * ``db_sql.php``
1824     * ``db_search.php``.
1826 .. config:option:: $cfg['DefaultTabTable']
1828     :type: string
1829     :default: ``'sql.php'``
1831     Defines the tab displayed by default on table view. Possible values:
1833     * ``tbl_structure.php``
1834     * ``tbl_sql.php``
1835     * ``tbl_select.php``
1836     * ``tbl_change.php``
1837     * ``sql.php``
1839 Languages
1840 ---------
1842 .. config:option:: $cfg['DefaultLang']
1844     :type: string
1845     :default: ``'en'``
1847     Defines the default language to use, if not browser-defined or user-
1848     defined. The corresponding language file needs to be in
1849     locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
1851 .. config:option:: $cfg['DefaultConnectionCollation']
1853     :type: string
1854     :default: ``'utf8_general_ci'``
1856     Defines the default connection collation to use, if not user-defined.
1857     See the `MySQL documentation <http://dev.mysql.com/doc/mysql/en
1858     /charset-charsets.html>`_ for list of possible values. This setting is
1859     ignored when connected to Drizzle server.
1861 .. config:option:: $cfg['Lang']
1863     :type: string
1864     :default: not set
1866     Force language to use. The corresponding language file needs to be in
1867     locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
1869 .. config:option:: $cfg['FilterLanguages']
1871     :type: string
1872     :default: ``''``
1874     Limit list of available languages to those matching the given regular
1875     expression. For example if you want only Czech and English, you should
1876     set filter to ``'^(cs|en)'``.
1878 .. config:option:: $cfg['RecodingEngine']
1880     :type: string
1881     :default: ``'auto'``
1883     You can select here which functions will be used for character set
1884     conversion. Possible values are:
1886     * auto - automatically use available one (first is tested iconv, then
1887       recode)
1888     * iconv - use iconv or libiconv functions
1889     * recode - use recode\_string function
1890     * mb - use mbstring extension
1891     * none - disable encoding conversion
1893     Enabled charset conversion activates a pull-down menu in the Export
1894     and Import pages, to choose the character set when exporting a file.
1895     The default value in this menu comes from
1896     :config:option:`$cfg['Export']['charset']` and :config:option:`$cfg['Import']['charset']`.
1898 .. config:option:: $cfg['IconvExtraParams']
1900     :type: string
1901     :default: ``'//TRANSLIT'``
1903     Specify some parameters for iconv used in charset conversion. See
1904     `iconv documentation <http://www.gnu.org/software/libiconv/documentati
1905     on/libiconv/iconv_open.3.html>`_ for details. By default
1906     ``//TRANSLIT`` is used, so that invalid characters will be
1907     transliterated.
1909 .. config:option:: $cfg['AvailableCharsets']
1911     :type: array
1912     :default: array(..._
1914     Available character sets for MySQL conversion. You can add your own
1915     (any of supported by recode/iconv) or remove these which you don't
1916     use. Character sets will be shown in same order as here listed, so if
1917     you frequently use some of these move them to the top.
1919 Web server settings
1920 -------------------
1922 .. config:option:: $cfg['OBGzip']
1924     :type: string/boolean
1925     :default: ``'auto'``
1927     Defines whether to use GZip output buffering for increased speed in
1928     :term:`HTTP` transfers. Set to
1929     true/false for enabling/disabling. When set to 'auto' (string),
1930     phpMyAdmin tries to enable output buffering and will automatically
1931     disable it if your browser has some problems with buffering. IE6 with
1932     a certain patch is known to cause data corruption when having enabled
1933     buffering.
1935 .. config:option:: $cfg['TrustedProxies']
1937     :type: array
1938     :default: array()
1940     Lists proxies and HTTP headers which are trusted for
1941     :config:option:`$cfg['Servers'][$i]['AllowDeny']['order']`. This list is by
1942     default empty, you need to fill in some trusted proxy servers if you
1943     want to use rules for IP addresses behind proxy.
1945     The following example specifies that phpMyAdmin should trust a
1946     HTTP\_X\_FORWARDED\_FOR (``X -Forwarded-For``) header coming from the proxy
1947     1.2.3.4:
1949     .. code-block:: php
1951         $cfg['TrustedProxies'] = array('1.2.3.4' => 'HTTP_X_FORWARDED_FOR');
1953     The :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` directive uses the
1954     client's IP address as usual.
1956 .. config:option:: $cfg['GD2Available']
1958     :type: string
1959     :default: ``'auto'``
1961     Specifies whether GD >= 2 is available. If yes it can be used for MIME
1962     transformations. Possible values are:
1964     * auto - automatically detect
1965     * yes - GD 2 functions can be used
1966     * no - GD 2 function cannot be used
1968 .. config:option:: $cfg['CheckConfigurationPermissions']
1970     :type: boolean
1971     :default: true
1973     We normally check the permissions on the configuration file to ensure
1974     it's not world writable. However, phpMyAdmin could be installed on a
1975     NTFS filesystem mounted on a non-Windows server, in which case the
1976     permissions seems wrong but in fact cannot be detected. In this case a
1977     sysadmin would set this parameter to ``false``.
1979 .. config:option:: $cfg['LinkLengthLimit']
1981     :type: integer
1982     :default: 1000
1984     Limit for length of :term:`URL` in links.  When length would be above this
1985     limit, it is replaced by form with button. This is required as some web
1986     servers (:term:`IIS`) have problems with long :term:`URL` .
1988 .. config:option:: $cfg['CSPAllow']
1990     :type: string
1991     :default: ``''``
1993     Additional string to include in allowed script and image sources in Content
1994     Security Policy header.
1996     This can be useful when you want to include some external javascript files
1997     in :file:`config.footer.inc.php` or :file:`config.header.inc.php`, which
1998     would be normally not allowed by Content Security Policy.
2000     To allow some sites, just list them within the string:
2002     .. code-block:: php
2004         $cfg['CSPAllow'] = 'example.com example.net';
2006     .. versionadded:: 4.0.4
2008 .. config:option:: $cfg['DisableMultiTableMaintenance']
2010     :type: boolean
2011     :default: false
2013     In the database Structure page, it's possible to mark some tables then
2014     choose an operation like optimizing for many tables. This can slow
2015     down a server; therefore, setting this to ``true`` prevents this kind
2016     of multiple maintenance operation.
2018 Theme settings
2019 --------------
2021 .. config:option:: $cfg['NaviWidth']
2023     :type: integer
2024     :default:
2026     Navigation panel width in pixels. See
2027     :file:`themes/themename/layout.inc.php`.
2029 .. config:option:: $cfg['NaviBackground']
2031     :type: string [CSS color for background]
2032     :default:
2034 .. config:option:: $cfg['MainBackground']
2036     :type: string [CSS color for background]
2037     :default:
2039     The background styles used for both the frames. See
2040     :file:`themes/themename/layout.inc.php`.
2042 .. config:option:: $cfg['NaviPointerBackground']
2044     :type: string [CSS color for background]
2045     :default:
2047 .. config:option:: $cfg['NaviPointerColor']
2049     :type: string [CSS color]
2050     :default:
2052     The style used for the pointer in the navigation panel. See
2053     :file:`themes/themename/layout.inc.php`.
2055 .. config:option:: $cfg['Border']
2057     :type: integer
2058     :default:
2060     The size of a table's border. See :file:`themes/themename/layout.inc.php`.
2062 .. config:option:: $cfg['ThBackground']
2064     :type: string [CSS color for background]
2065     :default:
2067 .. config:option:: $cfg['ThColor']
2069     :type: string [CSS color]
2070     :default:
2072     The style used for table headers. See
2073     :file:`themes/themename/layout.inc.php`.
2075 .. _cfg_BgcolorOne:
2076 .. config:option:: $cfg['BgOne']
2078     :type: string [CSS color]
2079     :default:
2081     The color (HTML) #1 for table rows. See
2082     :file:`themes/themename/layout.inc.php`.
2084 .. _cfg_BgcolorTwo:
2085 .. config:option:: $cfg['BgTwo']
2087     :type: string [CSS color]
2088     :default:
2090     The color (HTML) #2 for table rows. See
2091     :file:`themes/themename/layout.inc.php`.
2093 .. config:option:: $cfg['BrowsePointerBackground']
2095     :type: string [CSS color]
2096     :default:
2098 .. config:option:: $cfg['BrowsePointerColor']
2100     :type: string [CSS color]
2101     :default:
2103 .. config:option:: $cfg['BrowseMarkerBackground']
2105     :type: string [CSS color]
2106     :default:
2108 .. config:option:: $cfg['BrowseMarkerColor']
2110     :type: string [CSS color]
2111     :default:
2113     The colors (HTML) uses for the pointer and the marker in browse mode.
2114     The former feature highlights the row over which your mouse is passing
2115     and the latter lets you visually mark/unmark rows by clicking on the
2116     corresponding checkbox. Highlighting / marking a column is done by
2117     hovering over / clicking the column's header (outside of the text).
2118     See :file:`themes/themename/layout.inc.php`.
2120 .. config:option:: $cfg['FontFamily']
2122     :type: string
2123     :default:
2125     You put here a valid CSS font family value, for example ``arial, sans-
2126     serif``. See :file:`themes/themename/layout.inc.php`.
2128 .. config:option:: $cfg['FontFamilyFixed']
2130     :type: string
2131     :default:
2133     You put here a valid CSS font family value, for example ``monospace``.
2134     This one is used in textarea. See :file:`themes/themename/layout.inc.php`.
2136 Design customization
2137 --------------------
2139 .. config:option:: $cfg['NavigationTreePointerEnable']
2141     :type: boolean
2142     :default: true
2144     A value of ``true`` activates the navi pointer.
2146 .. config:option:: $cfg['BrowsePointerEnable']
2148     :type: boolean
2149     :default: true
2151     Whether to activate the browse pointer or not.
2153 .. config:option:: $cfg['BrowseMarkerEnable']
2155     :type: boolean
2156     :default: true
2158     Whether to activate the browse marker or not.
2160 .. config:option:: $cfg['LimitChars']
2162     :type: integer
2163     :default: 50
2165     Maximum number of characters shown in any non-numeric field on browse
2166     view. Can be turned off by a toggle button on the browse page.
2168 .. config:option:: $cfg['RowActionLinks']
2170     :type: string
2171     :default: ``'left'``
2173     Defines the place where table row links (Edit, Copy, Delete) would be
2174     put when tables contents are displayed (you may have them displayed at
2175     the left side, right side, both sides or nowhere). "left" and "right"
2176     are parsed as "top" and "bottom" with vertical display mode.
2178 .. config:option:: $cfg['DefaultDisplay']
2180     :type: string
2181     :default: ``'horizonta'``
2183     There are 3 display modes: horizontal, horizontalflipped and vertical.
2184     Define which one is displayed by default. The first mode displays each
2185     row on a horizontal line, the second rotates the headers by 90
2186     degrees, so you can use descriptive headers even though columns only
2187     contain small values and still print them out. The vertical mode sorts
2188     each row on a vertical lineup.
2190 .. config:option:: $cfg['RememberSorting']
2192     :type: boolean
2193     :default: true
2195     If enabled, remember the sorting of each table when browsing them.
2197 .. config:option:: $cfg['HeaderFlipType']
2199     :type: string
2200     :default: ``'auto'``
2202     The HeaderFlipType can be set to 'auto', 'css' or 'fake'. When using
2203     'css' the rotation of the header for horizontalflipped is done via
2204     CSS. The CSS transformation currently works only in Internet
2205     Explorer.If set to 'fake' PHP does the transformation for you, but of
2206     course this does not look as good as CSS. The 'auto' option enables
2207     CSS transformation when browser supports it and use PHP based one
2208     otherwise.
2210 .. config:option:: $cfg['ShowBrowseComments']
2212     :type: boolean
2213     :default: true
2215 .. config:option:: $cfg['ShowPropertyComments']
2217     :type: boolean
2218     :default: true
2220     By setting the corresponding variable to ``true`` you can enable the
2221     display of column comments in Browse or Property display. In browse
2222     mode, the comments are shown inside the header. In property mode,
2223     comments are displayed using a CSS-formatted dashed-line below the
2224     name of the column. The comment is shown as a tool-tip for that
2225     column.
2227 Text fields
2228 -----------
2230 .. config:option:: $cfg['CharEditing']
2232     :type: string
2233     :default: ``'input'``
2235     Defines which type of editing controls should be used for CHAR and
2236     VARCHAR columns. Possible values are:
2238     * input - this allows to limit size of text to size of columns in MySQL,
2239       but has problems with newlines in columns
2240     * textarea - no problems with newlines in columns, but also no length
2241       limitations
2243 .. config:option:: $cfg['MinSizeForInputField']
2245     :type: integer
2246     :default: 4
2248     Defines the minimum size for input fields generated for CHAR and
2249     VARCHAR columns.
2251 .. config:option:: $cfg['MaxSizeForInputField']
2253     :type: integer
2254     :default: 60
2256     Defines the maximum size for input fields generated for CHAR and
2257     VARCHAR columns.
2259 .. config:option:: $cfg['TextareaCols']
2261     :type: integer
2262     :default: 40
2264 .. config:option:: $cfg['TextareaRows']
2266     :type: integer
2267     :default: 15
2269 .. config:option:: $cfg['CharTextareaCols']
2271     :type: integer
2272     :default: 40
2274 .. config:option:: $cfg['CharTextareaRows']
2276     :type: integer
2277     :default: 2
2279     Number of columns and rows for the textareas. This value will be
2280     emphasized (\*2) for :term:`SQL` query
2281     textareas and (\*1.25) for :term:`SQL`
2282     textareas inside the query window.
2284     The Char\* values are used for CHAR
2285     and VARCHAR editing (if configured via :config:option:`$cfg['CharEditing']`).
2287 .. config:option:: $cfg['LongtextDoubleTextarea']
2289     :type: boolean
2290     :default: true
2292     Defines whether textarea for LONGTEXT columns should have double size.
2294 .. config:option:: $cfg['TextareaAutoSelect']
2296     :type: boolean
2297     :default: false
2299     Defines if the whole textarea of the query box will be selected on
2300     click.
2303 SQL query box settings
2304 ----------------------
2306 .. config:option:: $cfg['SQLQuery']['Edit']
2308     :type: boolean
2309     :default: true
2311     Whether to display an edit link to change a query in any SQL Query
2312     box.
2314 .. config:option:: $cfg['SQLQuery']['Explain']
2316     :type: boolean
2317     :default: true
2319     Whether to display a link to explain a SELECT query in any SQL Query
2320     box.
2322 .. config:option:: $cfg['SQLQuery']['ShowAsPHP']
2324     :type: boolean
2325     :default: true
2327     Whether to display a link to wrap a query in PHP code in any SQL Query
2328     box.
2330 .. config:option:: $cfg['SQLQuery']['Validate']
2332     :type: boolean
2333     :default: false
2335     Whether to display a link to validate a query in any SQL Query box.
2337     .. seealso:: :config:option:`$cfg['SQLValidator']`
2339 .. config:option:: $cfg['SQLQuery']['Refresh']
2341     :type: boolean
2342     :default: true
2344     Whether to display a link to refresh a query in any SQL Query box.
2346 Web server upload/save/import directories
2347 -----------------------------------------
2349 .. config:option:: $cfg['UploadDir']
2351     :type: string
2352     :default: ``''``
2354     The name of the directory where :term:`SQL` files have been uploaded by
2355     other means than phpMyAdmin (for example, ftp). Those files are available
2356     under a drop-down box when you click the database or table name, then the
2357     Import tab.
2359     If
2360     you want different directory for each user, %u will be replaced with
2361     username.
2363     Please note that the file names must have the suffix ".sql"
2364     (or ".sql.bz2" or ".sql.gz" if support for compressed formats is
2365     enabled).
2367     This feature is useful when your file is too big to be
2368     uploaded via :term:`HTTP`, or when file
2369     uploads are disabled in PHP.
2371     .. note::
2373         If PHP is running in safe mode, this directory must be owned by the same
2374         user as the owner of the phpMyAdmin scripts.  See also :ref:`faq1_16` for
2375         alternatives.
2377 .. config:option:: $cfg['SaveDir']
2379     :type: string
2380     :default: ``''``
2382     The name of the directory where dumps can be saved.
2384     If you want different directory for each user, %u will be replaced with
2385     username.
2387     Please note that the directory must exist and has to be writable for
2388     the user running webserver.
2390     .. note::
2392         If PHP is running in safe mode, this directory must be owned by the same
2393         user as the owner of the phpMyAdmin scripts.
2395 .. config:option:: $cfg['TempDir']
2397     :type: string
2398     :default: ``''``
2400     The name of the directory where temporary files can be stored.
2402     This is needed for importing ESRI Shapefiles, see :ref:`faq6_30` and to
2403     work around limitations of ``open_basedir`` for uploaded files, see
2404     :ref:`faq1_11`.
2406     If the directory where phpMyAdmin is installed is
2407     subject to an ``open_basedir`` restriction, you need to create a
2408     temporary directory in some directory accessible by the web server.
2409     However for security reasons, this directory should be outside the
2410     tree published by webserver. If you cannot avoid having this directory
2411     published by webserver, place at least an empty :file:`index.html` file
2412     there, so that directory listing is not possible.
2414     This directory should have as strict permissions as possible as the only
2415     user required to access this directory is the one who runs the webserver.
2416     If you have root privileges, simply make this user owner of this directory
2417     and make it accessible only by it:
2419     .. code-block:: sh
2422         chown www-data:www-data tmp
2423         chmod 700 tmp
2425     If you cannot change owner of the directory, you can achieve a similar
2426     setup using :term:`ACL`:
2428     .. code-block:: sh
2430         chmod 700 tmp
2431         setfacl -m "g:www-data:rwx" tmp
2432         setfacl -d -m "g:www-data:rwx" tmp
2434     If neither of above works for you, you can still make the directory
2435     :command:`chmod 777`, but it might impose risk of other users on system
2436     reading and writing data in this directory.
2438 Various display setting
2439 -----------------------
2441 .. config:option:: $cfg['ShowDisplayDirection']
2443     :type: boolean
2444     :default: false
2446     Defines whether or not type display direction option is shown when
2447     browsing a table.
2449 .. config:option:: $cfg['RepeatCells']
2451     :type: integer
2452     :default: 100
2454     Repeat the headers every X cells, or 0 to deactivate.
2456 .. config:option:: $cfg['EditInWindow']
2458     :type: boolean
2459     :default: true
2461 .. config:option:: $cfg['QueryWindowWidth']
2463     :type: integer
2464     :default: 550
2466 .. config:option:: $cfg['QueryWindowHeight']
2468     :type: integer
2469     :default: 310
2471 .. config:option:: $cfg['QueryHistoryDB']
2473     :type: boolean
2474     :default: false
2476 .. config:option:: $cfg['QueryWindowDefTab']
2478     :type: string
2479     :default: ``'sql'``
2481 .. config:option:: $cfg['QueryHistoryMax']
2483     :type: integer
2484     :default: 25
2486     All those variables affect the query window feature. A :term:`SQL` link or
2487     icon is always displayed in the navigation panel. If JavaScript is enabled
2488     in your browser, a click on this opens a distinct query window, which is a
2489     direct interface to enter :term:`SQL` queries. Otherwise, the right panel
2490     changes to display a query box.
2492     The size of this query window can be customized with
2493     :config:option:`$cfg['QueryWindowWidth']` and
2494     :config:option:`$cfg['QueryWindowHeight']` - both integers for the size in
2495     pixels.  Note that normally, those parameters will be modified in
2496     :file:`layout.inc.php`` for the theme you are using.
2498     If :config:option:`$cfg['EditInWindow']` is set to true, a click on [Edit]
2499     from the results page (in the :guilabel:`Showing Rows` section) opens the
2500     query window and puts the current query inside it. If set to false,
2501     clicking on the link puts the :term:`SQL` query
2502     in the right panel's query box.
2504     If :config:option:`$cfg['QueryHistoryDB']` is set to ``true``, all your
2505     Queries are logged to a table, which has to be created by you (see
2506     :config:option:`$cfg['Servers'][$i]['history']`). If set to false, all your
2507     queries will be appended to the form, but only as long as your window is
2508     opened they remain saved.
2510     When using the JavaScript based query window, it will always get updated
2511     when you click on a new table/db to browse and will focus if you click on
2512     :guilabel:`Edit SQL` after using a query. You can suppress updating the
2513     query window by checking the box :guilabel:`Do not overwrite this query
2514     from outside the window` below the query textarea. Then you can browse
2515     tables/databases in the background without losing the contents of the
2516     textarea, so this is especially useful when composing a query with tables
2517     you first have to look in. The checkbox will get automatically checked
2518     whenever you change the contents of the textarea. Please uncheck the button
2519     whenever you definitely want the query window to get updated even though
2520     you have made alterations.
2522     If :config:option:`$cfg['QueryHistoryDB']` is set to ``true`` you can
2523     specify the amount of saved history items using
2524     :config:option:`$cfg['QueryHistoryMax']`.
2526     The query window also has a custom tabbed look to group the features.
2527     Using the variable :config:option:`$cfg['QueryWindowDefTab']` you can
2528     specify the default tab to be used when opening the query window. It can be
2529     set to either ``sql``, ``files``, ``history`` or ``full``.
2531 .. config:option:: $cfg['BrowseMIME']
2533     :type: boolean
2534     :default: true
2536     Enable :ref:`transformations`.
2538 .. config:option:: $cfg['MaxExactCount']
2540     :type: integer
2541     :default: 0
2543     For InnoDB tables, determines for how large tables phpMyAdmin should
2544     get the exact row count using ``SELECT COUNT``. If the approximate row
2545     count as returned by ``SHOW TABLE STATUS`` is smaller than this value,
2546     ``SELECT COUNT`` will be used, otherwise the approximate count will be
2547     used.
2549 .. config:option:: $cfg['MaxExactCountViews']
2551     :type: integer
2552     :default: 0
2554     For VIEWs, since obtaining the exact count could have an impact on
2555     performance, this value is the maximum to be displayed, using a
2556     ``SELECT COUNT ... LIMIT``. Setting this to 0 bypasses any row
2557     counting.
2559 .. config:option:: $cfg['NaturalOrder']
2561     :type: boolean
2562     :default: true
2564     Sorts database and table names according to natural order (for
2565     example, t1, t2, t10). Currently implemented in the navigation panel
2566     and in Database view, for the table list.
2568 .. config:option:: $cfg['InitialSlidersState']
2570     :type: string
2571     :default: ``'closed'``
2573     If set to ``'closed'``, the visual sliders are initially in a closed
2574     state. A value of ``'open'`` does the reverse. To completely disable
2575     all visual sliders, use ``'disabled'``.
2577 .. config:option:: $cfg['UserprefsDisallow']
2579     :type: array
2580     :default: array()
2582     Contains names of configuration options (keys in ``$cfg`` array) that
2583     users can't set through user preferences. For possible values, refer
2584     to :file:`libraries/config/user_preferences.forms.php`.
2586 .. config:option:: $cfg['UserprefsDeveloperTab']
2588     :type: boolean
2589     :default: false
2591     Activates in the user preferences a tab containing options for
2592     developers of phpMyAdmin.
2594 Page titles
2595 -----------
2597 .. config:option:: $cfg['TitleTable']
2599     :type: string
2600     :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ / @TABLE@ | @PHPMYADMIN@'``
2602 .. config:option:: $cfg['TitleDatabase']
2604     :type: string
2605     :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ | @PHPMYADMIN@'``
2607 .. config:option:: $cfg['TitleServer']
2609     :type: string
2610     :default: ``'@HTTP_HOST@ / @VSERVER@ | @PHPMYADMIN@'``
2612 .. config:option:: $cfg['TitleDefault']
2614     :type: string
2615     :default: ``'@HTTP_HOST@ | @PHPMYADMIN@'``
2617     Allows you to specify window's title bar. You can use :ref:`faq6_27`.
2619 Theme manager settings
2620 ----------------------
2622 .. config:option:: $cfg['ThemePath']
2624     :type: string
2625     :default: ``'./themes'``
2627     If theme manager is active, use this as the path of the subdirectory
2628     containing all the themes.
2630 .. config:option:: $cfg['ThemeManager']
2632     :type: boolean
2633     :default: true
2635     Enables user-selectable themes. See :ref:`faqthemes`.
2637 .. config:option:: $cfg['ThemeDefault']
2639     :type: string
2640     :default: ``'pmahomme'``
2642     The default theme (a subdirectory under :config:option:`$cfg['ThemePath']`).
2644 .. config:option:: $cfg['ThemePerServer']
2646     :type: boolean
2647     :default: false
2649     Whether to allow different theme for each server.
2651 Default queries
2652 ---------------
2654 .. config:option:: $cfg['DefaultQueryTable']
2656     :type: string
2657     :default: ``'SELECT * FROM @TABLE@ WHERE 1'``
2659 .. config:option:: $cfg['DefaultQueryDatabase']
2661     :type: string
2662     :default: ``''``
2664     Default queries that will be displayed in query boxes when user didn't
2665     specify any. You can use standard :ref:`faq6_27`.
2667 SQL validator settings
2668 ----------------------
2670 .. config:option:: $cfg['SQLValidator']
2672     :type: array
2673     :default: array(...)
2677 .. config:option:: $cfg['SQLValidator']['use']
2679     :type: boolean
2680     :default: false
2682     phpMyAdmin now supports use of the `Mimer SQL Validator
2683     <http://developer.mimer.com/validator/index.htm>`_ service, as originally
2684     published on `Slashdot
2685     <http://developers.slashdot.org/article.pl?sid=02/02/19/1720246>`_. For
2686     help in setting up your system to use the service, see the
2687     :ref:`faqsqlvalidator`.
2689 .. config:option:: $cfg['SQLValidator']['username']
2691     :type: string
2692     :default: ``''``
2694 .. config:option:: $cfg['SQLValidator']['password']
2696     :type: string
2697     :default: ``''``
2699     The SOAP service allows you to log in with ``anonymous`` and any password,
2700     so we use those by default. Instead, if you have an account with them, you
2701     can put your login details here, and it will be used in place of the
2702     anonymous login.
2704 MySQL settings
2705 --------------
2707 .. config:option:: $cfg['DefaultFunctions']
2709     :type: array
2710     :default: array(...)
2712     Functions selected by default when inserting/changing row, Functions
2713     are defined for meta types as (FUNC\_NUMBER, FUNC\_DATE, FUNC\_CHAR,
2714     FUNC\_SPATIAL, FUNC\_UUID) and for ``first_timestamp``, which is used
2715     for first timestamp column in table.
2718 Developer
2719 ---------
2721 .. warning::
2723     These settings might have huge effect on performance or security.
2725 .. config:option:: $cfg['DBG']
2727     :type: array
2728     :default: array(...)
2730 .. config:option:: $cfg['DBG']['sql']
2732     :type: boolean
2733     :default: false
2735     Enable logging queries and execution times to be
2736     displayed in the bottom of main page (right frame).
2738 .. config:option:: $cfg['DBG']['demo']
2740     :type: boolean
2741     :default: false
2743     Enable to let server present itself as demo server.
2744     This is used for <http://demo.phpmyadmin.net/>.
2746 .. config:option:: $cfg['Error_Handler']['display']
2748     :type: boolean
2749     :default: false
2751     Whether to display errors from PHP or not.
2753 .. config:option:: $cfg['Error_Handler']['gather']
2755     :type: boolean
2756     :default: false
2758     Whether to gather errors from PHP or not.