updated acknowledgments
[openemr.git] / phpmyadmin / doc / config.rst
blob76d51754e411284940d433144c949e35261511d2
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 If a directive is missing from your file, you can just add another line with
14 the file. This file is for over-writing the defaults; if you wish to use the
15 default value there's no need to add a line here.
17 The parameters which relate to design (like colors) are placed in
18 :file:`themes/themename/layout.inc.php`. You might also want to create
19 :file:`config.footer.inc.php` and :file:`config.header.inc.php` files to add
20 your site specific code to be included on start and end of each page.
22 .. note::
24     Some distributions (eg. Debian or Ubuntu) store :file:`config.inc.php` in
25     ``/etc/phpmyadmin`` instead of within phpMyAdmin sources.
27 .. warning::
29     :term:`Mac` users should note that if you are on a version before
30     :term:`Mac OS X`, PHP does not seem to
31     like :term:`Mac` end of lines character (``\r``). So
32     ensure you choose the option that allows to use the \*nix end of line
33     character (``\n``) in your text editor before saving a script you have
34     modified.
36 Basic settings
37 --------------
39 .. config:option:: $cfg['PmaAbsoluteUri']
41     :type: string
42     :default: ``''``
44     Sets here the complete :term:`URL` (with full path) to your phpMyAdmin
45     installation's directory. E.g.
46     ``http://www.example.net/path_to_your_phpMyAdmin_directory/``.  Note also
47     that the :term:`URL` on most of web servers are case–sensitive. Don’t
48     forget the trailing slash at the end.
50     Starting with version 2.3.0, it is advisable to try leaving this blank. In
51     most cases phpMyAdmin automatically detects the proper setting. Users of
52     port forwarding will need to set :config:option:`$cfg['PmaAbsoluteUri']`
53     (`more info <https://sourceforge.net/p/phpmyadmin/support-requests/795/>`_).
55     A good test is to browse a table, edit a row and save it. There should be
56     an error message if phpMyAdmin is having trouble auto–detecting the correct
57     value. If you get an error that this must be set or if the autodetect code
58     fails to detect your path, please post a bug report on our bug tracker so
59     we can improve the code.
61     .. seealso:: :ref:`faq1_40`
63 .. config:option:: $cfg['PmaNoRelation_DisableWarning']
65     :type: boolean
66     :default: false
68     Starting with version 2.3.0 phpMyAdmin offers a lot of features to
69     work with master / foreign – tables (see :config:option:`$cfg['Servers'][$i]['pmadb']`).
71     If you tried to set this
72     up and it does not work for you, have a look on the :guilabel:`Structure` page
73     of one database where you would like to use it. You will find a link
74     that will analyze why those features have been disabled.
76     If you do not want to use those features set this variable to ``true`` to
77     stop this message from appearing.
79 .. config:option:: $cfg['SuhosinDisableWarning']
81     :type: boolean
82     :default: false
84     A warning is displayed on the main page if Suhosin is detected.
86     You can set this parameter to ``true`` to stop this message from appearing.
88 .. config:option:: $cfg['LoginCookieValidityDisableWarning']
90     :type: boolean
91     :default: false
93     A warning is displayed on the main page if the PHP parameter
94     session.gc_maxlifetime is lower than cookie validity configured in phpMyAdmin.
96     You can set this parameter to ``true`` to stop this message from appearing.
98 .. config:option:: $cfg['ServerLibraryDifference_DisableWarning']
100     :type: boolean
101     :default: false
103     A warning is displayed on the main page if there is a difference
104     between the MySQL library and server version.
106     You can set this parameter to ``true`` to stop this message from appearing.
108 .. config:option:: $cfg['ReservedWordDisableWarning']
110     :type: boolean
111     :default: false
113     This warning is displayed on the Structure page of a table if one or more
114     column names match with words which are MySQL reserved.
116     If you want to turn off this warning, you can set it to ``true`` and
117     warning will no longer be displayed.
119 .. config:option:: $cfg['TranslationWarningThreshold']
121     :type: integer
122     :default: 80
124     Show warning about incomplete translations on certain threshold.
126 .. config:option:: $cfg['SendErrorReports']
128     :type: string
129     :default: ``'ask'``
131     Sets the default behavior for JavaScript error reporting.
133     Whenever an error is detected in the JavaScript execution, an error report
134     may be sent to the phpMyAdmin team if the user agrees.
136     The default setting of ``'ask'`` will ask the user everytime there is a new
137     error report. However you can set this parameter to ``'always'`` to send error
138     reports without asking for confirmation or you can set it to ``'never'`` to
139     never send error reports.
141     This directive is available both in the configuration file and in users
142     preferences. If the person in charge of a multi-user installation prefers
143     to disable this feature for all users, a value of ``'never'`` should be
144     set, and the :config:option:`$cfg['UserprefsDisallow']` directive should
145     contain ``'SendErrorReports'`` in one of its array values.
147 .. config:option:: $cfg['ConsoleEnterExecutes']
149     :type: boolean
150     :default: false
152     Setting this to ``true`` allows the user to execute queries by pressing Enter
153     instead of Ctrl+Enter. A new line can be inserted by pressing Shift + Enter.
155     The behaviour of the console can be temporarily changed using console's
156     settings interface.
158 .. config:option:: $cfg['AllowThirdPartyFraming']
160     :type: boolean
161     :default: false
163     Setting this to ``true`` allows phpMyAdmin to be included inside a frame,
164     and is a potential security hole allowing cross-frame scripting attacks or
165     clickjacking.
167 Server connection settings
168 --------------------------
170 .. config:option:: $cfg['Servers']
172     :type: array
173     :default: one server array with settings listed below
175     Since version 1.4.2, phpMyAdmin supports the administration of multiple
176     MySQL servers. Therefore, a :config:option:`$cfg['Servers']`-array has been
177     added which contains the login information for the different servers. The
178     first :config:option:`$cfg['Servers'][$i]['host']` contains the hostname of
179     the first server, the second :config:option:`$cfg['Servers'][$i]['host']`
180     the hostname of the second server, etc. In
181     :file:`libraries/config.default.php`, there is only one section for server
182     definition, however you can put as many as you need in
183     :file:`config.inc.php`, copy that block or needed parts (you don't have to
184     define all settings, just those you need to change).
186     .. note::
188         The :config:option:`$cfg['Servers']` array starts with
189         $cfg['Servers'][1]. Do not use $cfg['Servers'][0]. If you want more
190         than one server, just copy following section (including $i
191         incrementation) serveral times. There is no need to define full server
192         array, just define values you need to change.
195 .. config:option:: $cfg['Servers'][$i]['host']
197     :type: string
198     :default: ``'localhost'``
200     The hostname or :term:`IP` address of your $i-th MySQL-server. E.g.
201     ``localhost``.
203     Possible values are:
205     * hostname, e.g., ``'localhost'`` or ``'mydb.example.org'``
206     * IP address, e.g., ``'127.0.0.1'`` or ``'192.168.10.1'``
207     * dot - ``'.'``, i.e., use named pipes on windows systems
208     * empty - ``''``, disables this server
210     .. note::
212         phpMyAdmin supports connecting to MySQL servers reachable via IPv6 only.
213                 To connect to an IPv6 MySQL server, enter its IPv6 address in this field.
215 .. config:option:: $cfg['Servers'][$i]['port']
217     :type: string
218     :default: ``''``
220     The port-number of your $i-th MySQL-server. Default is 3306 (leave
221     blank).
223     .. note::
225        If you use ``localhost`` as the hostname, MySQL ignores this port number
226        and connects with the socket, so if you want to connect to a port
227        different from the default port, use ``127.0.0.1`` or the real hostname
228        in :config:option:`$cfg['Servers'][$i]['host']`.
230 .. config:option:: $cfg['Servers'][$i]['socket']
232     :type: string
233     :default: ``''``
235     The path to the socket to use. Leave blank for default. To determine
236     the correct socket, check your MySQL configuration or, using the
237     :command:`mysql` command–line client, issue the ``status`` command. Among the
238     resulting information displayed will be the socket used.
240 .. config:option:: $cfg['Servers'][$i]['ssl']
242     :type: boolean
243     :default: false
245     Whether to enable SSL for the connection between phpMyAdmin and the MySQL server.
247     When using the ``'mysql'`` extension,
248     none of the remaining ``'ssl...'`` configuration options apply.
250     We strongly recommend the ``'mysqli'`` extension when using this option.
252 .. config:option:: $cfg['Servers'][$i]['ssl_key']
254     :type: string
255     :default: NULL
257     Path to the key file when using SSL for connecting to the MySQL server.
259     For example:
261     .. code-block:: php
263         $cfg['Servers'][$i]['ssl_key'] = '/etc/mysql/server-key.pem';
265 .. config:option:: $cfg['Servers'][$i]['ssl_cert']
267     :type: string
268     :default: NULL
270     Path to the cert file when using SSL for connecting to the MySQL server.
272 .. config:option:: $cfg['Servers'][$i]['ssl_ca']
274     :type: string
275     :default: NULL
277     Path to the CA file when using SSL for connecting to the MySQL server.
279 .. config:option:: $cfg['Servers'][$i]['ssl_ca_path']
281     :type: string
282     :default: NULL
284     Directory containing trusted SSL CA certificates in PEM format.
286 .. config:option:: $cfg['Servers'][$i]['ssl_ciphers']
288     :type: string
289     :default: NULL
291     List of allowable ciphers for SSL connections to the MySQL server.
293 .. config:option:: $cfg['Servers'][$i]['connect_type']
295     :type: string
296     :default: ``'tcp'``
298     What type connection to use with the MySQL server. Your options are
299     ``'socket'`` and ``'tcp'``. It defaults to tcp as that is nearly guaranteed
300     to be available on all MySQL servers, while sockets are not supported on
301     some platforms. To use the socket mode, your MySQL server must be on the
302     same machine as the Web server.
304 .. config:option:: $cfg['Servers'][$i]['compress']
306     :type: boolean
307     :default: false
309     Whether to use a compressed protocol for the MySQL server connection
310     or not (experimental).
312 .. _controlhost:
313 .. config:option:: $cfg['Servers'][$i]['controlhost']
315     :type: string
316     :default: ``''``
318     Permits to use an alternate host to hold the configuration storage
319     data.
321 .. _controlport:
322 .. config:option:: $cfg['Servers'][$i]['controlport']
324     :type: string
325     :default: ``''``
327     Permits to use an alternate port to connect to the host that
328     holds the configuration storage.
330 .. _controluser:
331 .. config:option:: $cfg['Servers'][$i]['controluser']
333     :type: string
334     :default: ``''``
336 .. config:option:: $cfg['Servers'][$i]['controlpass']
338     :type: string
339     :default: ``''``
341     This special account is used for 2 distinct purposes: to make possible all
342     relational features (see :config:option:`$cfg['Servers'][$i]['pmadb']`).
344     .. versionchanged:: 2.2.5
345         those were called ``stduser`` and ``stdpass``
347     .. seealso:: :ref:`setup`, :ref:`authentication_modes`, :ref:`linked-tables`
349 .. config:option:: $cfg['Servers'][$i]['auth_type']
351     :type: string
352     :default: ``'cookie'``
354     Whether config or cookie or :term:`HTTP` or signon authentication should be
355     used for this server.
357     * 'config' authentication (``$auth_type = 'config'``) is the plain old
358       way: username and password are stored in :file:`config.inc.php`.
359     * 'cookie' authentication mode (``$auth_type = 'cookie'``) allows you to
360       log in as any valid MySQL user with the help of cookies.
361     * 'http' authentication allows you to log in as any
362       valid MySQL user via HTTP-Auth.
363     * 'signon' authentication mode (``$auth_type = 'signon'``) allows you to
364       log in from prepared PHP session data or using supplied PHP script.
366     .. seealso:: :ref:`authentication_modes`
368 .. _servers_auth_http_realm:
369 .. config:option:: $cfg['Servers'][$i]['auth_http_realm']
371     :type: string
372     :default: ``''``
374     When using auth\_type = ``http``, this field allows to define a custom
375     :term:`HTTP` Basic Auth Realm which will be displayed to the user. If not
376     explicitly specified in your configuration, a string combined of
377     "phpMyAdmin " and either :config:option:`$cfg['Servers'][$i]['verbose']` or
378     :config:option:`$cfg['Servers'][$i]['host']` will be used.
380 .. _servers_auth_swekey_config:
381 .. config:option:: $cfg['Servers'][$i]['auth_swekey_config']
383     :type: string
384     :default: ``''``
386     The name of the file containing :ref:`swekey` ids and login names for hardware
387     authentication. Leave empty to deactivate this feature.
389 .. _servers_user:
390 .. config:option:: $cfg['Servers'][$i]['user']
392     :type: string
393     :default: ``'root'``
395 .. config:option:: $cfg['Servers'][$i]['password']
397     :type: string
398     :default: ``''``
400     When using :config:option:`$cfg['Servers'][$i]['auth_type']` set to
401     'config', this is the user/password-pair which phpMyAdmin will use to
402     connect to the MySQL server. This user/password pair is not needed when
403     :term:`HTTP` or cookie authentication is used
404     and should be empty.
406 .. _servers_nopassword:
407 .. config:option:: $cfg['Servers'][$i]['nopassword']
409     :type: boolean
410     :default: false
412     Allow attempt to log in without password when a login with password
413     fails. This can be used together with http authentication, when
414     authentication is done some other way and phpMyAdmin gets user name
415     from auth and uses empty password for connecting to MySQL. Password
416     login is still tried first, but as fallback, no password method is
417     tried.
419 .. _servers_only_db:
420 .. config:option:: $cfg['Servers'][$i]['only_db']
422     :type: string or array
423     :default: ``''``
425     If set to a (an array of) database name(s), only this (these)
426     database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
427     this/these database(s) name(s) may contain MySQL wildcards characters
428     ("\_" and "%"): if you want to use literal instances of these
429     characters, escape them (I.E. use ``'my\_db'`` and not ``'my_db'``).
431     This setting is an efficient way to lower the server load since the
432     latter does not need to send MySQL requests to build the available
433     database list. But **it does not replace the privileges rules of the
434     MySQL database server**. If set, it just means only these databases
435     will be displayed but **not that all other databases can't be used.**
437     An example of using more that one database:
439     .. code-block:: php
441         $cfg['Servers'][$i]['only_db'] = array('db1', 'db2');
443     .. versionchanged:: 4.0.0
444         Previous versions permitted to specify the display order of
445         the database names via this directive.
447 .. config:option:: $cfg['Servers'][$i]['hide_db']
449     :type: string
450     :default: ``''``
452     Regular expression for hiding some databases from unprivileged users.
453     This only hides them from listing, but a user is still able to access
454     them (using, for example, the SQL query area). To limit access, use
455     the MySQL privilege system.  For example, to hide all databases
456     starting with the letter "a", use
458     .. code-block:: php
460         $cfg['Servers'][$i]['hide_db'] = '^a';
462     and to hide both "db1" and "db2" use
464     .. code-block:: php
466         $cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$';
468     More information on regular expressions can be found in the `PCRE
469     pattern syntax
470     <http://php.net/manual/en/reference.pcre.pattern.syntax.php>`_ portion
471     of the PHP reference manual.
473 .. config:option:: $cfg['Servers'][$i]['verbose']
475     :type: string
476     :default: ``''``
478     Only useful when using phpMyAdmin with multiple server entries. If
479     set, this string will be displayed instead of the hostname in the
480     pull-down menu on the main page. This can be useful if you want to
481     show only certain databases on your system, for example. For HTTP
482     auth, all non-US-ASCII characters will be stripped.
484 .. config:option:: $cfg['Servers'][$i]['pmadb']
486     :type: string
487     :default: ``''``
489     The name of the database containing the phpMyAdmin configuration
490     storage.
492     See the :ref:`linked-tables`  section in this document to see the benefits of
493     this feature, and for a quick way of creating this database and the needed
494     tables.
496     If you are the only user of this phpMyAdmin installation, you can use your
497     current database to store those special tables; in this case, just put your
498     current database name in :config:option:`$cfg['Servers'][$i]['pmadb']`. For a
499     multi-user installation, set this parameter to the name of your central
500     database containing the phpMyAdmin configuration storage.
502 .. _bookmark:
503 .. config:option:: $cfg['Servers'][$i]['bookmarktable']
505     :type: string
506     :default: ``''``
508     Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This
509     can be useful for queries you often run. To allow the usage of this
510     functionality:
512     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
513     * enter the table name in :config:option:`$cfg['Servers'][$i]['bookmarktable']`
516 .. _relation:
517 .. config:option:: $cfg['Servers'][$i]['relation']
519     :type: string
520     :default: ``''``
522     Since release 2.2.4 you can describe, in a special 'relation' table,
523     which column is a key in another table (a foreign key). phpMyAdmin
524     currently uses this to:
526     * make clickable, when you browse the master table, the data values that
527       point to the foreign table;
528     * display in an optional tool-tip the "display column" when browsing the
529       master table, if you move the mouse to a column containing a foreign
530       key (use also the 'table\_info' table); (see :ref:`faqdisplay`)
531     * in edit/insert mode, display a drop-down list of possible foreign keys
532       (key value and "display column" are shown) (see :ref:`faq6_21`)
533     * display links on the table properties page, to check referential
534       integrity (display missing foreign keys) for each described key;
535     * in query-by-example, create automatic joins (see :ref:`faq6_6`)
536     * enable you to get a :term:`PDF` schema of
537       your database (also uses the table\_coords table).
539     The keys can be numeric or character.
541     To allow the usage of this functionality:
543     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
544     * put the relation table name in :config:option:`$cfg['Servers'][$i]['relation']`
545     * now as normal user open phpMyAdmin and for each one of your tables
546       where you want to use this feature, click :guilabel:`Structure/Relation view/`
547       and choose foreign columns.
549     .. note::
551         In the current version, ``master_db`` must be the same as ``foreign_db``.
552         Those columns have been put in future development of the cross-db
553         relations.
555 .. _table_info:
556 .. config:option:: $cfg['Servers'][$i]['table_info']
558     :type: string
559     :default: ``''``
561     Since release 2.3.0 you can describe, in a special 'table\_info'
562     table, which column is to be displayed as a tool-tip when moving the
563     cursor over the corresponding key. This configuration variable will
564     hold the name of this special table. To allow the usage of this
565     functionality:
567     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
568     * put the table name in :config:option:`$cfg['Servers'][$i]['table\_info']` (e.g.
569       ``pma__table_info``)
570     * then for each table where you want to use this feature, click
571       "Structure/Relation view/Choose column to display" to choose the
572       column.
574     .. seealso:: :ref:`faqdisplay`
576 .. _table_coords:
577 .. config:option:: $cfg['Servers'][$i]['table_coords']
579     :type: string
580     :default: ``''``
582 .. config:option:: $cfg['Servers'][$i]['pdf_pages']
584     :type: string
585     :default: ``''``
587     Since release 2.3.0 you can have phpMyAdmin create :term:`PDF` pages
588     showing the relations between your tables. Further, the designer interface
589     permits visually managing the relations. To do this it needs two tables
590     "pdf\_pages" (storing information about the available :term:`PDF` pages)
591     and "table\_coords" (storing coordinates where each table will be placed on
592     a :term:`PDF` schema output).  You must be using the "relation" feature.
594     To allow the usage of this functionality:
596     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
597     * put the correct table names in
598       :config:option:`$cfg['Servers'][$i]['table\_coords']` and
599       :config:option:`$cfg['Servers'][$i]['pdf\_pages']`
601     .. seealso:: :ref:`faqpdf`.
603 .. _col_com:
604 .. config:option:: $cfg['Servers'][$i]['column_info']
606     :type: string
607     :default: ``''``
609     This part requires a content update!  Since release 2.3.0 you can
610     store comments to describe each column for each table. These will then
611     be shown on the "printview".
613     Starting with release 2.5.0, comments are consequently used on the table
614     property pages and table browse view, showing up as tool-tips above the
615     column name (properties page) or embedded within the header of table in
616     browse view. They can also be shown in a table dump. Please see the
617     relevant configuration directives later on.
619     Also new in release 2.5.0 is a MIME- transformation system which is also
620     based on the following table structure. See :ref:`transformations` for
621     further information. To use the MIME- transformation system, your
622     column\_info table has to have the three new columns 'mimetype',
623     'transformation', 'transformation\_options'.
625     Starting with release 4.3.0, a new input-oriented transformation system
626     has been introduced. Also, backward compatibility code used in the old
627     transformations system was removed. As a result, an update to column\_info
628     table is necessary for previous transformations and the new input-oriented
629     transformation system to work. phpMyAdmin will upgrade it automatically
630     for you by analyzing your current column\_info table structure.
631     However, if something goes wrong with the auto-upgrade then you can
632     use the SQL script found in ``./sql/upgrade_column_info_4_3_0+.sql``
633     to upgrade it manually.
635     To allow the usage of this functionality:
637     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
638     * put the table name in :config:option:`$cfg['Servers'][$i]['column\_info']` (e.g.
639       ``pma__column_info``)
640     * to update your PRE-2.5.0 Column\_comments table use this:  and
641       remember that the Variable in :file:`config.inc.php` has been renamed from
642       :config:option:`$cfg['Servers'][$i]['column\_comments']` to
643       :config:option:`$cfg['Servers'][$i]['column\_info']`
645       .. code-block:: mysql
647            ALTER TABLE `pma__column_comments`
648            ADD `mimetype` VARCHAR( 255 ) NOT NULL,
649            ADD `transformation` VARCHAR( 255 ) NOT NULL,
650            ADD `transformation_options` VARCHAR( 255 ) NOT NULL;
651     * to update your PRE-4.3.0 Column\_info table manually use this
652       ``./sql/upgrade_column_info_4_3_0+.sql`` SQL script.
654     .. note::
656         For auto-upgrade functionality to work, your
657         ``$cfg['Servers'][$i]['controluser']`` must have ALTER privilege on
658         ``phpmyadmin`` database. See the `MySQL documentation for GRANT
659         <http://dev.mysql.com/doc/mysql/en/grant.html>`_ on how to
660         ``GRANT`` privileges to a user.
662 .. _history:
663 .. config:option:: $cfg['Servers'][$i]['history']
665     :type: string
666     :default: ``''``
668     Since release 2.5.0 you can store your :term:`SQL` history, which means all
669     queries you entered manually into the phpMyAdmin interface. If you don't
670     want to use a table-based history, you can use the JavaScript-based
671     history.
673     Using that, all your history items are deleted when closing the window.
674     Using :config:option:`$cfg['QueryHistoryMax']` you can specify an amount of
675     history items you want to have on hold. On every login, this list gets cut
676     to the maximum amount.
678     The query history is only available if JavaScript is enabled in
679     your browser.
681     To allow the usage of this functionality:
683     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
684     * put the table name in :config:option:`$cfg['Servers'][$i]['history']` (e.g.
685       ``pma__history``)
687 .. _recent:
688 .. config:option:: $cfg['Servers'][$i]['recent']
690     :type: string
691     :default: ``''``
693     Since release 3.5.0 you can show recently used tables in the
694     navigation panel. It helps you to jump across table directly, without
695     the need to select the database, and then select the table. Using
696     :config:option:`$cfg['NumRecentTables']` you can configure the maximum number
697     of recent tables shown. When you select a table from the list, it will jump to
698     the page specified in :config:option:`$cfg['NavigationTreeDefaultTabTable']`.
701     Without configuring the storage, you can still access the recently used tables,
702     but it will disappear after you logout.
704     To allow the usage of this functionality persistently:
706     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
707     * put the table name in :config:option:`$cfg['Servers'][$i]['recent']` (e.g.
708       ``pma__recent``)
710 .. _table_uiprefs:
711 .. config:option:: $cfg['Servers'][$i]['table_uiprefs']
713     :type: string
714     :default: ``''``
716     Since release 3.5.0 phpMyAdmin can be configured to remember several
717     things (sorted column :config:option:`$cfg['RememberSorting']`, column order,
718     and column visibility from a database table) for browsing tables. Without
719     configuring the storage, these features still can be used, but the values will
720     disappear after you logout.
722     To allow the usage of these functionality persistently:
724     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
725     * put the table name in :config:option:`$cfg['Servers'][$i]['table\_uiprefs']` (e.g.
726       ``pma__table_uiprefs``)
728 .. _configurablemenus:
729 .. config:option:: $cfg['Servers'][$i]['users']
731     :type: string
732     :default: ``''``
734 .. config:option:: $cfg['Servers'][$i]['usergroups']
736     :type: string
737     :default: ``''``
739     Since release 4.1.0 you can create different user groups with menu items
740     attached to them. Users can be assigned to these groups and the logged in
741     user would only see menu items configured to the usergroup he is assigned to.
742     To do this it needs two tables "usergroups" (storing allowed menu items for each
743     user group) and "users" (storing users and their assignments to user groups).
745     To allow the usage of this functionality:
747     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
748     * put the correct table names in
749       :config:option:`$cfg['Servers'][$i]['users']` (e.g. ``pma__users``) and
750       :config:option:`$cfg['Servers'][$i]['usergroups']` (e.g. ``pma__usergroups``)
752 .. _navigationhiding:
753 .. config:option:: $cfg['Servers'][$i]['navigationhiding']
755     :type: string
756     :default: ``''``
758     Since release 4.1.0 you can hide/show items in the navigation tree.
760     To allow the usage of this functionality:
762     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
763     * put the table name in :config:option:`$cfg['Servers'][$i]['navigationhiding']` (e.g.
764       ``pma__navigationhiding``)
766 .. _central_columns:
767 .. config:option:: $cfg['Servers'][$i]['central_columns']
769     :type: string
770     :default: ``''``
772     Since release 4.3.0 you can have a central list of columns per database.
773     You can add/remove columns to the list as per your requirement. These columns
774     in the central list will be available to use while you create a new column for
775     a table or create a table itself. You can select a column from central list
776     while creating a new column, it will save you from writing the same column definition
777     over again or from writing different names for similar column.
779     To allow the usage of this functionality:
781     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
782     * put the table name in :config:option:`$cfg['Servers'][$i]['central_columns']` (e.g.
783       ``pma__central_columns``)
785 .. _designer_settings:
786 .. config:option:: $cfg['Servers'][$i]['designer_settings']
788     :type: string
789     :default: ``''``
791     Since release 4.5.0 your designer settings can be remembered.
792     Your choice regarding 'Angular/Direct Links', 'Snap to Grid', 'Toggle Relation Lines',
793     'Small/Big All', 'Move Menu' and 'Pin Text' can be remembered persistently.
795     To allow the usage of this functionality:
797     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
798     * put the table name in :config:option:`$cfg['Servers'][$i]['designer_settings']` (e.g.
799       ``pma__designer_settings``)
801 .. _savedsearches:
802 .. config:option:: $cfg['Servers'][$i]['savedsearches']
804     :type: string
805     :default: ``''``
807     Since release 4.2.0 you can save and load query-by-example searches from the Database > Query panel.
809     To allow the usage of this functionality:
811     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
812     * put the table name in :config:option:`$cfg['Servers'][$i]['savedsearches']` (e.g.
813       ``pma__savedsearches``)
815 .. _export_templates:
816 .. config:option:: $cfg['Servers'][$i]['export_templates']
818     :type: string
819     :default: ``''``
821     Since release 4.5.0 you can save and load export templates.
823     To allow the usage of this functionality:
825     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
826     * put the table name in :config:option:`$cfg['Servers'][$i]['export_templates']` (e.g.
827       ``pma__export_templates``)
829 .. _tracking:
830 .. config:option:: $cfg['Servers'][$i]['tracking']
832     :type: string
833     :default: ``''``
835     Since release 3.3.x a tracking mechanism is available. It helps you to
836     track every :term:`SQL` command which is
837     executed by phpMyAdmin. The mechanism supports logging of data
838     manipulation and data definition statements. After enabling it you can
839     create versions of tables.
841     The creation of a version has two effects:
843     * phpMyAdmin saves a snapshot of the table, including structure and
844       indexes.
845     * phpMyAdmin logs all commands which change the structure and/or data of
846       the table and links these commands with the version number.
848     Of course you can view the tracked changes. On the :guilabel:`Tracking`
849     page a complete report is available for every version. For the report you
850     can use filters, for example you can get a list of statements within a date
851     range. When you want to filter usernames you can enter \* for all names or
852     you enter a list of names separated by ','. In addition you can export the
853     (filtered) report to a file or to a temporary database.
855     To allow the usage of this functionality:
857     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
858     * put the table name in :config:option:`$cfg['Servers'][$i]['tracking']` (e.g.
859       ``pma__tracking``)
862 .. _tracking2:
863 .. config:option:: $cfg['Servers'][$i]['tracking_version_auto_create']
865     :type: boolean
866     :default: false
868     Whether the tracking mechanism creates versions for tables and views
869     automatically.
871     If this is set to true and you create a table or view with
873     * CREATE TABLE ...
874     * CREATE VIEW ...
876     and no version exists for it, the mechanism will create a version for
877     you automatically.
879 .. _tracking3:
880 .. config:option:: $cfg['Servers'][$i]['tracking_default_statements']
882     :type: string
883     :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'``
885     Defines the list of statements the auto-creation uses for new
886     versions.
888 .. _tracking4:
889 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_view']
891     :type: boolean
892     :default: true
894     Whether a DROP VIEW IF EXISTS statement will be added as first line to
895     the log when creating a view.
897 .. _tracking5:
898 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_table']
900     :type: boolean
901     :default: true
903     Whether a DROP TABLE IF EXISTS statement will be added as first line
904     to the log when creating a table.
906 .. _tracking6:
907 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_database']
909     :type: boolean
910     :default: true
912     Whether a DROP DATABASE IF EXISTS statement will be added as first
913     line to the log when creating a database.
915 .. _userconfig:
916 .. config:option:: $cfg['Servers'][$i]['userconfig']
918     :type: string
919     :default: ``''``
921     Since release 3.4.x phpMyAdmin allows users to set most preferences by
922     themselves and store them in the database.
924     If you don't allow for storing preferences in
925     :config:option:`$cfg['Servers'][$i]['pmadb']`, users can still personalize
926     phpMyAdmin, but settings will be saved in browser's local storage, or, it
927     is is unavailable, until the end of session.
929     To allow the usage of this functionality:
931     * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
932     * put the table name in :config:option:`$cfg['Servers'][$i]['userconfig']`
934 .. config:option:: $cfg['Servers'][$i]['MaxTableUiprefs']
936     :type: integer
937     :default: 100
939     Maximum number of rows saved in
940     :config:option:`$cfg['Servers'][$i]['table_uiprefs']` table.
942     When tables are dropped or renamed,
943     :config:option:`$cfg['Servers'][$i]['table_uiprefs']` may contain invalid data
944     (referring to tables which no longer exist). We only keep this number of newest
945     rows in :config:option:`$cfg['Servers'][$i]['table_uiprefs']` and automatically
946     delete older rows.
948 .. config:option:: $cfg['Servers'][$i]['SessionTimeZone']
950     :type: string
951     :default: ``''``
953     Sets the time zone used by phpMyAdmin. Leave blank to use the time zone of your
954     database server. Possible values are explained at
955     http://dev.mysql.com/doc/refman/5.7/en/time-zone-support.html
957     This is useful when your database server uses a time zone which is different from the
958     time zone you want to use in phpMyAdmin.
960 .. config:option:: $cfg['Servers'][$i]['AllowRoot']
962     :type: boolean
963     :default: true
965     Whether to allow root access. This is just a shortcut for the
966     :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` below.
968 .. config:option:: $cfg['Servers'][$i]['AllowNoPassword']
970     :type: boolean
971     :default: false
973     Whether to allow logins without a password. The default value of
974     ``false`` for this parameter prevents unintended access to a MySQL
975     server with was left with an empty password for root or on which an
976     anonymous (blank) user is defined.
978 .. _servers_allowdeny_order:
979 .. config:option:: $cfg['Servers'][$i]['AllowDeny']['order']
981     :type: string
982     :default: ``''``
984     If your rule order is empty, then :term:`IP`
985     authorization is disabled.
987     If your rule order is set to
988     ``'deny,allow'`` then the system applies all deny rules followed by
989     allow rules. Access is allowed by default. Any client which does not
990     match a Deny command or does match an Allow command will be allowed
991     access to the server.
993     If your rule order is set to ``'allow,deny'``
994     then the system applies all allow rules followed by deny rules. Access
995     is denied by default. Any client which does not match an Allow
996     directive or does match a Deny directive will be denied access to the
997     server.
999     If your rule order is set to ``'explicit'``, authorization is
1000     performed in a similar fashion to rule order 'deny,allow', with the
1001     added restriction that your host/username combination **must** be
1002     listed in the *allow* rules, and not listed in the *deny* rules. This
1003     is the **most** secure means of using Allow/Deny rules, and was
1004     available in Apache by specifying allow and deny rules without setting
1005     any order.
1007     Please also see :config:option:`$cfg['TrustedProxies']` for
1008     detecting IP address behind proxies.
1010 .. _servers_allowdeny_rules:
1011 .. config:option:: $cfg['Servers'][$i]['AllowDeny']['rules']
1013     :type: array of strings
1014     :default: array()
1016     The general format for the rules is as such:
1018     .. code-block:: none
1020         <'allow' | 'deny'> <username> [from] <ipmask>
1022     If you wish to match all users, it is possible to use a ``'%'`` as a
1023     wildcard in the *username* field.
1025     There are a few shortcuts you can
1026     use in the *ipmask* field as well (please note that those containing
1027     SERVER\_ADDRESS might not be available on all webservers):
1029     .. code-block:: none
1032         'all' -> 0.0.0.0/0
1033         'localhost' -> 127.0.0.1/8
1034         'localnetA' -> SERVER_ADDRESS/8
1035         'localnetB' -> SERVER_ADDRESS/16
1036         'localnetC' -> SERVER_ADDRESS/24
1038     Having an empty rule list is equivalent to either using ``'allow %
1039     from all'`` if your rule order is set to ``'deny,allow'`` or ``'deny %
1040     from all'`` if your rule order is set to ``'allow,deny'`` or
1041     ``'explicit'``.
1043     For the :term:`IP address` matching
1044     system, the following work:
1046     * ``xxx.xxx.xxx.xxx`` (an exact :term:`IP address`)
1047     * ``xxx.xxx.xxx.[yyy-zzz]`` (an :term:`IP address` range)
1048     * ``xxx.xxx.xxx.xxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IP` addresses)
1050     But the following does not work:
1052     * ``xxx.xxx.xxx.xx[yyy-zzz]`` (partial :term:`IP` address range)
1054     For :term:`IPv6` addresses, the following work:
1056     * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx`` (an exact :term:`IPv6` address)
1057     * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:[yyyy-zzzz]`` (an :term:`IPv6` address range)
1058     * ``xxxx:xxxx:xxxx:xxxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IPv6` addresses)
1060     But the following does not work:
1062     * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xx[yyy-zzz]`` (partial :term:`IPv6` address range)
1064 .. config:option:: $cfg['Servers'][$i]['DisableIS']
1066     :type: boolean
1067     :default: false
1069     Disable using ``INFORMATION_SCHEMA`` to retrieve information (use
1070     ``SHOW`` commands instead), because of speed issues when many
1071     databases are present. Currently used in some parts of the code, more
1072     to come.
1074 .. config:option:: $cfg['Servers'][$i]['SignonScript']
1076     :type: string
1077     :default: ``''``
1079     Name of PHP script to be sourced and executed to obtain login
1080     credentials. This is alternative approach to session based single
1081     signon. The script has to provide a function called
1082     ``get_login_credentials`` which returns list of username and
1083     password, accepting single parameter of existing username (can be
1084     empty). See :file:`examples/signon-script.php` for an example:
1086     .. literalinclude:: ../examples/signon-script.php
1087         :language: php
1089     .. seealso:: :ref:`auth_signon`
1091 .. config:option:: $cfg['Servers'][$i]['SignonSession']
1093     :type: string
1094     :default: ``''``
1096     Name of session which will be used for signon authentication method.
1097     You should use something different than ``phpMyAdmin``, because this
1098     is session which phpMyAdmin uses internally. Takes effect only if
1099     :config:option:`$cfg['Servers'][$i]['SignonScript']` is not configured.
1101     .. seealso:: :ref:`auth_signon`
1103 .. config:option:: $cfg['Servers'][$i]['SignonURL']
1105     :type: string
1106     :default: ``''``
1108     :term:`URL` where user will be redirected
1109     to log in for signon authentication method. Should be absolute
1110     including protocol.
1112     .. seealso:: :ref:`auth_signon`
1114 .. config:option:: $cfg['Servers'][$i]['LogoutURL']
1116     :type: string
1117     :default: ``''``
1119     :term:`URL` where user will be redirected
1120     after logout (doesn't affect config authentication method). Should be
1121     absolute including protocol.
1123 Generic settings
1124 ----------------
1126 .. config:option:: $cfg['ServerDefault']
1128     :type: integer
1129     :default: 1
1131     If you have more than one server configured, you can set
1132     :config:option:`$cfg['ServerDefault']` to any one of them to autoconnect to that
1133     server when phpMyAdmin is started, or set it to 0 to be given a list
1134     of servers without logging in.
1136     If you have only one server configured,
1137     :config:option:`$cfg['ServerDefault']` MUST be set to that server.
1139 .. config:option:: $cfg['VersionCheck']
1141     :type: boolean
1142     :default: true
1144     Enables check for latest versions using JavaScript on the main phpMyAdmin
1145     page or by directly accessing :file:`version_check.php`.
1147     .. note::
1149         This setting can be adjusted by your vendor.
1151 .. config:option:: $cfg['ProxyUrl']
1153     :type: string
1154     :default: ""
1156     The url of the proxy to be used when phpmyadmin needs to access the outside
1157     internet such as when retrieving the latest version info or submitting error
1158     reports.  You need this if the server where phpMyAdmin is installed does not
1159     have direct access to the internet.
1160     The format is: "hostname:portnumber"
1162 .. config:option:: $cfg['ProxyUser']
1164     :type: string
1165     :default: ""
1167     The username for authenticating with the proxy. By default, no
1168     authentication is performed. If a username is supplied, Basic
1169     Authentication will be performed. No other types of authentication
1170     are currently supported.
1172 .. config:option:: $cfg['ProxyPass']
1174     :type: string
1175     :default: ""
1177     The password for authenticating with the proxy.
1179 .. config:option:: $cfg['MaxDbList']
1181     :type: integer
1182     :default: 100
1184     The maximum number of database names to be displayed in the main panel's
1185     database list.
1187 .. config:option:: $cfg['MaxTableList']
1189     :type: integer
1190     :default: 250
1192     The maximum number of table names to be displayed in the main panel's
1193     list (except on the Export page).
1195 .. config:option:: $cfg['ShowHint']
1197     :type: boolean
1198     :default: true
1200     Whether or not to show hints (for example, hints when hovering over
1201     table headers).
1203 .. config:option:: $cfg['MaxCharactersInDisplayedSQL']
1205     :type: integer
1206     :default: 1000
1208     The maximum number of characters when a :term:`SQL` query is displayed. The
1209     default limit of 1000 should be correct to avoid the display of tons of
1210     hexadecimal codes that represent BLOBs, but some users have real
1211     :term:`SQL` queries that are longer than 1000 characters. Also, if a
1212     query's length exceeds this limit, this query is not saved in the history.
1214 .. config:option:: $cfg['PersistentConnections']
1216     :type: boolean
1217     :default: false
1219     Whether `persistent connections <http://php.net/manual/en/features
1220     .persistent-connections.php>`_ should be used or not. Works with
1221     following extensions:
1223     * mysql (`mysql\_pconnect <http://php.net/manual/en/function.mysql-
1224       pconnect.php>`_),
1225     * mysqli (requires PHP 5.3.0 or newer, `more information
1226       <http://php.net/manual/en/mysqli.persistconns.php>`_).
1228 .. config:option:: $cfg['ForceSSL']
1230     :type: boolean
1231     :default: false
1233     Whether to force using https while accessing phpMyAdmin. In a reverse
1234     proxy setup, setting this to ``true`` is not supported.
1236     .. note::
1238         In some setups (like separate SSL proxy or load balancer) you might
1239         have to set :config:option:`$cfg['PmaAbsoluteUri']` for correct
1240         redirection.
1242 .. config:option:: $cfg['ExecTimeLimit']
1244     :type: integer [number of seconds]
1245     :default: 300
1247     Set the number of seconds a script is allowed to run. If seconds is
1248     set to zero, no time limit is imposed. This setting is used while
1249     importing/exporting dump files but has
1250     no effect when PHP is running in safe mode.
1252 .. config:option:: $cfg['SessionSavePath']
1254     :type: string
1255     :default: ``''``
1257     Path for storing session data (`session\_save\_path PHP parameter
1258     <http://php.net/session_save_path>`_).
1260 .. config:option:: $cfg['MemoryLimit']
1262     :type: string [number of bytes]
1263     :default: ``'-1'``
1265     Set the number of bytes a script is allowed to allocate. If set to
1266     ``'-1'``, no limit is imposed. If set to ``'0'``, no change of the
1267     memory limit is attempted and the :file:`php.ini` ``memory_limit`` is
1268     used.
1270     This setting is used while importing/exporting dump files
1271     so you definitely don't want to put here a too low
1272     value. It has no effect when PHP is running in safe mode.
1274     You can also use any string as in :file:`php.ini`, eg. '16M'. Ensure you
1275     don't omit the suffix (16 means 16 bytes!)
1277 .. config:option:: $cfg['SkipLockedTables']
1279     :type: boolean
1280     :default: false
1282     Mark used tables and make it possible to show databases with locked
1283     tables (since MySQL 3.23.30).
1285 .. config:option:: $cfg['ShowSQL']
1287     :type: boolean
1288     :default: true
1290     Defines whether :term:`SQL` queries
1291     generated by phpMyAdmin should be displayed or not.
1293 .. config:option:: $cfg['RetainQueryBox']
1295     :type: boolean
1296     :default: false
1298     Defines whether the :term:`SQL` query box
1299     should be kept displayed after its submission.
1301 .. config:option:: $cfg['CodemirrorEnable']
1303     :type: boolean
1304     :default: true
1306     Defines whether to use a Javascript code editor for SQL query boxes.
1307     CodeMirror provides syntax highlighting and line numbers.  However,
1308     middle-clicking for pasting the clipboard contents in some Linux
1309     distributions (such as Ubuntu) is not supported by all browsers.
1311 .. config:option:: $cfg['DefaultForeignKeyChecks']
1313     :type: string
1314     :default: ``'default'``
1316     Default value of the checkbox for foreign key checks, to disable/enable
1317     foreign key checks for certain queries. The possible values are ``'default'``,
1318     ``'enable'`` or ``'disable'``. If set to ``'default'``, the value of the
1319     MySQL variable ``FOREIGN_KEY_CHECKS`` is used.
1321 .. config:option:: $cfg['AllowUserDropDatabase']
1323     :type: boolean
1324     :default: false
1326     Defines whether normal users (non-administrator) are allowed to delete
1327     their own database or not. If set as false, the link :guilabel:`Drop
1328     Database` will not be shown, and even a ``DROP DATABASE mydatabase`` will
1329     be rejected. Quite practical for :term:`ISP` 's with many customers.
1331     .. note::
1333         This limitation of :term:`SQL` queries is not
1334         as strict as when using MySQL privileges. This is due to nature of
1335         :term:`SQL` queries which might be quite
1336         complicated.  So this choice should be viewed as help to avoid accidental
1337         dropping rather than strict privilege limitation.
1339 .. config:option:: $cfg['Confirm']
1341     :type: boolean
1342     :default: true
1344     Whether a warning ("Are your really sure...") should be displayed when
1345     you're about to lose data.
1347 .. config:option:: $cfg['UseDbSearch']
1349     :type: boolean
1350     :default: true
1352     Define whether the "search string inside database" is enabled or not.
1354 .. config:option:: $cfg['IgnoreMultiSubmitErrors']
1356     :type: boolean
1357     :default: false
1359     Define whether phpMyAdmin will continue executing a multi-query
1360     statement if one of the queries fails. Default is to abort execution.
1362 Cookie authentication options
1363 -----------------------------
1365 .. config:option:: $cfg['blowfish_secret']
1367     :type: string
1368     :default: ``''``
1370     The "cookie" auth\_type uses AES algorithm to encrypt the password. If you
1371     are using the "cookie" auth\_type, enter here a random passphrase of your
1372     choice. It will be used internally by the AES algorithm: you won’t be
1373     prompted for this passphrase. There is no maximum length for this secret.
1375     .. note::
1377         The configuration is called blowfish_secret for historical reasons as
1378         Blowfish algorithm was originally used to do the encryption.
1380     .. versionchanged:: 3.1.0
1381         Since version 3.1.0 phpMyAdmin can generate this on the fly, but it
1382         makes a bit weaker security as this generated secret is stored in
1383         session and furthermore it makes impossible to recall user name from
1384         cookie.
1386 .. config:option:: $cfg['LoginCookieRecall']
1388     :type: boolean
1389     :default: true
1391     Define whether the previous login should be recalled or not in cookie
1392     authentication mode.
1394     This is automatically disabled if you do not have
1395     configured :config:option:`$cfg['blowfish_secret']`.
1397 .. config:option:: $cfg['LoginCookieValidity']
1399     :type: integer [number of seconds]
1400     :default: 1440
1402     Define how long a login cookie is valid. Please note that php
1403     configuration option `session.gc\_maxlifetime
1404     <http://php.net/manual/en/session.configuration.php#ini.session.gc-
1405     maxlifetime>`_ might limit session validity and if the session is lost,
1406     the login cookie is also invalidated. So it is a good idea to set
1407     ``session.gc_maxlifetime`` at least to the same value of
1408     :config:option:`$cfg['LoginCookieValidity']`.
1410 .. config:option:: $cfg['LoginCookieStore']
1412     :type: integer [number of seconds]
1413     :default: 0
1415     Define how long login cookie should be stored in browser. Default 0
1416     means that it will be kept for existing session. This is recommended
1417     for not trusted environments.
1419 .. config:option:: $cfg['LoginCookieDeleteAll']
1421     :type: boolean
1422     :default: true
1424     If enabled (default), logout deletes cookies for all servers,
1425     otherwise only for current one. Setting this to false makes it easy to
1426     forget to log out from other server, when you are using more of them.
1428 .. _AllowArbitraryServer:
1429 .. config:option:: $cfg['AllowArbitraryServer']
1431     :type: boolean
1432     :default: false
1434     If enabled, allows you to log in to arbitrary servers using cookie
1435     authentication.
1437     .. note::
1439         Please use this carefully, as this may allow users access to MySQL servers
1440         behind the firewall where your :term:`HTTP` server is placed.
1441         See also :config:option:`$cfg['ArbitraryServerRegexp']`.
1443 .. config:option:: $cfg['ArbitraryServerRegexp']
1445     :type: string
1446     :default: ``''``
1448     Restricts the MySQL servers to which the user can log in when
1449     :config:option:`$cfg['AllowArbitraryServer']` is enabled by
1450     matching the :term:`IP` or the hostname of the MySQL server
1451     to the given regular expression. The regular expression must be enclosed
1452     with a delimiter character.
1454 .. config:option:: $cfg['CaptchaLoginPublicKey']
1456     :type: string
1457     :default: ``''``
1459     The public key for the reCaptcha service that can be obtained from
1460     http://www.google.com/recaptcha.
1462     reCaptcha will be then used in :ref:`cookie`.
1464 .. config:option:: $cfg['CaptchaLoginPrivateKey']
1466     :type: string
1467     :default: ``''``
1469     The private key for the reCaptcha service that can be obtain from
1470     http://www.google.com/recaptcha.
1472     reCaptcha will be then used in :ref:`cookie`.
1474 Navigation panel setup
1475 ----------------------
1477 .. config:option:: $cfg['ShowDatabasesNavigationAsTree']
1479     :type: boolean
1480     :default: true
1482     In the navigation panel, replaces the database tree with a selector
1484 .. config:option:: $cfg['FirstLevelNavigationItems']
1486     :type: integer
1487     :default: 100
1489     The number of first level databases that can be displayed on each page
1490     of navigation tree.
1492 .. config:option:: $cfg['MaxNavigationItems']
1494     :type: integer
1495     :default: 50
1497     The number of items (tables, columns, indexes) that can be displayed on each
1498     page of the navigation tree.
1500 .. config:option:: $cfg['NavigationTreeEnableGrouping']
1502     :type: boolean
1503     :default: true
1505     Defines whether to group the databases based on a common prefix
1506     in their name :config:option:`$cfg['NavigationTreeDbSeparator']`.
1508 .. config:option:: $cfg['NavigationTreeDbSeparator']
1510     :type: string or array
1511     :default: ``'_'``
1513     The string used to separate the parts of the database name when
1514     showing them in a tree. Alternatively you can specify more strings in
1515     an array and all of them will be used as a separator.
1517 .. config:option:: $cfg['NavigationTreeTableSeparator']
1519     :type: string or array
1520     :default: ``'__'``
1522     Defines a string to be used to nest table spaces. This means if you have
1523     tables like ``first__second__third`` this will be shown as a three-level
1524     hierarchy like: first > second > third.  If set to false or empty, the
1525     feature is disabled. NOTE: You should not use this separator at the
1526     beginning or end of a table name or multiple times after another without
1527     any other characters in between.
1529 .. config:option:: $cfg['NavigationTreeTableLevel']
1531     :type: integer
1532     :default: 1
1534     Defines how many sublevels should be displayed when splitting up
1535     tables by the above separator.
1537 .. config:option:: $cfg['NumRecentTables']
1539     :type: integer
1540     :default: 10
1542     The maximum number of recently used tables shown in the navigation
1543     panel. Set this to 0 (zero) to disable the listing of recent tables.
1545 .. config:option:: $cfg['ZeroConf']
1547     :type: boolean
1548     :default: true
1550     Enables Zero Configuration mode in which the user will be offered a choice to
1551     create phpMyAdmin configuration storage in the current database
1552     or use the existing one, if already present.
1554     This setting has no effect if the phpMyAdmin configuration storage database
1555     is properly created and the related configuration directives (such as
1556     :config:option:`$cfg['Servers'][$i]['pmadb']` and so on) are configured.
1558 .. config:option:: $cfg['NavigationLinkWithMainPanel']
1560     :type: boolean
1561     :default: true
1563     Defines whether or not to link with main panel by highlighting
1564     the current database or table.
1566 .. config:option:: $cfg['NavigationDisplayLogo']
1568     :type: boolean
1569     :default: true
1571     Defines whether or not to display the phpMyAdmin logo at the top of
1572     the navigation panel.
1574 .. config:option:: $cfg['NavigationLogoLink']
1576     :type: string
1577     :default: ``'index.php'``
1579     Enter :term:`URL` where logo in the navigation panel will point to.
1580     For use especially with self made theme which changes this.
1581     For external URLs, you should include URL scheme as well.
1583 .. config:option:: $cfg['NavigationLogoLinkWindow']
1585     :type: string
1586     :default: ``'main'``
1588     Whether to open the linked page in the main window (``main``) or in a
1589     new one (``new``). Note: use ``new`` if you are linking to
1590     ``phpmyadmin.net``.
1592 .. config:option:: $cfg['NavigationTreeDisplayItemFilterMinimum']
1594     :type: integer
1595     :default: 30
1597     Defines the minimum number of items (tables, views, routines and
1598     events) to display a JavaScript filter box above the list of items in
1599     the navigation tree.
1601     To disable the filter completely some high number can be used (e.g. 9999)
1603 .. config:option:: $cfg['NavigationTreeDisplayDbFilterMinimum']
1605     :type: integer
1606     :default: 30
1608     Defines the minimum number of databases to display a JavaScript filter
1609     box above the list of databases in the navigation tree.
1611     To disable the filter completely some high number can be used
1612     (e.g. 9999)
1614 .. config:option:: $cfg['NavigationDisplayServers']
1616     :type: boolean
1617     :default: true
1619     Defines whether or not to display a server choice at the top of the
1620     navigation panel.
1622 .. config:option:: $cfg['DisplayServersList']
1624     :type: boolean
1625     :default: false
1627     Defines whether to display this server choice as links instead of in a
1628     drop-down.
1630 .. config:option:: $cfg['NavigationTreeDefaultTabTable']
1632     :type: string
1633     :default: ``'structure'``
1635     Defines the tab displayed by default when clicking the small icon next
1636     to each table name in the navigation panel. The possible values are the
1637     localized equivalent of:
1639     * ``structure``
1640     * ``sql``
1641     * ``search``
1642     * ``insert``
1643     * ``browse``
1645 .. config:option:: $cfg['NavigationTreeDefaultTabTable2']
1647     :type: string
1648     :default: null
1650     Defines the tab displayed by default when clicking the second small icon next
1651     to each table name in the navigation panel. The possible values are the
1652     localized equivalent of:
1654     * ``(empty)``
1655     * ``structure``
1656     * ``sql``
1657     * ``search``
1658     * ``insert``
1659     * ``browse``
1661 .. config:option:: $cfg['NavigationTreeEnableExpansion']
1663     :type: boolean
1664     :default: false
1666     Whether to offer the possibility of tree expansion in the navigation panel.
1668 .. config:option:: $cfg['NavigationTreeShowTables']
1670     :type: boolean
1671     :default: true
1673     Whether to show tables under database in the navigation panel.
1675 .. config:option:: $cfg['NavigationTreeShowViews']
1677     :type: boolean
1678     :default: true
1680     Whether to show views under database in the navigation panel.
1682 .. config:option:: $cfg['NavigationTreeShowFunctions']
1684     :type: boolean
1685     :default: true
1687     Whether to show functions under database in the navigation panel.
1689 .. config:option:: $cfg['NavigationTreeShowProcedures']
1691     :type: boolean
1692     :default: true
1694     Whether to show procedures under database in the navigation panel.
1696 .. config:option:: $cfg['NavigationTreeShowEvents']
1698     :type: boolean
1699     :default: true
1701     Whether to show events under database in the navigation panel.
1704 Main panel
1705 ----------
1707 .. config:option:: $cfg['ShowStats']
1709     :type: boolean
1710     :default: true
1712     Defines whether or not to display space usage and statistics about
1713     databases and tables. Note that statistics requires at least MySQL
1714     3.23.3 and that, at this date, MySQL doesn't return such information
1715     for Berkeley DB tables.
1717 .. config:option:: $cfg['ShowServerInfo']
1719     :type: boolean
1720     :default: true
1722     Defines whether to display detailed server information on main page.
1723     You can additionally hide more information by using
1724     :config:option:`$cfg['Servers'][$i]['verbose']`.
1726 .. config:option:: $cfg['ShowPhpInfo']
1728     :type: boolean
1729     :default: false
1731 .. config:option:: $cfg['ShowChgPassword']
1733     :type: boolean
1734     :default: true
1736 .. config:option:: $cfg['ShowCreateDb']
1738     :type: boolean
1739     :default: true
1741     Defines whether to display the :guilabel:`PHP information` and
1742     :guilabel:`Change password` links and form for creating database or not at
1743     the starting main (right) frame. This setting does not check MySQL commands
1744     entered directly.
1746     Please note that to block the usage of ``phpinfo()`` in scripts, you have to
1747     put this in your :file:`php.ini`:
1749     .. code-block:: ini
1751         disable_functions = phpinfo()
1753     Also note that enabling the :guilabel:`Change password` link has no effect
1754     with config authentication mode: because of the hard coded password value
1755     in the configuration file, end users can't be allowed to change their
1756     passwords.
1758 .. config:option:: $cfg['ShowGitRevision']
1760     :type: boolean
1761     :default: true
1763     Defines whether to display informations about the current Git revision (if
1764     applicable) on the main panel.
1766 .. config:option:: $cfg['MysqlMinVersion']
1768     :type: array
1770     Defines the minimum supported MySQL version. The default is chosen
1771     by the phpMyAdmin team; however this directive was asked by a developer
1772     of the Plesk control panel to ease integration with older MySQL servers
1773     (where most of the phpMyAdmin features work).
1775 Database structure
1776 ------------------
1778 .. config:option:: $cfg['ShowDbStructureCreation']
1780     :type: boolean
1781     :default: false
1783     Defines whether the database structure page (tables list) has a
1784     "Creation" column that displays when each table was created.
1786 .. config:option:: $cfg['ShowDbStructureLastUpdate']
1788     :type: boolean
1789     :default: false
1791     Defines whether the database structure page (tables list) has a "Last
1792     update" column that displays when each table was last updated.
1794 .. config:option:: $cfg['ShowDbStructureLastCheck']
1796     :type: boolean
1797     :default: false
1799     Defines whether the database structure page (tables list) has a "Last
1800     check" column that displays when each table was last checked.
1802 .. config:option:: $cfg['HideStructureActions']
1804     :type: boolean
1805     :default: true
1807     Defines whether the table structure actions are hidden under a "More"
1808     drop-down.
1810 Browse mode
1811 -----------
1813 .. config:option:: $cfg['TableNavigationLinksMode']
1815     :type: string
1816     :default: ``'icons'``
1818     Defines whether the table navigation links contain ``'icons'``, ``'text'``
1819     or ``'both'``.
1821 .. config:option:: $cfg['ActionLinksMode']
1823     :type: string
1824     :default: ``'both'``
1826     If set to ``icons``, will display icons instead of text for db and table
1827     properties links (like :guilabel:`Browse`, :guilabel:`Select`,
1828     :guilabel:`Insert`, ...). Can be set to ``'both'``
1829     if you want icons AND text. When set to ``text``, will only show text.
1831 .. config:option:: $cfg['RowActionType']
1833     :type: string
1834     :default: ``'both'``
1836     Whether to display icons or text or both icons and text in table row action
1837     segment. Value can be either of ``'icons'``, ``'text'`` or ``'both'``.
1839 .. config:option:: $cfg['ShowAll']
1841     :type: boolean
1842     :default: false
1844     Defines whether a user should be displayed a "Show all" button in browse
1845     mode or not in all cases. By default it is shown only on small tables (less
1846     than 500 rows) to avoid performance issues while getting too many rows.
1848 .. config:option:: $cfg['MaxRows']
1850     :type: integer
1851     :default: 25
1853     Number of rows displayed when browsing a result set and no LIMIT
1854     clause is used. If the result set contains more rows, "Previous" and
1855     "Next" links will be shown. Possible values: 25,50,100,250,500.
1857 .. config:option:: $cfg['Order']
1859     :type: string
1860     :default: ``'SMART'``
1862     Defines whether columns are displayed in ascending (``ASC``) order, in
1863     descending (``DESC``) order or in a "smart" (``SMART``) order - I.E.
1864     descending order for columns of type TIME, DATE, DATETIME and
1865     TIMESTAMP, ascending order else- by default.
1867 .. config:option:: $cfg['GridEditing']
1869     :type: string
1870     :default: ``'double-click'``
1872     Defines which action (``double-click`` or ``click``) triggers grid
1873     editing. Can be deactivated with the ``disabled`` value.
1875 .. config:option:: $cfg['RelationalDisplay']
1877     :type: string
1878     :default: ``'K'``
1880     Defines the initial behavior for Options > Relational. ``K``, which
1881     is the default, displays the key while ``D`` shows the display column.
1883 .. config:option:: $cfg['SaveCellsAtOnce']
1885     :type: boolean
1886     :default: false
1888     Defines whether or not to save all edited cells at once for grid
1889     editing.
1891 Editing mode
1892 ------------
1894 .. config:option:: $cfg['ProtectBinary']
1896     :type: boolean or string
1897     :default: ``'blob'``
1899     Defines whether ``BLOB`` or ``BINARY`` columns are protected from
1900     editing when browsing a table's content. Valid values are:
1902     * ``false`` to allow editing of all columns;
1903     * ``'blob'`` to allow editing of all columns except ``BLOBS``;
1904     * ``'noblob'`` to disallow editing of all columns except ``BLOBS`` (the
1905       opposite of ``'blob'``);
1906     * ``'all'`` to disallow editing of all ``BINARY`` or ``BLOB`` columns.
1908 .. config:option:: $cfg['ShowFunctionFields']
1910     :type: boolean
1911     :default: true
1913     Defines whether or not MySQL functions fields should be initially
1914     displayed in edit/insert mode. Since version 2.10, the user can toggle
1915     this setting from the interface.
1917 .. config:option:: $cfg['ShowFieldTypesInDataEditView']
1919     :type: boolean
1920     :default: true
1922     Defines whether or not type fields should be initially displayed in
1923     edit/insert mode. The user can toggle this setting from the interface.
1925 .. config:option:: $cfg['InsertRows']
1927     :type: integer
1928     :default: 2
1930     Defines the maximum number of concurrent entries for the Insert page.
1932 .. config:option:: $cfg['ForeignKeyMaxLimit']
1934     :type: integer
1935     :default: 100
1937     If there are fewer items than this in the set of foreign keys, then a
1938     drop-down box of foreign keys is presented, in the style described by
1939     the :config:option:`$cfg['ForeignKeyDropdownOrder']` setting.
1941 .. config:option:: $cfg['ForeignKeyDropdownOrder']
1943     :type: array
1944     :default: array('content-id', 'id-content')
1946     For the foreign key drop-down fields, there are several methods of
1947     display, offering both the key and value data. The contents of the
1948     array should be one or both of the following strings: ``content-id``,
1949     ``id-content``.
1951 Export and import settings
1952 --------------------------
1954 .. config:option:: $cfg['ZipDump']
1956     :type: boolean
1957     :default: true
1959 .. config:option:: $cfg['GZipDump']
1961     :type: boolean
1962     :default: true
1964 .. config:option:: $cfg['BZipDump']
1966     :type: boolean
1967     :default: true
1969     Defines whether to allow the use of zip/GZip/BZip2 compression when
1970     creating a dump file
1972 .. config:option:: $cfg['CompressOnFly']
1974     :type: boolean
1975     :default: true
1977     Defines whether to allow on the fly compression for GZip/BZip2
1978     compressed exports. This doesn't affect smaller dumps and allows users
1979     to create larger dumps that won't otherwise fit in memory due to php
1980     memory limit. Produced files contain more GZip/BZip2 headers, but all
1981     normal programs handle this correctly.
1983 .. config:option:: $cfg['Export']
1985     :type: array
1986     :default: array(...)
1988     In this array are defined default parameters for export, names of
1989     items are similar to texts seen on export page, so you can easily
1990     identify what they mean.
1992 .. config:option:: $cfg['Export']['method']
1994     :type: string
1995     :default: ``'quick'``
1997     Defines how the export form is displayed when it loads. Valid values
1998     are:
2000     * ``quick`` to display the minimum number of options to configure
2001     * ``custom`` to display every available option to configure
2002     * ``custom-no-form`` same as ``custom`` but does not display the option
2003       of using quick export
2007 .. config:option:: $cfg['Import']
2009     :type: array
2010     :default: array(...)
2012     In this array are defined default parameters for import, names of
2013     items are similar to texts seen on import page, so you can easily
2014     identify what they mean.
2017 Tabs display settings
2018 ---------------------
2020 .. config:option:: $cfg['TabsMode']
2022     :type: string
2023     :default: ``'both'``
2025     Defines whether the menu tabs contain ``'icons'``, ``'text'`` or ``'both'``.
2027 .. config:option:: $cfg['PropertiesNumColumns']
2029     :type: integer
2030     :default: 1
2032     How many columns will be utilized to display the tables on the database
2033     property view? When setting this to a value larger than 1, the type of the
2034     database will be omitted for more display space.
2036 .. config:option:: $cfg['DefaultTabServer']
2038     :type: string
2039     :default: ``'welcome'``
2041     Defines the tab displayed by default on server view. The possible values
2042     are the localized equivalent of:
2044     * ``welcome`` (recommended for multi-user setups)
2045     * ``databases``,
2046     * ``status``
2047     * ``variables``
2048     * ``privileges``
2050 .. config:option:: $cfg['DefaultTabDatabase']
2052     :type: string
2053     :default: ``'structure'``
2055     Defines the tab displayed by default on database view. The possible values
2056     are the localized equivalent of:
2058     * ``structure``
2059     * ``sql``
2060     * ``search``
2061     * ``operations``
2063 .. config:option:: $cfg['DefaultTabTable']
2065     :type: string
2066     :default: ``'browse'``
2068     Defines the tab displayed by default on table view. The possible values
2069     are the localized equivalent of:
2071     * ``structure``
2072     * ``sql``
2073     * ``search``
2074     * ``insert``
2075     * ``browse``
2077 PDF Options
2078 -----------
2080 .. config:option:: $cfg['PDFPageSizes']
2082     :type: array
2083     :default: ``array('A3', 'A4', 'A5', 'letter', 'legal')``
2085     Array of possible paper sizes for creating PDF pages.
2087     You should never need to change this.
2089 .. config:option:: $cfg['PDFDefaultPageSize']
2091     :type: string
2092     :default: ``'A4'``
2094     Default page size to use when creating PDF pages. Valid values are any
2095     listed in :config:option:`$cfg['PDFPageSizes']`.
2097 Languages
2098 ---------
2100 .. config:option:: $cfg['DefaultLang']
2102     :type: string
2103     :default: ``'en'``
2105     Defines the default language to use, if not browser-defined or user-
2106     defined. The corresponding language file needs to be in
2107     locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
2109 .. config:option:: $cfg['DefaultConnectionCollation']
2111     :type: string
2112     :default: ``'utf8_general_ci'``
2114     Defines the default connection collation to use, if not user-defined.
2115     See the `MySQL documentation for charsets
2116     <http://dev.mysql.com/doc/mysql/en/charset-charsets.html>`_
2117     for list of possible values. This setting is
2118     ignored when connected to Drizzle server.
2120 .. config:option:: $cfg['Lang']
2122     :type: string
2123     :default: not set
2125     Force language to use. The corresponding language file needs to be in
2126     locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
2128 .. config:option:: $cfg['FilterLanguages']
2130     :type: string
2131     :default: ``''``
2133     Limit list of available languages to those matching the given regular
2134     expression. For example if you want only Czech and English, you should
2135     set filter to ``'^(cs|en)'``.
2137 .. config:option:: $cfg['RecodingEngine']
2139     :type: string
2140     :default: ``'auto'``
2142     You can select here which functions will be used for character set
2143     conversion. Possible values are:
2145     * auto - automatically use available one (first is tested iconv, then
2146       recode)
2147     * iconv - use iconv or libiconv functions
2148     * recode - use recode\_string function
2149     * mb - use mbstring extension
2150     * none - disable encoding conversion
2152     Enabled charset conversion activates a pull-down menu in the Export
2153     and Import pages, to choose the character set when exporting a file.
2154     The default value in this menu comes from
2155     :config:option:`$cfg['Export']['charset']` and :config:option:`$cfg['Import']['charset']`.
2157 .. config:option:: $cfg['IconvExtraParams']
2159     :type: string
2160     :default: ``'//TRANSLIT'``
2162     Specify some parameters for iconv used in charset conversion. See
2163     `iconv documentation <http://www.gnu.org/software/libiconv/documentati
2164     on/libiconv/iconv_open.3.html>`_ for details. By default
2165     ``//TRANSLIT`` is used, so that invalid characters will be
2166     transliterated.
2168 .. config:option:: $cfg['AvailableCharsets']
2170     :type: array
2171     :default: array(...)
2173     Available character sets for MySQL conversion. You can add your own
2174     (any of supported by recode/iconv) or remove these which you don't
2175     use. Character sets will be shown in same order as here listed, so if
2176     you frequently use some of these move them to the top.
2178 Web server settings
2179 -------------------
2181 .. config:option:: $cfg['OBGzip']
2183     :type: string/boolean
2184     :default: ``'auto'``
2186     Defines whether to use GZip output buffering for increased speed in
2187     :term:`HTTP` transfers. Set to
2188     true/false for enabling/disabling. When set to 'auto' (string),
2189     phpMyAdmin tries to enable output buffering and will automatically
2190     disable it if your browser has some problems with buffering. IE6 with
2191     a certain patch is known to cause data corruption when having enabled
2192     buffering.
2194 .. config:option:: $cfg['TrustedProxies']
2196     :type: array
2197     :default: array()
2199     Lists proxies and HTTP headers which are trusted for
2200     :config:option:`$cfg['Servers'][$i]['AllowDeny']['order']`. This list is by
2201     default empty, you need to fill in some trusted proxy servers if you
2202     want to use rules for IP addresses behind proxy.
2204     The following example specifies that phpMyAdmin should trust a
2205     HTTP\_X\_FORWARDED\_FOR (``X -Forwarded-For``) header coming from the proxy
2206     1.2.3.4:
2208     .. code-block:: php
2210         $cfg['TrustedProxies'] = array('1.2.3.4' => 'HTTP_X_FORWARDED_FOR');
2212     The :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` directive uses the
2213     client's IP address as usual.
2215 .. config:option:: $cfg['GD2Available']
2217     :type: string
2218     :default: ``'auto'``
2220     Specifies whether GD >= 2 is available. If yes it can be used for MIME
2221     transformations. Possible values are:
2223     * auto - automatically detect
2224     * yes - GD 2 functions can be used
2225     * no - GD 2 function cannot be used
2227 .. config:option:: $cfg['CheckConfigurationPermissions']
2229     :type: boolean
2230     :default: true
2232     We normally check the permissions on the configuration file to ensure
2233     it's not world writable. However, phpMyAdmin could be installed on a
2234     NTFS filesystem mounted on a non-Windows server, in which case the
2235     permissions seems wrong but in fact cannot be detected. In this case a
2236     sysadmin would set this parameter to ``false``.
2238 .. config:option:: $cfg['LinkLengthLimit']
2240     :type: integer
2241     :default: 1000
2243     Limit for length of :term:`URL` in links.  When length would be above this
2244     limit, it is replaced by form with button. This is required as some web
2245     servers (:term:`IIS`) have problems with long :term:`URL` .
2247 .. config:option:: $cfg['CSPAllow']
2249     :type: string
2250     :default: ``''``
2252     Additional string to include in allowed script and image sources in Content
2253     Security Policy header.
2255     This can be useful when you want to include some external JavaScript files
2256     in :file:`config.footer.inc.php` or :file:`config.header.inc.php`, which
2257     would be normally not allowed by Content Security Policy.
2259     To allow some sites, just list them within the string:
2261     .. code-block:: php
2263         $cfg['CSPAllow'] = 'example.com example.net';
2265     .. versionadded:: 4.0.4
2267 .. config:option:: $cfg['DisableMultiTableMaintenance']
2269     :type: boolean
2270     :default: false
2272     In the database Structure page, it's possible to mark some tables then
2273     choose an operation like optimizing for many tables. This can slow
2274     down a server; therefore, setting this to ``true`` prevents this kind
2275     of multiple maintenance operation.
2277 Theme settings
2278 --------------
2280 .. config:option:: $cfg['NaviWidth']
2282     :type: integer
2283     :default:
2285     Navigation panel width in pixels. See
2286     :file:`themes/themename/layout.inc.php`.
2288 .. config:option:: $cfg['NaviBackground']
2290     :type: string [CSS color for background]
2291     :default:
2293 .. config:option:: $cfg['MainBackground']
2295     :type: string [CSS color for background]
2296     :default:
2298     The background styles used for both the frames. See
2299     :file:`themes/themename/layout.inc.php`.
2301 .. config:option:: $cfg['NaviPointerBackground']
2303     :type: string [CSS color for background]
2304     :default:
2306 .. config:option:: $cfg['NaviPointerColor']
2308     :type: string [CSS color]
2309     :default:
2311     The style used for the pointer in the navigation panel. See
2312     :file:`themes/themename/layout.inc.php`.
2314 .. config:option:: $cfg['Border']
2316     :type: integer
2317     :default:
2319     The size of a table's border. See :file:`themes/themename/layout.inc.php`.
2321 .. config:option:: $cfg['ThBackground']
2323     :type: string [CSS color for background]
2324     :default:
2326 .. config:option:: $cfg['ThColor']
2328     :type: string [CSS color]
2329     :default:
2331     The style used for table headers. See
2332     :file:`themes/themename/layout.inc.php`.
2334 .. _cfg_BgcolorOne:
2335 .. config:option:: $cfg['BgOne']
2337     :type: string [CSS color]
2338     :default:
2340     The color (HTML) #1 for table rows. See
2341     :file:`themes/themename/layout.inc.php`.
2343 .. _cfg_BgcolorTwo:
2344 .. config:option:: $cfg['BgTwo']
2346     :type: string [CSS color]
2347     :default:
2349     The color (HTML) #2 for table rows. See
2350     :file:`themes/themename/layout.inc.php`.
2352 .. config:option:: $cfg['BrowsePointerBackground']
2354     :type: string [CSS color]
2355     :default:
2357     The background color used when hovering over a row in the Browse panel.
2358     See :file:`themes/themename/layout.inc.php`.
2360 .. config:option:: $cfg['BrowsePointerColor']
2362     :type: string [CSS color]
2363     :default:
2365     The text color used when hovering over a row in the Browse panel.
2366     Used when :config:option:`$cfg['BrowsePointerEnable']` is true.
2367     See :file:`themes/themename/layout.inc.php`.
2369 .. config:option:: $cfg['BrowseMarkerBackground']
2371     :type: string [CSS color]
2372     :default:
2374     The background color used to highlight a row selected by checkbox in the Browse panel or
2375     when a column is selected.
2376     Used when :config:option:`$cfg['BrowsePointerEnable']` is true.
2377     See :file:`themes/themename/layout.inc.php`.
2379 .. config:option:: $cfg['BrowseMarkerColor']
2381     :type: string [CSS color]
2382     :default:
2384     The color used when you visually mark a row or column in the Browse panel.
2385     Rows can be marked by clicking the checkbox to the left of the row and columns can be
2386     marked by clicking the column's header (outside of the header text).
2387     See :file:`themes/themename/layout.inc.php`.
2389 .. config:option:: $cfg['FontFamily']
2391     :type: string
2392     :default:
2394     You put here a valid CSS font family value, for example ``arial, sans-
2395     serif``. See :file:`themes/themename/layout.inc.php`.
2397 .. config:option:: $cfg['FontFamilyFixed']
2399     :type: string
2400     :default:
2402     You put here a valid CSS font family value, for example ``monospace``.
2403     This one is used in textarea. See :file:`themes/themename/layout.inc.php`.
2405 Design customization
2406 --------------------
2408 .. config:option:: $cfg['NavigationTreePointerEnable']
2410     :type: boolean
2411     :default: true
2413     When set to true, hovering over an item in the navigation panel causes that item to be marked
2414     (the background is highlighted).
2416 .. config:option:: $cfg['BrowsePointerEnable']
2418     :type: boolean
2419     :default: true
2421     When set to true, hovering over a row in the Browse page causes that row to be marked (the background
2422     is highlighted).
2424 .. config:option:: $cfg['BrowseMarkerEnable']
2426     :type: boolean
2427     :default: true
2429     When set to true, a data row is marked (the background is highlighted) when the row is selected
2430     with the checkbox.
2432 .. config:option:: $cfg['LimitChars']
2434     :type: integer
2435     :default: 50
2437     Maximum number of characters shown in any non-numeric field on browse
2438     view. Can be turned off by a toggle button on the browse page.
2440 .. config:option:: $cfg['RowActionLinks']
2442     :type: string
2443     :default: ``'left'``
2445     Defines the place where table row links (Edit, Copy, Delete) would be
2446     put when tables contents are displayed (you may have them displayed at
2447     the left side, right side, both sides or nowhere).
2449 .. config:option:: $cfg['RowActionLinksWithoutUnique']
2451     :type: boolean
2452     :default: false
2454     Defines whether to show row links (Edit, Copy, Delete) and checkboxes
2455     for multiple row operations even when the selection does not have a unique key.
2456     Using row actions in the absence of a unique key may result in different/more
2457     rows being affected since there is no guaranteed way to select the exact row(s).
2459 .. config:option:: $cfg['RememberSorting']
2461     :type: boolean
2462     :default: true
2464     If enabled, remember the sorting of each table when browsing them.
2466 .. config:option:: $cfg['TablePrimaryKeyOrder']
2468     :type: string
2469     :default: ``'NONE'``
2471     This defines the default sort order for the tables, having a primary key,
2472     when there is no sort order defines externally.
2473     Acceptable values : ['NONE', 'ASC', 'DESC']
2475 .. config:option:: $cfg['ShowBrowseComments']
2477     :type: boolean
2478     :default: true
2480 .. config:option:: $cfg['ShowPropertyComments']
2482     :type: boolean
2483     :default: true
2485     By setting the corresponding variable to ``true`` you can enable the
2486     display of column comments in Browse or Property display. In browse
2487     mode, the comments are shown inside the header. In property mode,
2488     comments are displayed using a CSS-formatted dashed-line below the
2489     name of the column. The comment is shown as a tool-tip for that
2490     column.
2492 Text fields
2493 -----------
2495 .. config:option:: $cfg['CharEditing']
2497     :type: string
2498     :default: ``'input'``
2500     Defines which type of editing controls should be used for CHAR and
2501     VARCHAR columns. Applies to data editing and also to the default values
2502     in structure editing. Possible values are:
2504     * input - this allows to limit size of text to size of columns in MySQL,
2505       but has problems with newlines in columns
2506     * textarea - no problems with newlines in columns, but also no length
2507       limitations
2509 .. config:option:: $cfg['MinSizeForInputField']
2511     :type: integer
2512     :default: 4
2514     Defines the minimum size for input fields generated for CHAR and
2515     VARCHAR columns.
2517 .. config:option:: $cfg['MaxSizeForInputField']
2519     :type: integer
2520     :default: 60
2522     Defines the maximum size for input fields generated for CHAR and
2523     VARCHAR columns.
2525 .. config:option:: $cfg['TextareaCols']
2527     :type: integer
2528     :default: 40
2530 .. config:option:: $cfg['TextareaRows']
2532     :type: integer
2533     :default: 15
2535 .. config:option:: $cfg['CharTextareaCols']
2537     :type: integer
2538     :default: 40
2540 .. config:option:: $cfg['CharTextareaRows']
2542     :type: integer
2543     :default: 2
2545     Number of columns and rows for the textareas. This value will be
2546     emphasized (\*2) for :term:`SQL` query
2547     textareas and (\*1.25) for :term:`SQL`
2548     textareas inside the query window.
2550     The Char\* values are used for CHAR
2551     and VARCHAR editing (if configured via :config:option:`$cfg['CharEditing']`).
2553 .. config:option:: $cfg['LongtextDoubleTextarea']
2555     :type: boolean
2556     :default: true
2558     Defines whether textarea for LONGTEXT columns should have double size.
2560 .. config:option:: $cfg['TextareaAutoSelect']
2562     :type: boolean
2563     :default: false
2565     Defines if the whole textarea of the query box will be selected on
2566     click.
2568 .. config:option:: $cfg['EnableAutocompleteForTablesAndColumns']
2570     :type: boolean
2571     :default: true
2573     Whether to enable autocomplete for table and column names in any
2574     SQL query box.
2577 SQL query box settings
2578 ----------------------
2580 .. config:option:: $cfg['SQLQuery']['Edit']
2582     :type: boolean
2583     :default: true
2585     Whether to display an edit link to change a query in any SQL Query
2586     box.
2588 .. config:option:: $cfg['SQLQuery']['Explain']
2590     :type: boolean
2591     :default: true
2593     Whether to display a link to explain a SELECT query in any SQL Query
2594     box.
2596 .. config:option:: $cfg['SQLQuery']['ShowAsPHP']
2598     :type: boolean
2599     :default: true
2601     Whether to display a link to wrap a query in PHP code in any SQL Query
2602     box.
2604 .. config:option:: $cfg['SQLQuery']['Refresh']
2606     :type: boolean
2607     :default: true
2609     Whether to display a link to refresh a query in any SQL Query box.
2611 Web server upload/save/import directories
2612 -----------------------------------------
2614 .. config:option:: $cfg['UploadDir']
2616     :type: string
2617     :default: ``''``
2619     The name of the directory where :term:`SQL` files have been uploaded by
2620     other means than phpMyAdmin (for example, ftp). Those files are available
2621     under a drop-down box when you click the database or table name, then the
2622     Import tab.
2624     If
2625     you want different directory for each user, %u will be replaced with
2626     username.
2628     Please note that the file names must have the suffix ".sql"
2629     (or ".sql.bz2" or ".sql.gz" if support for compressed formats is
2630     enabled).
2632     This feature is useful when your file is too big to be
2633     uploaded via :term:`HTTP`, or when file
2634     uploads are disabled in PHP.
2636     .. note::
2638         If PHP is running in safe mode, this directory must be owned by the same
2639         user as the owner of the phpMyAdmin scripts.  See also :ref:`faq1_16` for
2640         alternatives.
2642 .. config:option:: $cfg['SaveDir']
2644     :type: string
2645     :default: ``''``
2647     The name of the directory where dumps can be saved.
2649     If you want different directory for each user, %u will be replaced with
2650     username.
2652     Please note that the directory must exist and has to be writable for
2653     the user running webserver.
2655     .. note::
2657         If PHP is running in safe mode, this directory must be owned by the same
2658         user as the owner of the phpMyAdmin scripts.
2660 .. config:option:: $cfg['TempDir']
2662     :type: string
2663     :default: ``''``
2665     The name of the directory where temporary files can be stored.
2667     This is needed for importing ESRI Shapefiles, see :ref:`faq6_30` and to
2668     work around limitations of ``open_basedir`` for uploaded files, see
2669     :ref:`faq1_11`.
2671     If the directory where phpMyAdmin is installed is
2672     subject to an ``open_basedir`` restriction, you need to create a
2673     temporary directory in some directory accessible by the web server.
2674     However for security reasons, this directory should be outside the
2675     tree published by webserver. If you cannot avoid having this directory
2676     published by webserver, place at least an empty :file:`index.html` file
2677     there, so that directory listing is not possible.
2679     This directory should have as strict permissions as possible as the only
2680     user required to access this directory is the one who runs the webserver.
2681     If you have root privileges, simply make this user owner of this directory
2682     and make it accessible only by it:
2684     .. code-block:: sh
2687         chown www-data:www-data tmp
2688         chmod 700 tmp
2690     If you cannot change owner of the directory, you can achieve a similar
2691     setup using :term:`ACL`:
2693     .. code-block:: sh
2695         chmod 700 tmp
2696         setfacl -m "g:www-data:rwx" tmp
2697         setfacl -d -m "g:www-data:rwx" tmp
2699     If neither of above works for you, you can still make the directory
2700     :command:`chmod 777`, but it might impose risk of other users on system
2701     reading and writing data in this directory.
2703 Various display setting
2704 -----------------------
2706 .. config:option:: $cfg['RepeatCells']
2708     :type: integer
2709     :default: 100
2711     Repeat the headers every X cells, or 0 to deactivate.
2713 .. config:option:: $cfg['QueryHistoryDB']
2715     :type: boolean
2716     :default: false
2718 .. config:option:: $cfg['QueryHistoryMax']
2720     :type: integer
2721     :default: 25
2723     If :config:option:`$cfg['QueryHistoryDB']` is set to ``true``, all your
2724     Queries are logged to a table, which has to be created by you (see
2725     :config:option:`$cfg['Servers'][$i]['history']`). If set to false, all your
2726     queries will be appended to the form, but only as long as your window is
2727     opened they remain saved.
2729     When using the JavaScript based query window, it will always get updated
2730     when you click on a new table/db to browse and will focus if you click on
2731     :guilabel:`Edit SQL` after using a query. You can suppress updating the
2732     query window by checking the box :guilabel:`Do not overwrite this query
2733     from outside the window` below the query textarea. Then you can browse
2734     tables/databases in the background without losing the contents of the
2735     textarea, so this is especially useful when composing a query with tables
2736     you first have to look in. The checkbox will get automatically checked
2737     whenever you change the contents of the textarea. Please uncheck the button
2738     whenever you definitely want the query window to get updated even though
2739     you have made alterations.
2741     If :config:option:`$cfg['QueryHistoryDB']` is set to ``true`` you can
2742     specify the amount of saved history items using
2743     :config:option:`$cfg['QueryHistoryMax']`.
2745 .. config:option:: $cfg['BrowseMIME']
2747     :type: boolean
2748     :default: true
2750     Enable :ref:`transformations`.
2752 .. config:option:: $cfg['MaxExactCount']
2754     :type: integer
2755     :default: 500000
2757     For InnoDB tables, determines for how large tables phpMyAdmin should
2758     get the exact row count using ``SELECT COUNT``. If the approximate row
2759     count as returned by ``SHOW TABLE STATUS`` is smaller than this value,
2760     ``SELECT COUNT`` will be used, otherwise the approximate count will be
2761     used.
2763 .. config:option:: $cfg['MaxExactCountViews']
2765     :type: integer
2766     :default: 0
2768     For VIEWs, since obtaining the exact count could have an impact on
2769     performance, this value is the maximum to be displayed, using a
2770     ``SELECT COUNT ... LIMIT``. Setting this to 0 bypasses any row
2771     counting.
2773 .. config:option:: $cfg['NaturalOrder']
2775     :type: boolean
2776     :default: true
2778     Sorts database and table names according to natural order (for
2779     example, t1, t2, t10). Currently implemented in the navigation panel
2780     and in Database view, for the table list.
2782 .. config:option:: $cfg['InitialSlidersState']
2784     :type: string
2785     :default: ``'closed'``
2787     If set to ``'closed'``, the visual sliders are initially in a closed
2788     state. A value of ``'open'`` does the reverse. To completely disable
2789     all visual sliders, use ``'disabled'``.
2791 .. config:option:: $cfg['UserprefsDisallow']
2793     :type: array
2794     :default: array()
2796     Contains names of configuration options (keys in ``$cfg`` array) that
2797     users can't set through user preferences. For possible values, refer
2798     to :file:`libraries/config/user_preferences.forms.php`.
2800 .. config:option:: $cfg['UserprefsDeveloperTab']
2802     :type: boolean
2803     :default: false
2805     Activates in the user preferences a tab containing options for
2806     developers of phpMyAdmin.
2808 Page titles
2809 -----------
2811 .. config:option:: $cfg['TitleTable']
2813     :type: string
2814     :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ / @TABLE@ | @PHPMYADMIN@'``
2816 .. config:option:: $cfg['TitleDatabase']
2818     :type: string
2819     :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ | @PHPMYADMIN@'``
2821 .. config:option:: $cfg['TitleServer']
2823     :type: string
2824     :default: ``'@HTTP_HOST@ / @VSERVER@ | @PHPMYADMIN@'``
2826 .. config:option:: $cfg['TitleDefault']
2828     :type: string
2829     :default: ``'@HTTP_HOST@ | @PHPMYADMIN@'``
2831     Allows you to specify window's title bar. You can use :ref:`faq6_27`.
2833 Theme manager settings
2834 ----------------------
2836 .. config:option:: $cfg['ThemePath']
2838     :type: string
2839     :default: ``'./themes'``
2841     If theme manager is active, use this as the path of the subdirectory
2842     containing all the themes.
2844 .. config:option:: $cfg['ThemeManager']
2846     :type: boolean
2847     :default: true
2849     Enables user-selectable themes. See :ref:`faqthemes`.
2851 .. config:option:: $cfg['ThemeDefault']
2853     :type: string
2854     :default: ``'pmahomme'``
2856     The default theme (a subdirectory under :config:option:`$cfg['ThemePath']`).
2858 .. config:option:: $cfg['ThemePerServer']
2860     :type: boolean
2861     :default: false
2863     Whether to allow different theme for each server.
2865 Default queries
2866 ---------------
2868 .. config:option:: $cfg['DefaultQueryTable']
2870     :type: string
2871     :default: ``'SELECT * FROM @TABLE@ WHERE 1'``
2873 .. config:option:: $cfg['DefaultQueryDatabase']
2875     :type: string
2876     :default: ``''``
2878     Default queries that will be displayed in query boxes when user didn't
2879     specify any. You can use standard :ref:`faq6_27`.
2882 MySQL settings
2883 --------------
2885 .. config:option:: $cfg['DefaultFunctions']
2887     :type: array
2888     :default: array(...)
2890     Functions selected by default when inserting/changing row, Functions
2891     are defined for meta types as (FUNC\_NUMBER, FUNC\_DATE, FUNC\_CHAR,
2892     FUNC\_SPATIAL, FUNC\_UUID) and for ``first_timestamp``, which is used
2893     for first timestamp column in table.
2896 Developer
2897 ---------
2899 .. warning::
2901     These settings might have huge effect on performance or security.
2903 .. config:option:: $cfg['DBG']
2905     :type: array
2906     :default: array(...)
2908 .. config:option:: $cfg['DBG']['sql']
2910     :type: boolean
2911     :default: false
2913     Enable logging queries and execution times to be
2914     displayed in the console's Debug SQL tab.
2916 .. config:option:: $cfg['DBG']['demo']
2918     :type: boolean
2919     :default: false
2921     Enable to let server present itself as demo server.
2922     This is used for <http://demo.phpmyadmin.net/>.