1 .. index:: config.inc.php
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.
24 Some distributions (eg. Debian or Ubuntu) store :file:`config.inc.php` in
25 ``/etc/phpmyadmin`` instead of within phpMyAdmin sources.
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
39 .. config:option:: $cfg['PmaAbsoluteUri']
44 .. versionchanged:: 4.6.5
46 This setting was not available in phpMyAdmin 4.6.0 - 4.6.4.
48 Sets here the complete :term:`URL` (with full path) to your phpMyAdmin
49 installation's directory. E.g.
50 ``https://www.example.net/path_to_your_phpMyAdmin_directory/``. Note also
51 that the :term:`URL` on most of web servers are case–sensitive. Don’t
52 forget the trailing slash at the end.
54 Starting with version 2.3.0, it is advisable to try leaving this blank. In
55 most cases phpMyAdmin automatically detects the proper setting. Users of
56 port forwarding will need to set :config:option:`$cfg['PmaAbsoluteUri']`
57 (`more info <https://sourceforge.net/p/phpmyadmin/support-requests/795/>`_).
59 A good test is to browse a table, edit a row and save it. There should be
60 an error message if phpMyAdmin is having trouble auto–detecting the correct
61 value. If you get an error that this must be set or if the autodetect code
62 fails to detect your path, please post a bug report on our bug tracker so
63 we can improve the code.
65 .. seealso:: :ref:`faq1_40`, :ref:`faq2_5`, :ref:`faq4_7`, :ref:`faq5_16`
67 .. config:option:: $cfg['PmaNoRelation_DisableWarning']
72 Starting with version 2.3.0 phpMyAdmin offers a lot of features to
73 work with master / foreign – tables (see :config:option:`$cfg['Servers'][$i]['pmadb']`).
75 If you tried to set this
76 up and it does not work for you, have a look on the :guilabel:`Structure` page
77 of one database where you would like to use it. You will find a link
78 that will analyze why those features have been disabled.
80 If you do not want to use those features set this variable to ``true`` to
81 stop this message from appearing.
83 .. config:option:: $cfg['SuhosinDisableWarning']
88 A warning is displayed on the main page if Suhosin is detected.
90 You can set this parameter to ``true`` to stop this message from appearing.
92 .. config:option:: $cfg['LoginCookieValidityDisableWarning']
97 A warning is displayed on the main page if the PHP parameter
98 session.gc_maxlifetime is lower than cookie validity configured in phpMyAdmin.
100 You can set this parameter to ``true`` to stop this message from appearing.
102 .. config:option:: $cfg['ServerLibraryDifference_DisableWarning']
107 A warning is displayed on the main page if there is a difference
108 between the MySQL library and server version.
110 You can set this parameter to ``true`` to stop this message from appearing.
112 .. config:option:: $cfg['ReservedWordDisableWarning']
117 This warning is displayed on the Structure page of a table if one or more
118 column names match with words which are MySQL reserved.
120 If you want to turn off this warning, you can set it to ``true`` and
121 warning will no longer be displayed.
123 .. config:option:: $cfg['TranslationWarningThreshold']
128 Show warning about incomplete translations on certain threshold.
130 .. config:option:: $cfg['SendErrorReports']
135 Sets the default behavior for JavaScript error reporting.
137 Whenever an error is detected in the JavaScript execution, an error report
138 may be sent to the phpMyAdmin team if the user agrees.
140 The default setting of ``'ask'`` will ask the user everytime there is a new
141 error report. However you can set this parameter to ``'always'`` to send error
142 reports without asking for confirmation or you can set it to ``'never'`` to
143 never send error reports.
145 This directive is available both in the configuration file and in users
146 preferences. If the person in charge of a multi-user installation prefers
147 to disable this feature for all users, a value of ``'never'`` should be
148 set, and the :config:option:`$cfg['UserprefsDisallow']` directive should
149 contain ``'SendErrorReports'`` in one of its array values.
151 .. config:option:: $cfg['ConsoleEnterExecutes']
156 Setting this to ``true`` allows the user to execute queries by pressing Enter
157 instead of Ctrl+Enter. A new line can be inserted by pressing Shift + Enter.
159 The behaviour of the console can be temporarily changed using console's
162 .. config:option:: $cfg['AllowThirdPartyFraming']
167 Setting this to ``true`` allows phpMyAdmin to be included inside a frame,
168 and is a potential security hole allowing cross-frame scripting attacks or
171 Server connection settings
172 --------------------------
174 .. config:option:: $cfg['Servers']
177 :default: one server array with settings listed below
179 Since version 1.4.2, phpMyAdmin supports the administration of multiple
180 MySQL servers. Therefore, a :config:option:`$cfg['Servers']`-array has been
181 added which contains the login information for the different servers. The
182 first :config:option:`$cfg['Servers'][$i]['host']` contains the hostname of
183 the first server, the second :config:option:`$cfg['Servers'][$i]['host']`
184 the hostname of the second server, etc. In
185 :file:`libraries/config.default.php`, there is only one section for server
186 definition, however you can put as many as you need in
187 :file:`config.inc.php`, copy that block or needed parts (you don't have to
188 define all settings, just those you need to change).
192 The :config:option:`$cfg['Servers']` array starts with
193 $cfg['Servers'][1]. Do not use $cfg['Servers'][0]. If you want more
194 than one server, just copy following section (including $i
195 incrementation) serveral times. There is no need to define full server
196 array, just define values you need to change.
199 .. config:option:: $cfg['Servers'][$i]['host']
202 :default: ``'localhost'``
204 The hostname or :term:`IP` address of your $i-th MySQL-server. E.g.
209 * hostname, e.g., ``'localhost'`` or ``'mydb.example.org'``
210 * IP address, e.g., ``'127.0.0.1'`` or ``'192.168.10.1'``
211 * dot - ``'.'``, i.e., use named pipes on windows systems
212 * empty - ``''``, disables this server
216 phpMyAdmin supports connecting to MySQL servers reachable via IPv6 only.
217 To connect to an IPv6 MySQL server, enter its IPv6 address in this field.
219 .. config:option:: $cfg['Servers'][$i]['port']
224 The port-number of your $i-th MySQL-server. Default is 3306 (leave
229 If you use ``localhost`` as the hostname, MySQL ignores this port number
230 and connects with the socket, so if you want to connect to a port
231 different from the default port, use ``127.0.0.1`` or the real hostname
232 in :config:option:`$cfg['Servers'][$i]['host']`.
234 .. config:option:: $cfg['Servers'][$i]['socket']
239 The path to the socket to use. Leave blank for default. To determine
240 the correct socket, check your MySQL configuration or, using the
241 :command:`mysql` command–line client, issue the ``status`` command. Among the
242 resulting information displayed will be the socket used.
244 .. config:option:: $cfg['Servers'][$i]['ssl']
249 Whether to enable SSL for the connection between phpMyAdmin and the MySQL server.
251 When using the ``'mysql'`` extension,
252 none of the remaining ``'ssl...'`` configuration options apply.
254 We strongly recommend the ``'mysqli'`` extension when using this option.
256 .. seealso:: :ref:`example-google-ssl`
258 .. config:option:: $cfg['Servers'][$i]['ssl_key']
263 Path to the key file when using SSL for connecting to the MySQL server.
269 $cfg['Servers'][$i]['ssl_key'] = '/etc/mysql/server-key.pem';
271 .. seealso:: :ref:`example-google-ssl`
273 .. config:option:: $cfg['Servers'][$i]['ssl_cert']
278 Path to the cert file when using SSL for connecting to the MySQL server.
280 .. seealso:: :ref:`example-google-ssl`
282 .. config:option:: $cfg['Servers'][$i]['ssl_ca']
287 Path to the CA file when using SSL for connecting to the MySQL server.
289 .. seealso:: :ref:`example-google-ssl`
291 .. config:option:: $cfg['Servers'][$i]['ssl_ca_path']
296 Directory containing trusted SSL CA certificates in PEM format.
298 .. config:option:: $cfg['Servers'][$i]['ssl_ciphers']
303 List of allowable ciphers for SSL connections to the MySQL server.
305 .. config:option:: $cfg['Servers'][$i]['ssl_verify']
310 .. versionadded:: 4.6.0
312 This is supported since phpMyAdmin 4.6.0.
314 If your PHP install uses the MySQL Native Driver (mysqlnd), your
315 MySQL server is 5.6 or later, and your SSL certificate is self-signed,
316 there is a chance your SSL connection will fail due to validation.
317 Setting this to ``false`` will disable the validation check.
319 Since PHP 5.6.0 it also verifies whether server name matches CN of it's
320 certificate. There is currently no way to disable just this check without
321 disabling complete SSL verification.
325 This flag only works with PHP 5.6.16 or later.
327 .. seealso:: :ref:`example-google-ssl`
329 .. config:option:: $cfg['Servers'][$i]['connect_type']
334 What type connection to use with the MySQL server. Your options are
335 ``'socket'`` and ``'tcp'``. It defaults to tcp as that is nearly guaranteed
336 to be available on all MySQL servers, while sockets are not supported on
337 some platforms. To use the socket mode, your MySQL server must be on the
338 same machine as the Web server.
340 .. config:option:: $cfg['Servers'][$i]['compress']
345 Whether to use a compressed protocol for the MySQL server connection
346 or not (experimental).
349 .. config:option:: $cfg['Servers'][$i]['controlhost']
354 Permits to use an alternate host to hold the configuration storage
358 .. config:option:: $cfg['Servers'][$i]['controlport']
363 Permits to use an alternate port to connect to the host that
364 holds the configuration storage.
367 .. config:option:: $cfg['Servers'][$i]['controluser']
372 .. config:option:: $cfg['Servers'][$i]['controlpass']
377 This special account is used for 2 distinct purposes: to make possible all
378 relational features (see :config:option:`$cfg['Servers'][$i]['pmadb']`).
380 .. versionchanged:: 2.2.5
381 those were called ``stduser`` and ``stdpass``
383 .. seealso:: :ref:`setup`, :ref:`authentication_modes`, :ref:`linked-tables`
385 .. config:option:: $cfg['Servers'][$i]['auth_type']
388 :default: ``'cookie'``
390 Whether config or cookie or :term:`HTTP` or signon authentication should be
391 used for this server.
393 * 'config' authentication (``$auth_type = 'config'``) is the plain old
394 way: username and password are stored in :file:`config.inc.php`.
395 * 'cookie' authentication mode (``$auth_type = 'cookie'``) allows you to
396 log in as any valid MySQL user with the help of cookies.
397 * 'http' authentication allows you to log in as any
398 valid MySQL user via HTTP-Auth.
399 * 'signon' authentication mode (``$auth_type = 'signon'``) allows you to
400 log in from prepared PHP session data or using supplied PHP script.
402 .. seealso:: :ref:`authentication_modes`
404 .. _servers_auth_http_realm:
405 .. config:option:: $cfg['Servers'][$i]['auth_http_realm']
410 When using auth\_type = ``http``, this field allows to define a custom
411 :term:`HTTP` Basic Auth Realm which will be displayed to the user. If not
412 explicitly specified in your configuration, a string combined of
413 "phpMyAdmin " and either :config:option:`$cfg['Servers'][$i]['verbose']` or
414 :config:option:`$cfg['Servers'][$i]['host']` will be used.
417 .. config:option:: $cfg['Servers'][$i]['user']
422 .. config:option:: $cfg['Servers'][$i]['password']
427 When using :config:option:`$cfg['Servers'][$i]['auth_type']` set to
428 'config', this is the user/password-pair which phpMyAdmin will use to
429 connect to the MySQL server. This user/password pair is not needed when
430 :term:`HTTP` or cookie authentication is used
433 .. _servers_nopassword:
434 .. config:option:: $cfg['Servers'][$i]['nopassword']
439 Allow attempt to log in without password when a login with password
440 fails. This can be used together with http authentication, when
441 authentication is done some other way and phpMyAdmin gets user name
442 from auth and uses empty password for connecting to MySQL. Password
443 login is still tried first, but as fallback, no password method is
447 .. config:option:: $cfg['Servers'][$i]['only_db']
449 :type: string or array
452 If set to a (an array of) database name(s), only this (these)
453 database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
454 this/these database(s) name(s) may contain MySQL wildcards characters
455 ("\_" and "%"): if you want to use literal instances of these
456 characters, escape them (I.E. use ``'my\_db'`` and not ``'my_db'``).
458 This setting is an efficient way to lower the server load since the
459 latter does not need to send MySQL requests to build the available
460 database list. But **it does not replace the privileges rules of the
461 MySQL database server**. If set, it just means only these databases
462 will be displayed but **not that all other databases can't be used.**
464 An example of using more that one database:
468 $cfg['Servers'][$i]['only_db'] = array('db1', 'db2');
470 .. versionchanged:: 4.0.0
471 Previous versions permitted to specify the display order of
472 the database names via this directive.
474 .. config:option:: $cfg['Servers'][$i]['hide_db']
479 Regular expression for hiding some databases from unprivileged users.
480 This only hides them from listing, but a user is still able to access
481 them (using, for example, the SQL query area). To limit access, use
482 the MySQL privilege system. For example, to hide all databases
483 starting with the letter "a", use
487 $cfg['Servers'][$i]['hide_db'] = '^a';
489 and to hide both "db1" and "db2" use
493 $cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$';
495 More information on regular expressions can be found in the `PCRE
497 <https://php.net/manual/en/reference.pcre.pattern.syntax.php>`_ portion
498 of the PHP reference manual.
500 .. config:option:: $cfg['Servers'][$i]['verbose']
505 Only useful when using phpMyAdmin with multiple server entries. If
506 set, this string will be displayed instead of the hostname in the
507 pull-down menu on the main page. This can be useful if you want to
508 show only certain databases on your system, for example. For HTTP
509 auth, all non-US-ASCII characters will be stripped.
511 .. config:option:: $cfg['Servers'][$i]['pmadb']
516 The name of the database containing the phpMyAdmin configuration
519 See the :ref:`linked-tables` section in this document to see the benefits of
520 this feature, and for a quick way of creating this database and the needed
523 If you are the only user of this phpMyAdmin installation, you can use your
524 current database to store those special tables; in this case, just put your
525 current database name in :config:option:`$cfg['Servers'][$i]['pmadb']`. For a
526 multi-user installation, set this parameter to the name of your central
527 database containing the phpMyAdmin configuration storage.
530 .. config:option:: $cfg['Servers'][$i]['bookmarktable']
532 :type: string or false
535 Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This
536 can be useful for queries you often run. To allow the usage of this
539 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
540 * enter the table name in :config:option:`$cfg['Servers'][$i]['bookmarktable']`
542 This feature can be disabled by setting the configuration to ``false``.
545 .. config:option:: $cfg['Servers'][$i]['relation']
547 :type: string or false
550 Since release 2.2.4 you can describe, in a special 'relation' table,
551 which column is a key in another table (a foreign key). phpMyAdmin
552 currently uses this to:
554 * make clickable, when you browse the master table, the data values that
555 point to the foreign table;
556 * display in an optional tool-tip the "display column" when browsing the
557 master table, if you move the mouse to a column containing a foreign
558 key (use also the 'table\_info' table); (see :ref:`faqdisplay`)
559 * in edit/insert mode, display a drop-down list of possible foreign keys
560 (key value and "display column" are shown) (see :ref:`faq6_21`)
561 * display links on the table properties page, to check referential
562 integrity (display missing foreign keys) for each described key;
563 * in query-by-example, create automatic joins (see :ref:`faq6_6`)
564 * enable you to get a :term:`PDF` schema of
565 your database (also uses the table\_coords table).
567 The keys can be numeric or character.
569 To allow the usage of this functionality:
571 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
572 * put the relation table name in :config:option:`$cfg['Servers'][$i]['relation']`
573 * now as normal user open phpMyAdmin and for each one of your tables
574 where you want to use this feature, click :guilabel:`Structure/Relation view/`
575 and choose foreign columns.
577 This feature can be disabled by setting the configuration to ``false``.
581 In the current version, ``master_db`` must be the same as ``foreign_db``.
582 Those columns have been put in future development of the cross-db
586 .. config:option:: $cfg['Servers'][$i]['table_info']
588 :type: string or false
591 Since release 2.3.0 you can describe, in a special 'table\_info'
592 table, which column is to be displayed as a tool-tip when moving the
593 cursor over the corresponding key. This configuration variable will
594 hold the name of this special table. To allow the usage of this
597 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
598 * put the table name in :config:option:`$cfg['Servers'][$i]['table\_info']` (e.g.
600 * then for each table where you want to use this feature, click
601 "Structure/Relation view/Choose column to display" to choose the
604 This feature can be disabled by setting the configuration to ``false``.
606 .. seealso:: :ref:`faqdisplay`
609 .. config:option:: $cfg['Servers'][$i]['table_coords']
611 :type: string or false
614 .. config:option:: $cfg['Servers'][$i]['pdf_pages']
616 :type: string or false
619 Since release 2.3.0 you can have phpMyAdmin create :term:`PDF` pages
620 showing the relations between your tables. Further, the designer interface
621 permits visually managing the relations. To do this it needs two tables
622 "pdf\_pages" (storing information about the available :term:`PDF` pages)
623 and "table\_coords" (storing coordinates where each table will be placed on
624 a :term:`PDF` schema output). You must be using the "relation" feature.
626 To allow the usage of this functionality:
628 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
629 * put the correct table names in
630 :config:option:`$cfg['Servers'][$i]['table\_coords']` and
631 :config:option:`$cfg['Servers'][$i]['pdf\_pages']`
633 This feature can be disabled by setting either of the configurations to ``false``.
635 .. seealso:: :ref:`faqpdf`.
638 .. config:option:: $cfg['Servers'][$i]['column_info']
640 :type: string or false
643 This part requires a content update! Since release 2.3.0 you can
644 store comments to describe each column for each table. These will then
645 be shown on the "printview".
647 Starting with release 2.5.0, comments are consequently used on the table
648 property pages and table browse view, showing up as tool-tips above the
649 column name (properties page) or embedded within the header of table in
650 browse view. They can also be shown in a table dump. Please see the
651 relevant configuration directives later on.
653 Also new in release 2.5.0 is a MIME- transformation system which is also
654 based on the following table structure. See :ref:`transformations` for
655 further information. To use the MIME- transformation system, your
656 column\_info table has to have the three new columns 'mimetype',
657 'transformation', 'transformation\_options'.
659 Starting with release 4.3.0, a new input-oriented transformation system
660 has been introduced. Also, backward compatibility code used in the old
661 transformations system was removed. As a result, an update to column\_info
662 table is necessary for previous transformations and the new input-oriented
663 transformation system to work. phpMyAdmin will upgrade it automatically
664 for you by analyzing your current column\_info table structure.
665 However, if something goes wrong with the auto-upgrade then you can
666 use the SQL script found in ``./sql/upgrade_column_info_4_3_0+.sql``
667 to upgrade it manually.
669 To allow the usage of this functionality:
671 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
672 * put the table name in :config:option:`$cfg['Servers'][$i]['column\_info']` (e.g.
673 ``pma__column_info``)
674 * to update your PRE-2.5.0 Column\_comments table use this: and
675 remember that the Variable in :file:`config.inc.php` has been renamed from
676 :config:option:`$cfg['Servers'][$i]['column\_comments']` to
677 :config:option:`$cfg['Servers'][$i]['column\_info']`
679 .. code-block:: mysql
681 ALTER TABLE `pma__column_comments`
682 ADD `mimetype` VARCHAR( 255 ) NOT NULL,
683 ADD `transformation` VARCHAR( 255 ) NOT NULL,
684 ADD `transformation_options` VARCHAR( 255 ) NOT NULL;
685 * to update your PRE-4.3.0 Column\_info table manually use this
686 ``./sql/upgrade_column_info_4_3_0+.sql`` SQL script.
688 This feature can be disabled by setting the configuration to ``false``.
692 For auto-upgrade functionality to work, your
693 ``$cfg['Servers'][$i]['controluser']`` must have ALTER privilege on
694 ``phpmyadmin`` database. See the `MySQL documentation for GRANT
695 <https://dev.mysql.com/doc/refman/5.7/en/grant.html>`_ on how to
696 ``GRANT`` privileges to a user.
699 .. config:option:: $cfg['Servers'][$i]['history']
701 :type: string or false
704 Since release 2.5.0 you can store your :term:`SQL` history, which means all
705 queries you entered manually into the phpMyAdmin interface. If you don't
706 want to use a table-based history, you can use the JavaScript-based
709 Using that, all your history items are deleted when closing the window.
710 Using :config:option:`$cfg['QueryHistoryMax']` you can specify an amount of
711 history items you want to have on hold. On every login, this list gets cut
712 to the maximum amount.
714 The query history is only available if JavaScript is enabled in
717 To allow the usage of this functionality:
719 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
720 * put the table name in :config:option:`$cfg['Servers'][$i]['history']` (e.g.
723 This feature can be disabled by setting the configuration to ``false``.
726 .. config:option:: $cfg['Servers'][$i]['recent']
728 :type: string or false
731 Since release 3.5.0 you can show recently used tables in the
732 navigation panel. It helps you to jump across table directly, without
733 the need to select the database, and then select the table. Using
734 :config:option:`$cfg['NumRecentTables']` you can configure the maximum number
735 of recent tables shown. When you select a table from the list, it will jump to
736 the page specified in :config:option:`$cfg['NavigationTreeDefaultTabTable']`.
738 Without configuring the storage, you can still access the recently used tables,
739 but it will disappear after you logout.
741 To allow the usage of this functionality persistently:
743 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
744 * put the table name in :config:option:`$cfg['Servers'][$i]['recent']` (e.g.
747 This feature can be disabled by setting the configuration to ``false``.
750 .. config:option:: $cfg['Servers'][$i]['favorite']
752 :type: string or false
755 Since release 4.2.0 you can show a list of selected tables in the
756 navigation panel. It helps you to jump to the table directly, without
757 the need to select the database, and then select the table. When you
758 select a table from the list, it will jump to the page specified in
759 :config:option:`$cfg['NavigationTreeDefaultTabTable']`.
761 You can add tables to this list or remove tables from it in database
762 structure page by clicking on the star icons next to table names. Using
763 :config:option:`$cfg['NumFavoriteTables']` you can configure the maximum
764 number of favorite tables shown.
766 Without configuring the storage, you can still access the favorite tables,
767 but it will disappear after you logout.
769 To allow the usage of this functionality persistently:
771 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
772 * put the table name in :config:option:`$cfg['Servers'][$i]['favorite']` (e.g.
775 This feature can be disabled by setting the configuration to ``false``.
778 .. config:option:: $cfg['Servers'][$i]['table_uiprefs']
780 :type: string or false
783 Since release 3.5.0 phpMyAdmin can be configured to remember several
784 things (sorted column :config:option:`$cfg['RememberSorting']`, column order,
785 and column visibility from a database table) for browsing tables. Without
786 configuring the storage, these features still can be used, but the values will
787 disappear after you logout.
789 To allow the usage of these functionality persistently:
791 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
792 * put the table name in :config:option:`$cfg['Servers'][$i]['table\_uiprefs']` (e.g.
793 ``pma__table_uiprefs``)
795 This feature can be disabled by setting the configuration to ``false``.
797 .. config:option:: $cfg['Servers'][$i]['users']
799 :type: string or false
802 .. config:option:: $cfg['Servers'][$i]['usergroups']
804 :type: string or false
807 Since release 4.1.0 you can create different user groups with menu items
808 attached to them. Users can be assigned to these groups and the logged in
809 user would only see menu items configured to the usergroup he is assigned to.
810 To do this it needs two tables "usergroups" (storing allowed menu items for each
811 user group) and "users" (storing users and their assignments to user groups).
813 To allow the usage of this functionality:
815 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
816 * put the correct table names in
817 :config:option:`$cfg['Servers'][$i]['users']` (e.g. ``pma__users``) and
818 :config:option:`$cfg['Servers'][$i]['usergroups']` (e.g. ``pma__usergroups``)
820 This feature can be disabled by setting either of the configurations to ``false``.
822 .. seealso:: :ref:`configurablemenus`
824 .. _navigationhiding:
825 .. config:option:: $cfg['Servers'][$i]['navigationhiding']
827 :type: string or false
830 Since release 4.1.0 you can hide/show items in the navigation tree.
832 To allow the usage of this functionality:
834 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
835 * put the table name in :config:option:`$cfg['Servers'][$i]['navigationhiding']` (e.g.
836 ``pma__navigationhiding``)
838 This feature can be disabled by setting the configuration to ``false``.
841 .. config:option:: $cfg['Servers'][$i]['central_columns']
843 :type: string or false
846 Since release 4.3.0 you can have a central list of columns per database.
847 You can add/remove columns to the list as per your requirement. These columns
848 in the central list will be available to use while you create a new column for
849 a table or create a table itself. You can select a column from central list
850 while creating a new column, it will save you from writing the same column definition
851 over again or from writing different names for similar column.
853 To allow the usage of this functionality:
855 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
856 * put the table name in :config:option:`$cfg['Servers'][$i]['central_columns']` (e.g.
857 ``pma__central_columns``)
859 This feature can be disabled by setting the configuration to ``false``.
861 .. _designer_settings:
862 .. config:option:: $cfg['Servers'][$i]['designer_settings']
864 :type: string or false
867 Since release 4.5.0 your designer settings can be remembered.
868 Your choice regarding 'Angular/Direct Links', 'Snap to Grid', 'Toggle Relation Lines',
869 'Small/Big All', 'Move Menu' and 'Pin Text' can be remembered persistently.
871 To allow the usage of this functionality:
873 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
874 * put the table name in :config:option:`$cfg['Servers'][$i]['designer_settings']` (e.g.
875 ``pma__designer_settings``)
877 This feature can be disabled by setting the configuration to ``false``.
880 .. config:option:: $cfg['Servers'][$i]['savedsearches']
882 :type: string or false
885 Since release 4.2.0 you can save and load query-by-example searches from the Database > Query panel.
887 To allow the usage of this functionality:
889 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
890 * put the table name in :config:option:`$cfg['Servers'][$i]['savedsearches']` (e.g.
891 ``pma__savedsearches``)
893 This feature can be disabled by setting the configuration to ``false``.
895 .. _export_templates:
896 .. config:option:: $cfg['Servers'][$i]['export_templates']
898 :type: string or false
901 Since release 4.5.0 you can save and load export templates.
903 To allow the usage of this functionality:
905 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
906 * put the table name in :config:option:`$cfg['Servers'][$i]['export_templates']` (e.g.
907 ``pma__export_templates``)
909 This feature can be disabled by setting the configuration to ``false``.
912 .. config:option:: $cfg['Servers'][$i]['tracking']
914 :type: string or false
917 Since release 3.3.x a tracking mechanism is available. It helps you to
918 track every :term:`SQL` command which is
919 executed by phpMyAdmin. The mechanism supports logging of data
920 manipulation and data definition statements. After enabling it you can
921 create versions of tables.
923 The creation of a version has two effects:
925 * phpMyAdmin saves a snapshot of the table, including structure and
927 * phpMyAdmin logs all commands which change the structure and/or data of
928 the table and links these commands with the version number.
930 Of course you can view the tracked changes. On the :guilabel:`Tracking`
931 page a complete report is available for every version. For the report you
932 can use filters, for example you can get a list of statements within a date
933 range. When you want to filter usernames you can enter \* for all names or
934 you enter a list of names separated by ','. In addition you can export the
935 (filtered) report to a file or to a temporary database.
937 To allow the usage of this functionality:
939 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
940 * put the table name in :config:option:`$cfg['Servers'][$i]['tracking']` (e.g.
943 This feature can be disabled by setting the configuration to ``false``.
946 .. config:option:: $cfg['Servers'][$i]['tracking_version_auto_create']
951 Whether the tracking mechanism creates versions for tables and views
954 If this is set to true and you create a table or view with
959 and no version exists for it, the mechanism will create a version for
963 .. config:option:: $cfg['Servers'][$i]['tracking_default_statements']
966 :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'``
968 Defines the list of statements the auto-creation uses for new
972 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_view']
977 Whether a DROP VIEW IF EXISTS statement will be added as first line to
978 the log when creating a view.
981 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_table']
986 Whether a DROP TABLE IF EXISTS statement will be added as first line
987 to the log when creating a table.
990 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_database']
995 Whether a DROP DATABASE IF EXISTS statement will be added as first
996 line to the log when creating a database.
999 .. config:option:: $cfg['Servers'][$i]['userconfig']
1001 :type: string or false
1004 Since release 3.4.x phpMyAdmin allows users to set most preferences by
1005 themselves and store them in the database.
1007 If you don't allow for storing preferences in
1008 :config:option:`$cfg['Servers'][$i]['pmadb']`, users can still personalize
1009 phpMyAdmin, but settings will be saved in browser's local storage, or, it
1010 is is unavailable, until the end of session.
1012 To allow the usage of this functionality:
1014 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
1015 * put the table name in :config:option:`$cfg['Servers'][$i]['userconfig']`
1017 This feature can be disabled by setting the configuration to ``false``.
1019 .. config:option:: $cfg['Servers'][$i]['MaxTableUiprefs']
1024 Maximum number of rows saved in
1025 :config:option:`$cfg['Servers'][$i]['table_uiprefs']` table.
1027 When tables are dropped or renamed,
1028 :config:option:`$cfg['Servers'][$i]['table_uiprefs']` may contain invalid data
1029 (referring to tables which no longer exist). We only keep this number of newest
1030 rows in :config:option:`$cfg['Servers'][$i]['table_uiprefs']` and automatically
1033 .. config:option:: $cfg['Servers'][$i]['SessionTimeZone']
1038 Sets the time zone used by phpMyAdmin. Leave blank to use the time zone of your
1039 database server. Possible values are explained at
1040 https://dev.mysql.com/doc/refman/5.7/en/time-zone-support.html
1042 This is useful when your database server uses a time zone which is different from the
1043 time zone you want to use in phpMyAdmin.
1045 .. config:option:: $cfg['Servers'][$i]['AllowRoot']
1050 Whether to allow root access. This is just a shortcut for the
1051 :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` below.
1053 .. config:option:: $cfg['Servers'][$i]['AllowNoPassword']
1058 Whether to allow logins without a password. The default value of
1059 ``false`` for this parameter prevents unintended access to a MySQL
1060 server with was left with an empty password for root or on which an
1061 anonymous (blank) user is defined.
1063 .. _servers_allowdeny_order:
1064 .. config:option:: $cfg['Servers'][$i]['AllowDeny']['order']
1069 If your rule order is empty, then :term:`IP`
1070 authorization is disabled.
1072 If your rule order is set to
1073 ``'deny,allow'`` then the system applies all deny rules followed by
1074 allow rules. Access is allowed by default. Any client which does not
1075 match a Deny command or does match an Allow command will be allowed
1076 access to the server.
1078 If your rule order is set to ``'allow,deny'``
1079 then the system applies all allow rules followed by deny rules. Access
1080 is denied by default. Any client which does not match an Allow
1081 directive or does match a Deny directive will be denied access to the
1084 If your rule order is set to ``'explicit'``, authorization is
1085 performed in a similar fashion to rule order 'deny,allow', with the
1086 added restriction that your host/username combination **must** be
1087 listed in the *allow* rules, and not listed in the *deny* rules. This
1088 is the **most** secure means of using Allow/Deny rules, and was
1089 available in Apache by specifying allow and deny rules without setting
1092 Please also see :config:option:`$cfg['TrustedProxies']` for
1093 detecting IP address behind proxies.
1095 .. _servers_allowdeny_rules:
1096 .. config:option:: $cfg['Servers'][$i]['AllowDeny']['rules']
1098 :type: array of strings
1101 The general format for the rules is as such:
1103 .. code-block:: none
1105 <'allow' | 'deny'> <username> [from] <ipmask>
1107 If you wish to match all users, it is possible to use a ``'%'`` as a
1108 wildcard in the *username* field.
1110 There are a few shortcuts you can
1111 use in the *ipmask* field as well (please note that those containing
1112 SERVER\_ADDRESS might not be available on all webservers):
1114 .. code-block:: none
1118 'localhost' -> 127.0.0.1/8
1119 'localnetA' -> SERVER_ADDRESS/8
1120 'localnetB' -> SERVER_ADDRESS/16
1121 'localnetC' -> SERVER_ADDRESS/24
1123 Having an empty rule list is equivalent to either using ``'allow %
1124 from all'`` if your rule order is set to ``'deny,allow'`` or ``'deny %
1125 from all'`` if your rule order is set to ``'allow,deny'`` or
1128 For the :term:`IP address` matching
1129 system, the following work:
1131 * ``xxx.xxx.xxx.xxx`` (an exact :term:`IP address`)
1132 * ``xxx.xxx.xxx.[yyy-zzz]`` (an :term:`IP address` range)
1133 * ``xxx.xxx.xxx.xxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IP` addresses)
1135 But the following does not work:
1137 * ``xxx.xxx.xxx.xx[yyy-zzz]`` (partial :term:`IP` address range)
1139 For :term:`IPv6` addresses, the following work:
1141 * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx`` (an exact :term:`IPv6` address)
1142 * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:[yyyy-zzzz]`` (an :term:`IPv6` address range)
1143 * ``xxxx:xxxx:xxxx:xxxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IPv6` addresses)
1145 But the following does not work:
1147 * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xx[yyy-zzz]`` (partial :term:`IPv6` address range)
1149 .. config:option:: $cfg['Servers'][$i]['DisableIS']
1154 Disable using ``INFORMATION_SCHEMA`` to retrieve information (use
1155 ``SHOW`` commands instead), because of speed issues when many
1156 databases are present. Currently used in some parts of the code, more
1159 .. config:option:: $cfg['Servers'][$i]['SignonScript']
1164 Name of PHP script to be sourced and executed to obtain login
1165 credentials. This is alternative approach to session based single
1166 signon. The script has to provide a function called
1167 ``get_login_credentials`` which returns list of username and
1168 password, accepting single parameter of existing username (can be
1169 empty). See :file:`examples/signon-script.php` for an example:
1171 .. literalinclude:: ../examples/signon-script.php
1174 .. seealso:: :ref:`auth_signon`
1176 .. config:option:: $cfg['Servers'][$i]['SignonSession']
1181 Name of session which will be used for signon authentication method.
1182 You should use something different than ``phpMyAdmin``, because this
1183 is session which phpMyAdmin uses internally. Takes effect only if
1184 :config:option:`$cfg['Servers'][$i]['SignonScript']` is not configured.
1186 .. seealso:: :ref:`auth_signon`
1188 .. config:option:: $cfg['Servers'][$i]['SignonURL']
1193 :term:`URL` where user will be redirected
1194 to log in for signon authentication method. Should be absolute
1197 .. seealso:: :ref:`auth_signon`
1199 .. config:option:: $cfg['Servers'][$i]['LogoutURL']
1204 :term:`URL` where user will be redirected
1205 after logout (doesn't affect config authentication method). Should be
1206 absolute including protocol.
1211 .. config:option:: $cfg['ServerDefault']
1216 If you have more than one server configured, you can set
1217 :config:option:`$cfg['ServerDefault']` to any one of them to autoconnect to that
1218 server when phpMyAdmin is started, or set it to 0 to be given a list
1219 of servers without logging in.
1221 If you have only one server configured,
1222 :config:option:`$cfg['ServerDefault']` MUST be set to that server.
1224 .. config:option:: $cfg['VersionCheck']
1229 Enables check for latest versions using JavaScript on the main phpMyAdmin
1230 page or by directly accessing :file:`version_check.php`.
1234 This setting can be adjusted by your vendor.
1236 .. config:option:: $cfg['ProxyUrl']
1241 The url of the proxy to be used when phpmyadmin needs to access the outside
1242 internet such as when retrieving the latest version info or submitting error
1243 reports. You need this if the server where phpMyAdmin is installed does not
1244 have direct access to the internet.
1245 The format is: "hostname:portnumber"
1247 .. config:option:: $cfg['ProxyUser']
1252 The username for authenticating with the proxy. By default, no
1253 authentication is performed. If a username is supplied, Basic
1254 Authentication will be performed. No other types of authentication
1255 are currently supported.
1257 .. config:option:: $cfg['ProxyPass']
1262 The password for authenticating with the proxy.
1264 .. config:option:: $cfg['MaxDbList']
1269 The maximum number of database names to be displayed in the main panel's
1272 .. config:option:: $cfg['MaxTableList']
1277 The maximum number of table names to be displayed in the main panel's
1278 list (except on the Export page).
1280 .. config:option:: $cfg['ShowHint']
1285 Whether or not to show hints (for example, hints when hovering over
1288 .. config:option:: $cfg['MaxCharactersInDisplayedSQL']
1293 The maximum number of characters when a :term:`SQL` query is displayed. The
1294 default limit of 1000 should be correct to avoid the display of tons of
1295 hexadecimal codes that represent BLOBs, but some users have real
1296 :term:`SQL` queries that are longer than 1000 characters. Also, if a
1297 query's length exceeds this limit, this query is not saved in the history.
1299 .. config:option:: $cfg['PersistentConnections']
1304 Whether `persistent connections <https://php.net/manual/en/features
1305 .persistent-connections.php>`_ should be used or not. Works with
1306 following extensions:
1308 * mysql (`mysql\_pconnect <https://php.net/manual/en/function.mysql-
1310 * mysqli (requires PHP 5.3.0 or newer, `more information
1311 <https://php.net/manual/en/mysqli.persistconns.php>`_).
1313 .. config:option:: $cfg['ForceSSL']
1318 .. deprecated:: 4.6.0
1320 This setting is no longer available since phpMyAdmin 4.6.0. Please
1321 adjust your webserver instead.
1323 Whether to force using https while accessing phpMyAdmin. In a reverse
1324 proxy setup, setting this to ``true`` is not supported.
1328 In some setups (like separate SSL proxy or load balancer) you might
1329 have to set :config:option:`$cfg['PmaAbsoluteUri']` for correct
1332 .. config:option:: $cfg['ExecTimeLimit']
1334 :type: integer [number of seconds]
1337 Set the number of seconds a script is allowed to run. If seconds is
1338 set to zero, no time limit is imposed. This setting is used while
1339 importing/exporting dump files but has
1340 no effect when PHP is running in safe mode.
1342 .. config:option:: $cfg['SessionSavePath']
1347 Path for storing session data (`session\_save\_path PHP parameter
1348 <https://php.net/session_save_path>`_).
1350 .. config:option:: $cfg['MemoryLimit']
1352 :type: string [number of bytes]
1355 Set the number of bytes a script is allowed to allocate. If set to
1356 ``'-1'``, no limit is imposed. If set to ``'0'``, no change of the
1357 memory limit is attempted and the :file:`php.ini` ``memory_limit`` is
1360 This setting is used while importing/exporting dump files
1361 so you definitely don't want to put here a too low
1362 value. It has no effect when PHP is running in safe mode.
1364 You can also use any string as in :file:`php.ini`, eg. '16M'. Ensure you
1365 don't omit the suffix (16 means 16 bytes!)
1367 .. config:option:: $cfg['SkipLockedTables']
1372 Mark used tables and make it possible to show databases with locked
1373 tables (since MySQL 3.23.30).
1375 .. config:option:: $cfg['ShowSQL']
1380 Defines whether :term:`SQL` queries
1381 generated by phpMyAdmin should be displayed or not.
1383 .. config:option:: $cfg['RetainQueryBox']
1388 Defines whether the :term:`SQL` query box
1389 should be kept displayed after its submission.
1391 .. config:option:: $cfg['CodemirrorEnable']
1396 Defines whether to use a Javascript code editor for SQL query boxes.
1397 CodeMirror provides syntax highlighting and line numbers. However,
1398 middle-clicking for pasting the clipboard contents in some Linux
1399 distributions (such as Ubuntu) is not supported by all browsers.
1401 .. config:option:: $cfg['DefaultForeignKeyChecks']
1404 :default: ``'default'``
1406 Default value of the checkbox for foreign key checks, to disable/enable
1407 foreign key checks for certain queries. The possible values are ``'default'``,
1408 ``'enable'`` or ``'disable'``. If set to ``'default'``, the value of the
1409 MySQL variable ``FOREIGN_KEY_CHECKS`` is used.
1411 .. config:option:: $cfg['AllowUserDropDatabase']
1418 This is not a security measure as there will be always ways to
1419 circumvent this. If you want to prohibit users from dropping databases,
1420 revoke their corresponding DROP privilege.
1422 Defines whether normal users (non-administrator) are allowed to delete
1423 their own database or not. If set as false, the link :guilabel:`Drop
1424 Database` will not be shown, and even a ``DROP DATABASE mydatabase`` will
1425 be rejected. Quite practical for :term:`ISP` 's with many customers.
1427 This limitation of :term:`SQL` queries is not as strict as when using MySQL
1428 privileges. This is due to nature of :term:`SQL` queries which might be
1429 quite complicated. So this choice should be viewed as help to avoid
1430 accidental dropping rather than strict privilege limitation.
1432 .. config:option:: $cfg['Confirm']
1437 Whether a warning ("Are your really sure...") should be displayed when
1438 you're about to lose data.
1440 .. config:option:: $cfg['UseDbSearch']
1445 Define whether the "search string inside database" is enabled or not.
1447 .. config:option:: $cfg['IgnoreMultiSubmitErrors']
1452 Define whether phpMyAdmin will continue executing a multi-query
1453 statement if one of the queries fails. Default is to abort execution.
1455 Cookie authentication options
1456 -----------------------------
1458 .. config:option:: $cfg['blowfish_secret']
1463 The "cookie" auth\_type uses AES algorithm to encrypt the password. If you
1464 are using the "cookie" auth\_type, enter here a random passphrase of your
1465 choice. It will be used internally by the AES algorithm: you won’t be
1466 prompted for this passphrase.
1468 The secret should be 32 characters long. Using shorter will lead to weaker security
1469 of encrypted cookies, using longer will cause no harm.
1473 The configuration is called blowfish_secret for historical reasons as
1474 Blowfish algorithm was originally used to do the encryption.
1476 .. versionchanged:: 3.1.0
1477 Since version 3.1.0 phpMyAdmin can generate this on the fly, but it
1478 makes a bit weaker security as this generated secret is stored in
1479 session and furthermore it makes impossible to recall user name from
1482 .. config:option:: $cfg['LoginCookieRecall']
1487 Define whether the previous login should be recalled or not in cookie
1488 authentication mode.
1490 This is automatically disabled if you do not have
1491 configured :config:option:`$cfg['blowfish_secret']`.
1493 .. config:option:: $cfg['LoginCookieValidity']
1495 :type: integer [number of seconds]
1498 Define how long a login cookie is valid. Please note that php
1499 configuration option `session.gc\_maxlifetime
1500 <https://php.net/manual/en/session.configuration.php#ini.session.gc-
1501 maxlifetime>`_ might limit session validity and if the session is lost,
1502 the login cookie is also invalidated. So it is a good idea to set
1503 ``session.gc_maxlifetime`` at least to the same value of
1504 :config:option:`$cfg['LoginCookieValidity']`.
1506 .. config:option:: $cfg['LoginCookieStore']
1508 :type: integer [number of seconds]
1511 Define how long login cookie should be stored in browser. Default 0
1512 means that it will be kept for existing session. This is recommended
1513 for not trusted environments.
1515 .. config:option:: $cfg['LoginCookieDeleteAll']
1520 If enabled (default), logout deletes cookies for all servers,
1521 otherwise only for current one. Setting this to false makes it easy to
1522 forget to log out from other server, when you are using more of them.
1524 .. _AllowArbitraryServer:
1525 .. config:option:: $cfg['AllowArbitraryServer']
1530 If enabled, allows you to log in to arbitrary servers using cookie
1535 Please use this carefully, as this may allow users access to MySQL servers
1536 behind the firewall where your :term:`HTTP` server is placed.
1537 See also :config:option:`$cfg['ArbitraryServerRegexp']`.
1539 .. config:option:: $cfg['ArbitraryServerRegexp']
1544 Restricts the MySQL servers to which the user can log in when
1545 :config:option:`$cfg['AllowArbitraryServer']` is enabled by
1546 matching the :term:`IP` or the hostname of the MySQL server
1547 to the given regular expression. The regular expression must be enclosed
1548 with a delimiter character.
1550 It is recommended to include start and end symbols in the regullar
1551 expression, so that you can avoid partial matches on the string.
1557 // Allow connection to three listed servers:
1558 $cfg['ArbitraryServerRegexp'] = '/^(server|another|yetdifferent)$/';
1560 // Allow connection to range of IP addresses:
1561 $cfg['ArbitraryServerRegexp'] = '@^192\.168\.0\.[0-9]{1,}$@';
1563 // Allow connection to server name ending with -mysql:
1564 $cfg['ArbitraryServerRegexp'] = '@^[^:]\-mysql$@';
1568 The whole server name is matched, it can include port as well. Due to
1569 way MySQL is permissive in connection parameters, it is possible to use
1570 connection strings as ```server:3306-mysql```. This can be used to
1571 bypass regullar expression by the suffix, while connecting to another
1574 .. config:option:: $cfg['CaptchaLoginPublicKey']
1579 The public key for the reCaptcha service that can be obtained from
1580 https://www.google.com/recaptcha/intro/.
1582 reCaptcha will be then used in :ref:`cookie`.
1584 .. config:option:: $cfg['CaptchaLoginPrivateKey']
1589 The private key for the reCaptcha service that can be obtain from
1590 https://www.google.com/recaptcha/intro/.
1592 reCaptcha will be then used in :ref:`cookie`.
1594 Navigation panel setup
1595 ----------------------
1597 .. config:option:: $cfg['ShowDatabasesNavigationAsTree']
1602 In the navigation panel, replaces the database tree with a selector
1604 .. config:option:: $cfg['FirstLevelNavigationItems']
1609 The number of first level databases that can be displayed on each page
1612 .. config:option:: $cfg['MaxNavigationItems']
1617 The number of items (tables, columns, indexes) that can be displayed on each
1618 page of the navigation tree.
1620 .. config:option:: $cfg['NavigationTreeEnableGrouping']
1625 Defines whether to group the databases based on a common prefix
1626 in their name :config:option:`$cfg['NavigationTreeDbSeparator']`.
1628 .. config:option:: $cfg['NavigationTreeDbSeparator']
1633 The string used to separate the parts of the database name when
1634 showing them in a tree.
1636 .. config:option:: $cfg['NavigationTreeTableSeparator']
1638 :type: string or array
1641 Defines a string to be used to nest table spaces. This means if you have
1642 tables like ``first__second__third`` this will be shown as a three-level
1643 hierarchy like: first > second > third. If set to false or empty, the
1644 feature is disabled. NOTE: You should not use this separator at the
1645 beginning or end of a table name or multiple times after another without
1646 any other characters in between.
1648 .. config:option:: $cfg['NavigationTreeTableLevel']
1653 Defines how many sublevels should be displayed when splitting up
1654 tables by the above separator.
1656 .. config:option:: $cfg['NumRecentTables']
1661 The maximum number of recently used tables shown in the navigation
1662 panel. Set this to 0 (zero) to disable the listing of recent tables.
1664 .. config:option:: $cfg['NumFavoriteTables']
1669 The maximum number of favorite tables shown in the navigation
1670 panel. Set this to 0 (zero) to disable the listing of favorite tables.
1672 .. config:option:: $cfg['ZeroConf']
1677 Enables Zero Configuration mode in which the user will be offered a choice to
1678 create phpMyAdmin configuration storage in the current database
1679 or use the existing one, if already present.
1681 This setting has no effect if the phpMyAdmin configuration storage database
1682 is properly created and the related configuration directives (such as
1683 :config:option:`$cfg['Servers'][$i]['pmadb']` and so on) are configured.
1685 .. config:option:: $cfg['NavigationLinkWithMainPanel']
1690 Defines whether or not to link with main panel by highlighting
1691 the current database or table.
1693 .. config:option:: $cfg['NavigationDisplayLogo']
1698 Defines whether or not to display the phpMyAdmin logo at the top of
1699 the navigation panel.
1701 .. config:option:: $cfg['NavigationLogoLink']
1704 :default: ``'index.php'``
1706 Enter :term:`URL` where logo in the navigation panel will point to.
1707 For use especially with self made theme which changes this.
1708 For external URLs, you should include URL scheme as well.
1710 .. config:option:: $cfg['NavigationLogoLinkWindow']
1713 :default: ``'main'``
1715 Whether to open the linked page in the main window (``main``) or in a
1716 new one (``new``). Note: use ``new`` if you are linking to
1719 .. config:option:: $cfg['NavigationTreeDisplayItemFilterMinimum']
1724 Defines the minimum number of items (tables, views, routines and
1725 events) to display a JavaScript filter box above the list of items in
1726 the navigation tree.
1728 To disable the filter completely some high number can be used (e.g. 9999)
1730 .. config:option:: $cfg['NavigationTreeDisplayDbFilterMinimum']
1735 Defines the minimum number of databases to display a JavaScript filter
1736 box above the list of databases in the navigation tree.
1738 To disable the filter completely some high number can be used
1741 .. config:option:: $cfg['NavigationDisplayServers']
1746 Defines whether or not to display a server choice at the top of the
1749 .. config:option:: $cfg['DisplayServersList']
1754 Defines whether to display this server choice as links instead of in a
1757 .. config:option:: $cfg['NavigationTreeDefaultTabTable']
1760 :default: ``'structure'``
1762 Defines the tab displayed by default when clicking the small icon next
1763 to each table name in the navigation panel. The possible values are the
1764 localized equivalent of:
1772 .. config:option:: $cfg['NavigationTreeDefaultTabTable2']
1777 Defines the tab displayed by default when clicking the second small icon next
1778 to each table name in the navigation panel. The possible values are the
1779 localized equivalent of:
1788 .. config:option:: $cfg['NavigationTreeEnableExpansion']
1793 Whether to offer the possibility of tree expansion in the navigation panel.
1795 .. config:option:: $cfg['NavigationTreeShowTables']
1800 Whether to show tables under database in the navigation panel.
1802 .. config:option:: $cfg['NavigationTreeShowViews']
1807 Whether to show views under database in the navigation panel.
1809 .. config:option:: $cfg['NavigationTreeShowFunctions']
1814 Whether to show functions under database in the navigation panel.
1816 .. config:option:: $cfg['NavigationTreeShowProcedures']
1821 Whether to show procedures under database in the navigation panel.
1823 .. config:option:: $cfg['NavigationTreeShowEvents']
1828 Whether to show events under database in the navigation panel.
1834 .. config:option:: $cfg['ShowStats']
1839 Defines whether or not to display space usage and statistics about
1840 databases and tables. Note that statistics requires at least MySQL
1841 3.23.3 and that, at this date, MySQL doesn't return such information
1842 for Berkeley DB tables.
1844 .. config:option:: $cfg['ShowServerInfo']
1849 Defines whether to display detailed server information on main page.
1850 You can additionally hide more information by using
1851 :config:option:`$cfg['Servers'][$i]['verbose']`.
1853 .. config:option:: $cfg['ShowChgPassword']
1858 .. config:option:: $cfg['ShowCreateDb']
1863 Defines whether to display the
1864 :guilabel:`Change password` links and form for creating database or not at
1865 the starting main (right) frame. This setting does not check MySQL commands
1868 Also note that enabling the :guilabel:`Change password` link has no effect
1869 with config authentication mode: because of the hard coded password value
1870 in the configuration file, end users can't be allowed to change their
1873 .. config:option:: $cfg['ShowGitRevision']
1878 Defines whether to display informations about the current Git revision (if
1879 applicable) on the main panel.
1881 .. config:option:: $cfg['MysqlMinVersion']
1885 Defines the minimum supported MySQL version. The default is chosen
1886 by the phpMyAdmin team; however this directive was asked by a developer
1887 of the Plesk control panel to ease integration with older MySQL servers
1888 (where most of the phpMyAdmin features work).
1893 .. config:option:: $cfg['ShowDbStructureCreation']
1898 Defines whether the database structure page (tables list) has a
1899 "Creation" column that displays when each table was created.
1901 .. config:option:: $cfg['ShowDbStructureLastUpdate']
1906 Defines whether the database structure page (tables list) has a "Last
1907 update" column that displays when each table was last updated.
1909 .. config:option:: $cfg['ShowDbStructureLastCheck']
1914 Defines whether the database structure page (tables list) has a "Last
1915 check" column that displays when each table was last checked.
1917 .. config:option:: $cfg['HideStructureActions']
1922 Defines whether the table structure actions are hidden under a "More"
1928 .. config:option:: $cfg['TableNavigationLinksMode']
1931 :default: ``'icons'``
1933 Defines whether the table navigation links contain ``'icons'``, ``'text'``
1936 .. config:option:: $cfg['ActionLinksMode']
1939 :default: ``'both'``
1941 If set to ``icons``, will display icons instead of text for db and table
1942 properties links (like :guilabel:`Browse`, :guilabel:`Select`,
1943 :guilabel:`Insert`, ...). Can be set to ``'both'``
1944 if you want icons AND text. When set to ``text``, will only show text.
1946 .. config:option:: $cfg['RowActionType']
1949 :default: ``'both'``
1951 Whether to display icons or text or both icons and text in table row action
1952 segment. Value can be either of ``'icons'``, ``'text'`` or ``'both'``.
1954 .. config:option:: $cfg['ShowAll']
1959 Defines whether a user should be displayed a "Show all" button in browse
1960 mode or not in all cases. By default it is shown only on small tables (less
1961 than 500 rows) to avoid performance issues while getting too many rows.
1963 .. config:option:: $cfg['MaxRows']
1968 Number of rows displayed when browsing a result set and no LIMIT
1969 clause is used. If the result set contains more rows, "Previous" and
1970 "Next" links will be shown. Possible values: 25,50,100,250,500.
1972 .. config:option:: $cfg['Order']
1975 :default: ``'SMART'``
1977 Defines whether columns are displayed in ascending (``ASC``) order, in
1978 descending (``DESC``) order or in a "smart" (``SMART``) order - I.E.
1979 descending order for columns of type TIME, DATE, DATETIME and
1980 TIMESTAMP, ascending order else- by default.
1982 .. config:option:: $cfg['GridEditing']
1985 :default: ``'double-click'``
1987 Defines which action (``double-click`` or ``click``) triggers grid
1988 editing. Can be deactivated with the ``disabled`` value.
1990 .. config:option:: $cfg['RelationalDisplay']
1995 Defines the initial behavior for Options > Relational. ``K``, which
1996 is the default, displays the key while ``D`` shows the display column.
1998 .. config:option:: $cfg['SaveCellsAtOnce']
2003 Defines whether or not to save all edited cells at once for grid
2009 .. config:option:: $cfg['ProtectBinary']
2011 :type: boolean or string
2012 :default: ``'blob'``
2014 Defines whether ``BLOB`` or ``BINARY`` columns are protected from
2015 editing when browsing a table's content. Valid values are:
2017 * ``false`` to allow editing of all columns;
2018 * ``'blob'`` to allow editing of all columns except ``BLOBS``;
2019 * ``'noblob'`` to disallow editing of all columns except ``BLOBS`` (the
2020 opposite of ``'blob'``);
2021 * ``'all'`` to disallow editing of all ``BINARY`` or ``BLOB`` columns.
2023 .. config:option:: $cfg['ShowFunctionFields']
2028 Defines whether or not MySQL functions fields should be initially
2029 displayed in edit/insert mode. Since version 2.10, the user can toggle
2030 this setting from the interface.
2032 .. config:option:: $cfg['ShowFieldTypesInDataEditView']
2037 Defines whether or not type fields should be initially displayed in
2038 edit/insert mode. The user can toggle this setting from the interface.
2040 .. config:option:: $cfg['InsertRows']
2045 Defines the maximum number of concurrent entries for the Insert page.
2047 .. config:option:: $cfg['ForeignKeyMaxLimit']
2052 If there are fewer items than this in the set of foreign keys, then a
2053 drop-down box of foreign keys is presented, in the style described by
2054 the :config:option:`$cfg['ForeignKeyDropdownOrder']` setting.
2056 .. config:option:: $cfg['ForeignKeyDropdownOrder']
2059 :default: array('content-id', 'id-content')
2061 For the foreign key drop-down fields, there are several methods of
2062 display, offering both the key and value data. The contents of the
2063 array should be one or both of the following strings: ``content-id``,
2066 Export and import settings
2067 --------------------------
2069 .. config:option:: $cfg['ZipDump']
2074 .. config:option:: $cfg['GZipDump']
2079 .. config:option:: $cfg['BZipDump']
2084 Defines whether to allow the use of zip/GZip/BZip2 compression when
2085 creating a dump file
2087 .. config:option:: $cfg['CompressOnFly']
2092 Defines whether to allow on the fly compression for GZip/BZip2
2093 compressed exports. This doesn't affect smaller dumps and allows users
2094 to create larger dumps that won't otherwise fit in memory due to php
2095 memory limit. Produced files contain more GZip/BZip2 headers, but all
2096 normal programs handle this correctly.
2098 .. config:option:: $cfg['Export']
2101 :default: array(...)
2103 In this array are defined default parameters for export, names of
2104 items are similar to texts seen on export page, so you can easily
2105 identify what they mean.
2107 .. config:option:: $cfg['Export']['method']
2110 :default: ``'quick'``
2112 Defines how the export form is displayed when it loads. Valid values
2115 * ``quick`` to display the minimum number of options to configure
2116 * ``custom`` to display every available option to configure
2117 * ``custom-no-form`` same as ``custom`` but does not display the option
2118 of using quick export
2122 .. config:option:: $cfg['Import']
2125 :default: array(...)
2127 In this array are defined default parameters for import, names of
2128 items are similar to texts seen on import page, so you can easily
2129 identify what they mean.
2132 Tabs display settings
2133 ---------------------
2135 .. config:option:: $cfg['TabsMode']
2138 :default: ``'both'``
2140 Defines whether the menu tabs contain ``'icons'``, ``'text'`` or ``'both'``.
2142 .. config:option:: $cfg['PropertiesNumColumns']
2147 How many columns will be utilized to display the tables on the database
2148 property view? When setting this to a value larger than 1, the type of the
2149 database will be omitted for more display space.
2151 .. config:option:: $cfg['DefaultTabServer']
2154 :default: ``'welcome'``
2156 Defines the tab displayed by default on server view. The possible values
2157 are the localized equivalent of:
2159 * ``welcome`` (recommended for multi-user setups)
2165 .. config:option:: $cfg['DefaultTabDatabase']
2168 :default: ``'structure'``
2170 Defines the tab displayed by default on database view. The possible values
2171 are the localized equivalent of:
2178 .. config:option:: $cfg['DefaultTabTable']
2181 :default: ``'browse'``
2183 Defines the tab displayed by default on table view. The possible values
2184 are the localized equivalent of:
2195 .. config:option:: $cfg['PDFPageSizes']
2198 :default: ``array('A3', 'A4', 'A5', 'letter', 'legal')``
2200 Array of possible paper sizes for creating PDF pages.
2202 You should never need to change this.
2204 .. config:option:: $cfg['PDFDefaultPageSize']
2209 Default page size to use when creating PDF pages. Valid values are any
2210 listed in :config:option:`$cfg['PDFPageSizes']`.
2215 .. config:option:: $cfg['DefaultLang']
2220 Defines the default language to use, if not browser-defined or user-
2221 defined. The corresponding language file needs to be in
2222 locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
2224 .. config:option:: $cfg['DefaultConnectionCollation']
2227 :default: ``'utf8_general_ci'``
2229 Defines the default connection collation to use, if not user-defined.
2230 See the `MySQL documentation for charsets
2231 <https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html>`_
2232 for list of possible values.
2234 .. config:option:: $cfg['Lang']
2239 Force language to use. The corresponding language file needs to be in
2240 locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
2242 .. config:option:: $cfg['FilterLanguages']
2247 Limit list of available languages to those matching the given regular
2248 expression. For example if you want only Czech and English, you should
2249 set filter to ``'^(cs|en)'``.
2251 .. config:option:: $cfg['RecodingEngine']
2254 :default: ``'auto'``
2256 You can select here which functions will be used for character set
2257 conversion. Possible values are:
2259 * auto - automatically use available one (first is tested iconv, then
2261 * iconv - use iconv or libiconv functions
2262 * recode - use recode\_string function
2263 * mb - use mbstring extension
2264 * none - disable encoding conversion
2266 Enabled charset conversion activates a pull-down menu in the Export
2267 and Import pages, to choose the character set when exporting a file.
2268 The default value in this menu comes from
2269 :config:option:`$cfg['Export']['charset']` and :config:option:`$cfg['Import']['charset']`.
2271 .. config:option:: $cfg['IconvExtraParams']
2274 :default: ``'//TRANSLIT'``
2276 Specify some parameters for iconv used in charset conversion. See
2277 `iconv documentation <https://www.gnu.org/software/libiconv/documentati
2278 on/libiconv/iconv_open.3.html>`_ for details. By default
2279 ``//TRANSLIT`` is used, so that invalid characters will be
2282 .. config:option:: $cfg['AvailableCharsets']
2285 :default: array(...)
2287 Available character sets for MySQL conversion. You can add your own
2288 (any of supported by recode/iconv) or remove these which you don't
2289 use. Character sets will be shown in same order as here listed, so if
2290 you frequently use some of these move them to the top.
2295 .. config:option:: $cfg['OBGzip']
2297 :type: string/boolean
2298 :default: ``'auto'``
2300 Defines whether to use GZip output buffering for increased speed in
2301 :term:`HTTP` transfers. Set to
2302 true/false for enabling/disabling. When set to 'auto' (string),
2303 phpMyAdmin tries to enable output buffering and will automatically
2304 disable it if your browser has some problems with buffering. IE6 with
2305 a certain patch is known to cause data corruption when having enabled
2308 .. config:option:: $cfg['TrustedProxies']
2313 Lists proxies and HTTP headers which are trusted for
2314 :config:option:`$cfg['Servers'][$i]['AllowDeny']['order']`. This list is by
2315 default empty, you need to fill in some trusted proxy servers if you
2316 want to use rules for IP addresses behind proxy.
2318 The following example specifies that phpMyAdmin should trust a
2319 HTTP\_X\_FORWARDED\_FOR (``X -Forwarded-For``) header coming from the proxy
2324 $cfg['TrustedProxies'] = array('1.2.3.4' => 'HTTP_X_FORWARDED_FOR');
2326 The :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` directive uses the
2327 client's IP address as usual.
2329 .. config:option:: $cfg['GD2Available']
2332 :default: ``'auto'``
2334 Specifies whether GD >= 2 is available. If yes it can be used for MIME
2335 transformations. Possible values are:
2337 * auto - automatically detect
2338 * yes - GD 2 functions can be used
2339 * no - GD 2 function cannot be used
2341 .. config:option:: $cfg['CheckConfigurationPermissions']
2346 We normally check the permissions on the configuration file to ensure
2347 it's not world writable. However, phpMyAdmin could be installed on a
2348 NTFS filesystem mounted on a non-Windows server, in which case the
2349 permissions seems wrong but in fact cannot be detected. In this case a
2350 sysadmin would set this parameter to ``false``.
2352 .. config:option:: $cfg['LinkLengthLimit']
2357 Limit for length of :term:`URL` in links. When length would be above this
2358 limit, it is replaced by form with button. This is required as some web
2359 servers (:term:`IIS`) have problems with long :term:`URL` .
2361 .. config:option:: $cfg['CSPAllow']
2366 Additional string to include in allowed script and image sources in Content
2367 Security Policy header.
2369 This can be useful when you want to include some external JavaScript files
2370 in :file:`config.footer.inc.php` or :file:`config.header.inc.php`, which
2371 would be normally not allowed by Content Security Policy.
2373 To allow some sites, just list them within the string:
2377 $cfg['CSPAllow'] = 'example.com example.net';
2379 .. versionadded:: 4.0.4
2381 .. config:option:: $cfg['DisableMultiTableMaintenance']
2386 In the database Structure page, it's possible to mark some tables then
2387 choose an operation like optimizing for many tables. This can slow
2388 down a server; therefore, setting this to ``true`` prevents this kind
2389 of multiple maintenance operation.
2394 Please directly modify :file:`themes/themename/layout.inc.php`, although
2395 your changes will be overwritten with the next update.
2397 Design customization
2398 --------------------
2400 .. config:option:: $cfg['NavigationTreePointerEnable']
2405 When set to true, hovering over an item in the navigation panel causes that item to be marked
2406 (the background is highlighted).
2408 .. config:option:: $cfg['BrowsePointerEnable']
2413 When set to true, hovering over a row in the Browse page causes that row to be marked (the background
2416 .. config:option:: $cfg['BrowseMarkerEnable']
2421 When set to true, a data row is marked (the background is highlighted) when the row is selected
2424 .. config:option:: $cfg['LimitChars']
2429 Maximum number of characters shown in any non-numeric field on browse
2430 view. Can be turned off by a toggle button on the browse page.
2432 .. config:option:: $cfg['RowActionLinks']
2435 :default: ``'left'``
2437 Defines the place where table row links (Edit, Copy, Delete) would be
2438 put when tables contents are displayed (you may have them displayed at
2439 the left side, right side, both sides or nowhere).
2441 .. config:option:: $cfg['RowActionLinksWithoutUnique']
2446 Defines whether to show row links (Edit, Copy, Delete) and checkboxes
2447 for multiple row operations even when the selection does not have a unique key.
2448 Using row actions in the absence of a unique key may result in different/more
2449 rows being affected since there is no guaranteed way to select the exact row(s).
2451 .. config:option:: $cfg['RememberSorting']
2456 If enabled, remember the sorting of each table when browsing them.
2458 .. config:option:: $cfg['TablePrimaryKeyOrder']
2461 :default: ``'NONE'``
2463 This defines the default sort order for the tables, having a primary key,
2464 when there is no sort order defines externally.
2465 Acceptable values : ['NONE', 'ASC', 'DESC']
2467 .. config:option:: $cfg['ShowBrowseComments']
2472 .. config:option:: $cfg['ShowPropertyComments']
2477 By setting the corresponding variable to ``true`` you can enable the
2478 display of column comments in Browse or Property display. In browse
2479 mode, the comments are shown inside the header. In property mode,
2480 comments are displayed using a CSS-formatted dashed-line below the
2481 name of the column. The comment is shown as a tool-tip for that
2487 .. config:option:: $cfg['CharEditing']
2490 :default: ``'input'``
2492 Defines which type of editing controls should be used for CHAR and
2493 VARCHAR columns. Applies to data editing and also to the default values
2494 in structure editing. Possible values are:
2496 * input - this allows to limit size of text to size of columns in MySQL,
2497 but has problems with newlines in columns
2498 * textarea - no problems with newlines in columns, but also no length
2501 .. config:option:: $cfg['MinSizeForInputField']
2506 Defines the minimum size for input fields generated for CHAR and
2509 .. config:option:: $cfg['MaxSizeForInputField']
2514 Defines the maximum size for input fields generated for CHAR and
2517 .. config:option:: $cfg['TextareaCols']
2522 .. config:option:: $cfg['TextareaRows']
2527 .. config:option:: $cfg['CharTextareaCols']
2532 .. config:option:: $cfg['CharTextareaRows']
2537 Number of columns and rows for the textareas. This value will be
2538 emphasized (\*2) for :term:`SQL` query
2539 textareas and (\*1.25) for :term:`SQL`
2540 textareas inside the query window.
2542 The Char\* values are used for CHAR
2543 and VARCHAR editing (if configured via :config:option:`$cfg['CharEditing']`).
2545 .. config:option:: $cfg['LongtextDoubleTextarea']
2550 Defines whether textarea for LONGTEXT columns should have double size.
2552 .. config:option:: $cfg['TextareaAutoSelect']
2557 Defines if the whole textarea of the query box will be selected on
2560 .. config:option:: $cfg['EnableAutocompleteForTablesAndColumns']
2565 Whether to enable autocomplete for table and column names in any
2569 SQL query box settings
2570 ----------------------
2572 .. config:option:: $cfg['SQLQuery']['Edit']
2577 Whether to display an edit link to change a query in any SQL Query
2580 .. config:option:: $cfg['SQLQuery']['Explain']
2585 Whether to display a link to explain a SELECT query in any SQL Query
2588 .. config:option:: $cfg['SQLQuery']['ShowAsPHP']
2593 Whether to display a link to wrap a query in PHP code in any SQL Query
2596 .. config:option:: $cfg['SQLQuery']['Refresh']
2601 Whether to display a link to refresh a query in any SQL Query box.
2605 Web server upload/save/import directories
2606 -----------------------------------------
2608 If PHP is running in safe mode, all directories must be owned by the same user
2609 as the owner of the phpMyAdmin scripts.
2611 If the directory where phpMyAdmin is installed is subject to an
2612 ``open_basedir`` restriction, you need to create a temporary directory in some
2613 directory accessible by the PHP interpreter.
2615 For security reasons, all directories should be outside the tree published by
2616 webserver. If you cannot avoid having this directory published by webserver,
2617 limit access to it either by web server configuration (for example using
2618 .htaccess or web.config files) or place at least an empty :file:`index.html`
2619 file there, so that directory listing is not possible. However as long as the
2620 directory is accessible by web server, an attacker can guess filenames to download
2623 .. config:option:: $cfg['UploadDir']
2628 The name of the directory where :term:`SQL` files have been uploaded by
2629 other means than phpMyAdmin (for example, ftp). Those files are available
2630 under a drop-down box when you click the database or table name, then the
2634 you want different directory for each user, %u will be replaced with
2637 Please note that the file names must have the suffix ".sql"
2638 (or ".sql.bz2" or ".sql.gz" if support for compressed formats is
2641 This feature is useful when your file is too big to be
2642 uploaded via :term:`HTTP`, or when file
2643 uploads are disabled in PHP.
2647 Please see top of this chapter (:ref:`web-dirs`) for instructions how
2648 to setup this directory and how to make its usage secure.
2652 See :ref:`faq1_16` for alternatives.
2654 .. config:option:: $cfg['SaveDir']
2659 The name of the directory where dumps can be saved.
2661 If you want different directory for each user, %u will be replaced with
2664 Please note that the directory must exist and has to be writable for
2665 the user running webserver.
2669 Please see top of this chapter (:ref:`web-dirs`) for instructions how
2670 to setup this directory and how to make its usage secure.
2672 .. config:option:: $cfg['TempDir']
2677 The name of the directory where temporary files can be stored.
2679 This is needed for importing ESRI Shapefiles, see :ref:`faq6_30` and to
2680 work around limitations of ``open_basedir`` for uploaded files, see
2683 This directory should have as strict permissions as possible as the only
2684 user required to access this directory is the one who runs the webserver.
2685 If you have root privileges, simply make this user owner of this directory
2686 and make it accessible only by it:
2690 chown www-data:www-data tmp
2693 If you cannot change owner of the directory, you can achieve a similar
2694 setup using :term:`ACL`:
2699 setfacl -m "g:www-data:rwx" tmp
2700 setfacl -d -m "g:www-data:rwx" tmp
2702 If neither of above works for you, you can still make the directory
2703 :command:`chmod 777`, but it might impose risk of other users on system
2704 reading and writing data in this directory.
2708 Please see top of this chapter (:ref:`web-dirs`) for instructions how
2709 to setup this directory and how to make its usage secure.
2711 Various display setting
2712 -----------------------
2714 .. config:option:: $cfg['RepeatCells']
2719 Repeat the headers every X cells, or 0 to deactivate.
2721 .. config:option:: $cfg['QueryHistoryDB']
2726 .. config:option:: $cfg['QueryHistoryMax']
2731 If :config:option:`$cfg['QueryHistoryDB']` is set to ``true``, all your
2732 Queries are logged to a table, which has to be created by you (see
2733 :config:option:`$cfg['Servers'][$i]['history']`). If set to false, all your
2734 queries will be appended to the form, but only as long as your window is
2735 opened they remain saved.
2737 When using the JavaScript based query window, it will always get updated
2738 when you click on a new table/db to browse and will focus if you click on
2739 :guilabel:`Edit SQL` after using a query. You can suppress updating the
2740 query window by checking the box :guilabel:`Do not overwrite this query
2741 from outside the window` below the query textarea. Then you can browse
2742 tables/databases in the background without losing the contents of the
2743 textarea, so this is especially useful when composing a query with tables
2744 you first have to look in. The checkbox will get automatically checked
2745 whenever you change the contents of the textarea. Please uncheck the button
2746 whenever you definitely want the query window to get updated even though
2747 you have made alterations.
2749 If :config:option:`$cfg['QueryHistoryDB']` is set to ``true`` you can
2750 specify the amount of saved history items using
2751 :config:option:`$cfg['QueryHistoryMax']`.
2753 .. config:option:: $cfg['BrowseMIME']
2758 Enable :ref:`transformations`.
2760 .. config:option:: $cfg['MaxExactCount']
2765 For InnoDB tables, determines for how large tables phpMyAdmin should
2766 get the exact row count using ``SELECT COUNT``. If the approximate row
2767 count as returned by ``SHOW TABLE STATUS`` is smaller than this value,
2768 ``SELECT COUNT`` will be used, otherwise the approximate count will be
2771 .. config:option:: $cfg['MaxExactCountViews']
2776 For VIEWs, since obtaining the exact count could have an impact on
2777 performance, this value is the maximum to be displayed, using a
2778 ``SELECT COUNT ... LIMIT``. Setting this to 0 bypasses any row
2781 .. config:option:: $cfg['NaturalOrder']
2786 Sorts database and table names according to natural order (for
2787 example, t1, t2, t10). Currently implemented in the navigation panel
2788 and in Database view, for the table list.
2790 .. config:option:: $cfg['InitialSlidersState']
2793 :default: ``'closed'``
2795 If set to ``'closed'``, the visual sliders are initially in a closed
2796 state. A value of ``'open'`` does the reverse. To completely disable
2797 all visual sliders, use ``'disabled'``.
2799 .. config:option:: $cfg['UserprefsDisallow']
2804 Contains names of configuration options (keys in ``$cfg`` array) that
2805 users can't set through user preferences. For possible values, refer
2806 to :file:`libraries/config/user_preferences.forms.php`.
2808 .. config:option:: $cfg['UserprefsDeveloperTab']
2813 Activates in the user preferences a tab containing options for
2814 developers of phpMyAdmin.
2819 .. config:option:: $cfg['TitleTable']
2822 :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ / @TABLE@ | @PHPMYADMIN@'``
2824 .. config:option:: $cfg['TitleDatabase']
2827 :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ | @PHPMYADMIN@'``
2829 .. config:option:: $cfg['TitleServer']
2832 :default: ``'@HTTP_HOST@ / @VSERVER@ | @PHPMYADMIN@'``
2834 .. config:option:: $cfg['TitleDefault']
2837 :default: ``'@HTTP_HOST@ | @PHPMYADMIN@'``
2839 Allows you to specify window's title bar. You can use :ref:`faq6_27`.
2841 Theme manager settings
2842 ----------------------
2844 .. config:option:: $cfg['ThemePath']
2847 :default: ``'./themes'``
2849 If theme manager is active, use this as the path of the subdirectory
2850 containing all the themes.
2852 .. config:option:: $cfg['ThemeManager']
2857 Enables user-selectable themes. See :ref:`faqthemes`.
2859 .. config:option:: $cfg['ThemeDefault']
2862 :default: ``'pmahomme'``
2864 The default theme (a subdirectory under :config:option:`$cfg['ThemePath']`).
2866 .. config:option:: $cfg['ThemePerServer']
2871 Whether to allow different theme for each server.
2876 .. config:option:: $cfg['DefaultQueryTable']
2879 :default: ``'SELECT * FROM @TABLE@ WHERE 1'``
2881 .. config:option:: $cfg['DefaultQueryDatabase']
2886 Default queries that will be displayed in query boxes when user didn't
2887 specify any. You can use standard :ref:`faq6_27`.
2893 .. config:option:: $cfg['DefaultFunctions']
2896 :default: array(...)
2898 Functions selected by default when inserting/changing row, Functions
2899 are defined for meta types as (FUNC\_NUMBER, FUNC\_DATE, FUNC\_CHAR,
2900 FUNC\_SPATIAL, FUNC\_UUID) and for ``first_timestamp``, which is used
2901 for first timestamp column in table.
2909 These settings might have huge effect on performance or security.
2911 .. config:option:: $cfg['DBG']
2914 :default: array(...)
2916 .. config:option:: $cfg['DBG']['sql']
2921 Enable logging queries and execution times to be
2922 displayed in the console's Debug SQL tab.
2924 .. config:option:: $cfg['DBG']['demo']
2929 Enable to let server present itself as demo server.
2930 This is used for `phpMyAdmin demo server <https://www.phpmyadmin.net/try/>`_.
2936 See following configuration snippets for usual setups of phpMyAdmin.
2938 .. _example-google-ssl:
2940 Google Cloud SQL with SSL
2941 +++++++++++++++++++++++++
2943 To connect to Google Could SQL, you currently need to disable certificate
2944 verification. This is caused by the certficate being issued for CN matching
2945 your instance name, but you connect to an IP address and PHP tries to match
2946 these two. With verfication you end up with error message like::
2948 Peer certificate CN=`api-project-851612429544:pmatest' did not match expected CN=`8.8.8.8'
2952 With disabled verification your traffic is encrypted, but you're open to
2953 man in the middle attacks.
2955 To connect phpMyAdmin to Google Cloud SQL using SSL download the client and
2956 server certificates and tell phpMyAdmin to use them:
2960 // IP address of your instance
2961 $cfg['Servers'][2]['host'] = '8.8.8.8';
2962 // Use SSL for connection
2963 $cfg['Servers'][$i]['ssl'] = true;
2964 // Client secret key
2965 $cfg['Servers'][$i]['ssl_key'] = '../client-key.pem';
2966 // Client certificate
2967 $cfg['Servers'][$i]['ssl_cert'] = '../client-cert.pem';
2968 // Server certification authority
2969 $cfg['Servers'][$i]['ssl_ca'] = '../server-ca.pem';
2970 // Disable SSL verification (see above note)
2971 $cfg['Servers'][$i]['ssl_verify'] = false;
2975 :config:option:`$cfg['Servers'][$i]['ssl']`,
2976 :config:option:`$cfg['Servers'][$i]['ssl_key']`,
2977 :config:option:`$cfg['Servers'][$i]['ssl_cert']`,
2978 :config:option:`$cfg['Servers'][$i]['ssl_ca']`,
2979 :config:option:`$cfg['Servers'][$i]['ssl_verify']`