1 .. index:: config.inc.php
8 All configurable data is placed in :file:`config.inc.php` in phpMyAdmin's
9 toplevel directory. If this file does not exist, please refer to the
10 :ref:`setup` section to create one. This file only needs to contain the
11 parameters you want to change from their corresponding default value in
12 :file:`libraries/config.default.php` (this file is not intended for changes).
16 :ref:`config-examples` for examples of configurations
18 If a directive is missing from your file, you can just add another line with
19 the file. This file is for over-writing the defaults; if you wish to use the
20 default value there's no need to add a line here.
22 The parameters which relate to design (like colors) are placed in
23 :file:`themes/themename/scss/_variables.scss`. You might also want to create
24 :file:`config.footer.inc.php` and :file:`config.header.inc.php` files to add
25 your site specific code to be included on start and end of each page.
29 Some distributions (eg. Debian or Ubuntu) store :file:`config.inc.php` in
30 ``/etc/phpmyadmin`` instead of within phpMyAdmin sources.
35 .. config:option:: $cfg['PmaAbsoluteUri']
40 .. versionchanged:: 4.6.5
42 This setting was not available in phpMyAdmin 4.6.0 - 4.6.4.
44 Sets here the complete :term:`URL` (with full path) to your phpMyAdmin
45 installation's directory. E.g.
46 ``https://www.example.net/path_to_your_phpMyAdmin_directory/``. Note also
47 that the :term:`URL` on most of web servers are case sensitive (even on
48 Windows). Don’t 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 or complex reverse proxy setup might need to set this.
54 A good test is to browse a table, edit a row and save it. There should be
55 an error message if phpMyAdmin is having trouble auto–detecting the correct
56 value. If you get an error that this must be set or if the autodetect code
57 fails to detect your path, please post a bug report on our bug tracker so
58 we can improve the code.
60 .. seealso:: :ref:`faq1_40`, :ref:`faq2_5`, :ref:`faq4_7`, :ref:`faq5_16`
62 .. config:option:: $cfg['PmaNoRelation_DisableWarning']
67 Starting with version 2.3.0 phpMyAdmin offers a lot of features to
68 work with master / foreign – tables (see :config:option:`$cfg['Servers'][$i]['pmadb']`).
70 If you tried to set this
71 up and it does not work for you, have a look on the :guilabel:`Structure` page
72 of one database where you would like to use it. You will find a link
73 that will analyze why those features have been disabled.
75 If you do not want to use those features set this variable to ``true`` to
76 stop this message from appearing.
78 .. config:option:: $cfg['AuthLog']
83 .. versionadded:: 4.8.0
85 This is supported since phpMyAdmin 4.8.0.
87 Configure authentication logging destination. Failed (or all, depending on
88 :config:option:`$cfg['AuthLogSuccess']`) authentication attempts will be
89 logged according to this directive:
92 Let phpMyAdmin automatically choose between ``syslog`` and ``php``.
94 Log using syslog, using AUTH facility, on most systems this ends up
95 in :file:`/var/log/auth.log`.
97 Log into PHP error log.
99 Log into PHP SAPI logging.
101 Any other value is treated as a filename and log entries are written there.
105 When logging to a file, make sure its permissions are correctly set
106 for a web server user, the setup should closely match instructions
107 described in :config:option:`$cfg['TempDir']`:
109 .. config:option:: $cfg['AuthLogSuccess']
114 .. versionadded:: 4.8.0
116 This is supported since phpMyAdmin 4.8.0.
118 Whether to log successful authentication attempts into
119 :config:option:`$cfg['AuthLog']`.
121 .. config:option:: $cfg['SuhosinDisableWarning']
126 A warning is displayed on the main page if Suhosin is detected.
128 You can set this parameter to ``true`` to stop this message from appearing.
130 .. config:option:: $cfg['LoginCookieValidityDisableWarning']
135 A warning is displayed on the main page if the PHP parameter
136 session.gc_maxlifetime is lower than cookie validity configured in phpMyAdmin.
138 You can set this parameter to ``true`` to stop this message from appearing.
140 .. config:option:: $cfg['ServerLibraryDifference_DisableWarning']
145 .. deprecated:: 4.7.0
147 This setting was removed as the warning has been removed as well.
149 A warning is displayed on the main page if there is a difference
150 between the MySQL library and server version.
152 You can set this parameter to ``true`` to stop this message from appearing.
154 .. config:option:: $cfg['ReservedWordDisableWarning']
159 This warning is displayed on the Structure page of a table if one or more
160 column names match with words which are MySQL reserved.
162 If you want to turn off this warning, you can set it to ``true`` and
163 warning will no longer be displayed.
165 .. config:option:: $cfg['TranslationWarningThreshold']
170 Show warning about incomplete translations on certain threshold.
172 .. config:option:: $cfg['SendErrorReports']
177 Sets the default behavior for JavaScript error reporting.
179 Whenever an error is detected in the JavaScript execution, an error report
180 may be sent to the phpMyAdmin team if the user agrees.
182 The default setting of ``'ask'`` will ask the user everytime there is a new
183 error report. However you can set this parameter to ``'always'`` to send error
184 reports without asking for confirmation or you can set it to ``'never'`` to
185 never send error reports.
187 This directive is available both in the configuration file and in users
188 preferences. If the person in charge of a multi-user installation prefers
189 to disable this feature for all users, a value of ``'never'`` should be
190 set, and the :config:option:`$cfg['UserprefsDisallow']` directive should
191 contain ``'SendErrorReports'`` in one of its array values.
193 .. config:option:: $cfg['ConsoleEnterExecutes']
198 Setting this to ``true`` allows the user to execute queries by pressing Enter
199 instead of Ctrl+Enter. A new line can be inserted by pressing Shift + Enter.
201 The behaviour of the console can be temporarily changed using console's
204 .. config:option:: $cfg['AllowThirdPartyFraming']
206 :type: boolean|string
209 Setting this to ``true`` allows phpMyAdmin to be included inside a frame,
210 and is a potential security hole allowing cross-frame scripting attacks or
211 clickjacking. Setting this to 'sameorigin' prevents phpMyAdmin to be
212 included from another document in a frame, unless that document belongs
215 Server connection settings
216 --------------------------
218 .. config:option:: $cfg['Servers']
221 :default: one server array with settings listed below
223 Since version 1.4.2, phpMyAdmin supports the administration of multiple
224 MySQL servers. Therefore, a :config:option:`$cfg['Servers']`-array has been
225 added which contains the login information for the different servers. The
226 first :config:option:`$cfg['Servers'][$i]['host']` contains the hostname of
227 the first server, the second :config:option:`$cfg['Servers'][$i]['host']`
228 the hostname of the second server, etc. In
229 :file:`libraries/config.default.php`, there is only one section for server
230 definition, however you can put as many as you need in
231 :file:`config.inc.php`, copy that block or needed parts (you don't have to
232 define all settings, just those you need to change).
236 The :config:option:`$cfg['Servers']` array starts with
237 $cfg['Servers'][1]. Do not use $cfg['Servers'][0]. If you want more
238 than one server, just copy following section (including $i
239 increment) several times. There is no need to define full server
240 array, just define values you need to change.
242 .. config:option:: $cfg['Servers'][$i]['host']
245 :default: ``'localhost'``
247 The hostname or :term:`IP` address of your $i-th MySQL-server. E.g.
252 * hostname, e.g., ``'localhost'`` or ``'mydb.example.org'``
253 * IP address, e.g., ``'127.0.0.1'`` or ``'192.168.10.1'``
254 * IPv6 address, e.g. ``2001:cdba:0000:0000:0000:0000:3257:9652``
255 * dot - ``'.'``, i.e., use named pipes on windows systems
256 * empty - ``''``, disables this server
260 The hostname ``localhost`` is handled specially by MySQL and it uses
261 the socket based connection protocol. To use TCP/IP networking, use an
262 IP address or hostname such as ``127.0.0.1`` or ``db.example.com``. You
263 can configure the path to the socket with
264 :config:option:`$cfg['Servers'][$i]['socket']`.
268 :config:option:`$cfg['Servers'][$i]['port']`,
269 <https://dev.mysql.com/doc/refman/5.7/en/connecting.html>
271 .. config:option:: $cfg['Servers'][$i]['port']
276 The port-number of your $i-th MySQL-server. Default is 3306 (leave
281 If you use ``localhost`` as the hostname, MySQL ignores this port number
282 and connects with the socket, so if you want to connect to a port
283 different from the default port, use ``127.0.0.1`` or the real hostname
284 in :config:option:`$cfg['Servers'][$i]['host']`.
288 :config:option:`$cfg['Servers'][$i]['host']`,
289 <https://dev.mysql.com/doc/refman/5.7/en/connecting.html>
291 .. config:option:: $cfg['Servers'][$i]['socket']
296 The path to the socket to use. Leave blank for default. To determine
297 the correct socket, check your MySQL configuration or, using the
298 :command:`mysql` command–line client, issue the ``status`` command. Among the
299 resulting information displayed will be the socket used.
303 This takes effect only if :config:option:`$cfg['Servers'][$i]['host']` is set
308 :config:option:`$cfg['Servers'][$i]['host']`,
309 <https://dev.mysql.com/doc/refman/5.7/en/connecting.html>
311 .. config:option:: $cfg['Servers'][$i]['ssl']
316 Whether to enable SSL for the connection between phpMyAdmin and the MySQL
317 server to secure the connection.
319 When using the ``'mysql'`` extension,
320 none of the remaining ``'ssl...'`` configuration options apply.
322 We strongly recommend the ``'mysqli'`` extension when using this option.
327 :ref:`example-google-ssl`,
328 :config:option:`$cfg['Servers'][$i]['ssl_key']`,
329 :config:option:`$cfg['Servers'][$i]['ssl_cert']`,
330 :config:option:`$cfg['Servers'][$i]['ssl_ca']`,
331 :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`,
332 :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`,
333 :config:option:`$cfg['Servers'][$i]['ssl_verify']`
335 .. config:option:: $cfg['Servers'][$i]['ssl_key']
340 Path to the client key file when using SSL for connecting to the MySQL
341 server. This is used to authenticate the client to the server.
347 $cfg['Servers'][$i]['ssl_key'] = '/etc/mysql/server-key.pem';
352 :ref:`example-google-ssl`,
353 :config:option:`$cfg['Servers'][$i]['ssl']`,
354 :config:option:`$cfg['Servers'][$i]['ssl_cert']`,
355 :config:option:`$cfg['Servers'][$i]['ssl_ca']`,
356 :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`,
357 :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`,
358 :config:option:`$cfg['Servers'][$i]['ssl_verify']`
360 .. config:option:: $cfg['Servers'][$i]['ssl_cert']
365 Path to the client certificate file when using SSL for connecting to the
366 MySQL server. This is used to authenticate the client to the server.
371 :ref:`example-google-ssl`,
372 :config:option:`$cfg['Servers'][$i]['ssl']`,
373 :config:option:`$cfg['Servers'][$i]['ssl_key']`,
374 :config:option:`$cfg['Servers'][$i]['ssl_ca']`,
375 :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`,
376 :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`,
377 :config:option:`$cfg['Servers'][$i]['ssl_verify']`
379 .. config:option:: $cfg['Servers'][$i]['ssl_ca']
384 Path to the CA file when using SSL for connecting to the MySQL server.
389 :ref:`example-google-ssl`,
390 :config:option:`$cfg['Servers'][$i]['ssl']`,
391 :config:option:`$cfg['Servers'][$i]['ssl_key']`,
392 :config:option:`$cfg['Servers'][$i]['ssl_cert']`,
393 :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`,
394 :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`,
395 :config:option:`$cfg['Servers'][$i]['ssl_verify']`
397 .. config:option:: $cfg['Servers'][$i]['ssl_ca_path']
402 Directory containing trusted SSL CA certificates in PEM format.
407 :ref:`example-google-ssl`,
408 :config:option:`$cfg['Servers'][$i]['ssl']`,
409 :config:option:`$cfg['Servers'][$i]['ssl_key']`,
410 :config:option:`$cfg['Servers'][$i]['ssl_cert']`,
411 :config:option:`$cfg['Servers'][$i]['ssl_ca']`,
412 :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`,
413 :config:option:`$cfg['Servers'][$i]['ssl_verify']`
415 .. config:option:: $cfg['Servers'][$i]['ssl_ciphers']
420 List of allowable ciphers for SSL connections to the MySQL server.
425 :ref:`example-google-ssl`,
426 :config:option:`$cfg['Servers'][$i]['ssl']`,
427 :config:option:`$cfg['Servers'][$i]['ssl_key']`,
428 :config:option:`$cfg['Servers'][$i]['ssl_cert']`,
429 :config:option:`$cfg['Servers'][$i]['ssl_ca']`,
430 :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`,
431 :config:option:`$cfg['Servers'][$i]['ssl_verify']`
433 .. config:option:: $cfg['Servers'][$i]['ssl_verify']
438 .. versionadded:: 4.6.0
440 This is supported since phpMyAdmin 4.6.0.
442 If your PHP install uses the MySQL Native Driver (mysqlnd), your
443 MySQL server is 5.6 or later, and your SSL certificate is self-signed,
444 there is a chance your SSL connection will fail due to validation.
445 Setting this to ``false`` will disable the validation check.
447 Since PHP 5.6.0 it also verifies whether server name matches CN of its
448 certificate. There is currently no way to disable just this check without
449 disabling complete SSL verification.
453 Disabling the certificate verification defeats purpose of using SSL.
454 This will make the connection vulnerable to man in the middle attacks.
458 This flag only works with PHP 5.6.16 or later.
463 :ref:`example-google-ssl`,
464 :config:option:`$cfg['Servers'][$i]['ssl']`,
465 :config:option:`$cfg['Servers'][$i]['ssl_key']`,
466 :config:option:`$cfg['Servers'][$i]['ssl_cert']`,
467 :config:option:`$cfg['Servers'][$i]['ssl_ca']`,
468 :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`,
469 :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`,
470 :config:option:`$cfg['Servers'][$i]['ssl_verify']`
472 .. config:option:: $cfg['Servers'][$i]['connect_type']
477 .. deprecated:: 4.7.0
479 This setting is no longer used as of 4.7.0, since MySQL decides the
480 connection type based on host, so it could lead to unexpected results.
481 Please set :config:option:`$cfg['Servers'][$i]['host']` accordingly
484 What type connection to use with the MySQL server. Your options are
485 ``'socket'`` and ``'tcp'``. It defaults to tcp as that is nearly guaranteed
486 to be available on all MySQL servers, while sockets are not supported on
487 some platforms. To use the socket mode, your MySQL server must be on the
488 same machine as the Web server.
490 .. config:option:: $cfg['Servers'][$i]['compress']
495 Whether to use a compressed protocol for the MySQL server connection
496 or not (experimental).
499 .. config:option:: $cfg['Servers'][$i]['controlhost']
504 Permits to use an alternate host to hold the configuration storage
509 :config:option:`$cfg['Servers'][$i]['control_*']`
512 .. config:option:: $cfg['Servers'][$i]['controlport']
517 Permits to use an alternate port to connect to the host that
518 holds the configuration storage.
522 :config:option:`$cfg['Servers'][$i]['control_*']`
525 .. config:option:: $cfg['Servers'][$i]['controluser']
530 .. config:option:: $cfg['Servers'][$i]['controlpass']
535 This special account is used to access :ref:`linked-tables`.
536 You don't need it in single user case, but if phpMyAdmin is shared it
537 is recommended to give access to :ref:`linked-tables` only to this user
538 and configure phpMyAdmin to use it. All users will then be able to use
539 the features without need to have direct access to :ref:`linked-tables`.
541 .. versionchanged:: 2.2.5
542 those were called ``stduser`` and ``stdpass``
547 :ref:`authentication_modes`,
548 :ref:`linked-tables`,
549 :config:option:`$cfg['Servers'][$i]['pmadb']`,
550 :config:option:`$cfg['Servers'][$i]['controlhost']`,
551 :config:option:`$cfg['Servers'][$i]['controlport']`,
552 :config:option:`$cfg['Servers'][$i]['control_*']`
554 .. config:option:: $cfg['Servers'][$i]['control_*']
558 .. versionadded:: 4.7.0
560 You can change any MySQL connection setting for control link (used to
561 access :ref:`linked-tables`) using configuration prefixed with ``control_``.
563 This can be used to change any aspect of the control connection, which by
564 default uses same parameters as the user one.
566 For example you can configure SSL for the control connection:
571 $cfg['Servers'][$i]['control_ssl'] = true;
573 $cfg['Servers'][$i]['control_ssl_key'] = '../client-key.pem';
574 // Client certificate
575 $cfg['Servers'][$i]['control_ssl_cert'] = '../client-cert.pem';
576 // Server certification authority
577 $cfg['Servers'][$i]['control_ssl_ca'] = '../server-ca.pem';
581 :config:option:`$cfg['Servers'][$i]['ssl']`,
582 :config:option:`$cfg['Servers'][$i]['ssl_key']`,
583 :config:option:`$cfg['Servers'][$i]['ssl_cert']`,
584 :config:option:`$cfg['Servers'][$i]['ssl_ca']`,
585 :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`,
586 :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`,
587 :config:option:`$cfg['Servers'][$i]['ssl_verify']`
589 .. config:option:: $cfg['Servers'][$i]['auth_type']
592 :default: ``'cookie'``
594 Whether config or cookie or :term:`HTTP` or signon authentication should be
595 used for this server.
597 * 'config' authentication (``$auth_type = 'config'``) is the plain old
598 way: username and password are stored in :file:`config.inc.php`.
599 * 'cookie' authentication mode (``$auth_type = 'cookie'``) allows you to
600 log in as any valid MySQL user with the help of cookies.
601 * 'http' authentication allows you to log in as any
602 valid MySQL user via HTTP-Auth.
603 * 'signon' authentication mode (``$auth_type = 'signon'``) allows you to
604 log in from prepared PHP session data or using supplied PHP script.
606 .. seealso:: :ref:`authentication_modes`
608 .. _servers_auth_http_realm:
609 .. config:option:: $cfg['Servers'][$i]['auth_http_realm']
614 When using auth\_type = ``http``, this field allows to define a custom
615 :term:`HTTP` Basic Auth Realm which will be displayed to the user. If not
616 explicitly specified in your configuration, a string combined of
617 "phpMyAdmin " and either :config:option:`$cfg['Servers'][$i]['verbose']` or
618 :config:option:`$cfg['Servers'][$i]['host']` will be used.
621 .. config:option:: $cfg['Servers'][$i]['user']
626 .. config:option:: $cfg['Servers'][$i]['password']
631 When using :config:option:`$cfg['Servers'][$i]['auth_type']` set to
632 'config', this is the user/password-pair which phpMyAdmin will use to
633 connect to the MySQL server. This user/password pair is not needed when
634 :term:`HTTP` or cookie authentication is used
637 .. _servers_nopassword:
638 .. config:option:: $cfg['Servers'][$i]['nopassword']
643 .. deprecated:: 4.7.0
645 This setting was removed as it can produce unexpected results.
647 Allow attempt to log in without password when a login with password
648 fails. This can be used together with http authentication, when
649 authentication is done some other way and phpMyAdmin gets user name
650 from auth and uses empty password for connecting to MySQL. Password
651 login is still tried first, but as fallback, no password method is
655 .. config:option:: $cfg['Servers'][$i]['only_db']
657 :type: string or array
660 If set to a (an array of) database name(s), only this (these)
661 database(s) will be shown to the user. Since phpMyAdmin 2.2.1,
662 this/these database(s) name(s) may contain MySQL wildcards characters
663 ("\_" and "%"): if you want to use literal instances of these
664 characters, escape them (I.E. use ``'my\_db'`` and not ``'my_db'``).
666 This setting is an efficient way to lower the server load since the
667 latter does not need to send MySQL requests to build the available
668 database list. But **it does not replace the privileges rules of the
669 MySQL database server**. If set, it just means only these databases
670 will be displayed but **not that all other databases can't be used.**
672 An example of using more that one database:
676 $cfg['Servers'][$i]['only_db'] = array('db1', 'db2');
678 .. versionchanged:: 4.0.0
679 Previous versions permitted to specify the display order of
680 the database names via this directive.
682 .. config:option:: $cfg['Servers'][$i]['hide_db']
687 Regular expression for hiding some databases from unprivileged users.
688 This only hides them from listing, but a user is still able to access
689 them (using, for example, the SQL query area). To limit access, use
690 the MySQL privilege system. For example, to hide all databases
691 starting with the letter "a", use
695 $cfg['Servers'][$i]['hide_db'] = '^a';
697 and to hide both "db1" and "db2" use
701 $cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$';
703 More information on regular expressions can be found in the `PCRE
705 <https://www.php.net/manual/en/reference.pcre.pattern.syntax.php>`_ portion
706 of the PHP reference manual.
708 .. config:option:: $cfg['Servers'][$i]['verbose']
713 Only useful when using phpMyAdmin with multiple server entries. If
714 set, this string will be displayed instead of the hostname in the
715 pull-down menu on the main page. This can be useful if you want to
716 show only certain databases on your system, for example. For HTTP
717 auth, all non-US-ASCII characters will be stripped.
719 .. config:option:: $cfg['Servers'][$i]['extension']
722 :default: ``'mysqli'``
724 .. deprecated:: 4.2.0
726 This setting was removed. The ``mysql`` extension will only be used when
727 the ``mysqli`` extension is not available. As of 5.0.0, only the
728 ``mysqli`` extension can be used.
730 The PHP MySQL extension to use (``mysql`` or ``mysqli``).
732 It is recommended to use ``mysqli`` in all installations.
734 .. config:option:: $cfg['Servers'][$i]['pmadb']
739 The name of the database containing the phpMyAdmin configuration
742 See the :ref:`linked-tables` section in this document to see the benefits of
743 this feature, and for a quick way of creating this database and the needed
746 If you are the only user of this phpMyAdmin installation, you can use your
747 current database to store those special tables; in this case, just put your
748 current database name in :config:option:`$cfg['Servers'][$i]['pmadb']`. For a
749 multi-user installation, set this parameter to the name of your central
750 database containing the phpMyAdmin configuration storage.
753 .. config:option:: $cfg['Servers'][$i]['bookmarktable']
755 :type: string or false
758 Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This
759 can be useful for queries you often run. To allow the usage of this
762 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
763 * enter the table name in :config:option:`$cfg['Servers'][$i]['bookmarktable']`
765 This feature can be disabled by setting the configuration to ``false``.
768 .. config:option:: $cfg['Servers'][$i]['relation']
770 :type: string or false
773 Since release 2.2.4 you can describe, in a special 'relation' table,
774 which column is a key in another table (a foreign key). phpMyAdmin
775 currently uses this to:
777 * make clickable, when you browse the master table, the data values that
778 point to the foreign table;
779 * display in an optional tool-tip the "display column" when browsing the
780 master table, if you move the mouse to a column containing a foreign
781 key (use also the 'table\_info' table); (see :ref:`faqdisplay`)
782 * in edit/insert mode, display a drop-down list of possible foreign keys
783 (key value and "display column" are shown) (see :ref:`faq6_21`)
784 * display links on the table properties page, to check referential
785 integrity (display missing foreign keys) for each described key;
786 * in query-by-example, create automatic joins (see :ref:`faq6_6`)
787 * enable you to get a :term:`PDF` schema of
788 your database (also uses the table\_coords table).
790 The keys can be numeric or character.
792 To allow the usage of this functionality:
794 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
795 * put the relation table name in :config:option:`$cfg['Servers'][$i]['relation']`
796 * now as normal user open phpMyAdmin and for each one of your tables
797 where you want to use this feature, click :guilabel:`Structure/Relation view/`
798 and choose foreign columns.
800 This feature can be disabled by setting the configuration to ``false``.
804 In the current version, ``master_db`` must be the same as ``foreign_db``.
805 Those columns have been put in future development of the cross-db
809 .. config:option:: $cfg['Servers'][$i]['table_info']
811 :type: string or false
814 Since release 2.3.0 you can describe, in a special 'table\_info'
815 table, which column is to be displayed as a tool-tip when moving the
816 cursor over the corresponding key. This configuration variable will
817 hold the name of this special table. To allow the usage of this
820 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
821 * put the table name in :config:option:`$cfg['Servers'][$i]['table\_info']` (e.g.
823 * then for each table where you want to use this feature, click
824 "Structure/Relation view/Choose column to display" to choose the
827 This feature can be disabled by setting the configuration to ``false``.
829 .. seealso:: :ref:`faqdisplay`
832 .. config:option:: $cfg['Servers'][$i]['table_coords']
834 :type: string or false
837 The designer feature can save your page layout; by pressing the "Save page" or "Save page as"
838 button in the expanding designer menu, you can customize the layout and have it loaded the next
839 time you use the designer. That layout is stored in this table. Furthermore, this table is also
840 required for using the PDF relation export feature, see
841 :config:option:`$cfg['Servers'][$i]['pdf\_pages']` for additional details.
843 .. config:option:: $cfg['Servers'][$i]['pdf_pages']
845 :type: string or false
848 Since release 2.3.0 you can have phpMyAdmin create :term:`PDF` pages
849 showing the relations between your tables. Further, the designer interface
850 permits visually managing the relations. To do this it needs two tables
851 "pdf\_pages" (storing information about the available :term:`PDF` pages)
852 and "table\_coords" (storing coordinates where each table will be placed on
853 a :term:`PDF` schema output). You must be using the "relation" feature.
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 correct table names in
859 :config:option:`$cfg['Servers'][$i]['table\_coords']` and
860 :config:option:`$cfg['Servers'][$i]['pdf\_pages']`
862 This feature can be disabled by setting either of the configurations to ``false``.
864 .. seealso:: :ref:`faqpdf`.
867 .. config:option:: $cfg['Servers'][$i]['column_info']
869 :type: string or false
872 This part requires a content update! Since release 2.3.0 you can
873 store comments to describe each column for each table. These will then
874 be shown on the "printview".
876 Starting with release 2.5.0, comments are consequently used on the table
877 property pages and table browse view, showing up as tool-tips above the
878 column name (properties page) or embedded within the header of table in
879 browse view. They can also be shown in a table dump. Please see the
880 relevant configuration directives later on.
882 Also new in release 2.5.0 is a MIME- transformation system which is also
883 based on the following table structure. See :ref:`transformations` for
884 further information. To use the MIME- transformation system, your
885 column\_info table has to have the three new columns 'mimetype',
886 'transformation', 'transformation\_options'.
888 Starting with release 4.3.0, a new input-oriented transformation system
889 has been introduced. Also, backward compatibility code used in the old
890 transformations system was removed. As a result, an update to column\_info
891 table is necessary for previous transformations and the new input-oriented
892 transformation system to work. phpMyAdmin will upgrade it automatically
893 for you by analyzing your current column\_info table structure.
894 However, if something goes wrong with the auto-upgrade then you can
895 use the SQL script found in ``./sql/upgrade_column_info_4_3_0+.sql``
896 to upgrade it manually.
898 To allow the usage of this functionality:
900 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
901 * put the table name in :config:option:`$cfg['Servers'][$i]['column\_info']` (e.g.
902 ``pma__column_info``)
903 * to update your PRE-2.5.0 Column\_comments table use this: and
904 remember that the Variable in :file:`config.inc.php` has been renamed from
905 :samp:`$cfg['Servers'][$i]['column\_comments']` to
906 :config:option:`$cfg['Servers'][$i]['column\_info']`
908 .. code-block:: mysql
910 ALTER TABLE `pma__column_comments`
911 ADD `mimetype` VARCHAR( 255 ) NOT NULL,
912 ADD `transformation` VARCHAR( 255 ) NOT NULL,
913 ADD `transformation_options` VARCHAR( 255 ) NOT NULL;
914 * to update your PRE-4.3.0 Column\_info table manually use this
915 ``./sql/upgrade_column_info_4_3_0+.sql`` SQL script.
917 This feature can be disabled by setting the configuration to ``false``.
921 For auto-upgrade functionality to work, your
922 :config:option:`$cfg['Servers'][$i]['controluser']` must have ALTER privilege on
923 ``phpmyadmin`` database. See the `MySQL documentation for GRANT
924 <https://dev.mysql.com/doc/refman/5.7/en/grant.html>`_ on how to
925 ``GRANT`` privileges to a user.
928 .. config:option:: $cfg['Servers'][$i]['history']
930 :type: string or false
933 Since release 2.5.0 you can store your :term:`SQL` history, which means all
934 queries you entered manually into the phpMyAdmin interface. If you don't
935 want to use a table-based history, you can use the JavaScript-based
938 Using that, all your history items are deleted when closing the window.
939 Using :config:option:`$cfg['QueryHistoryMax']` you can specify an amount of
940 history items you want to have on hold. On every login, this list gets cut
941 to the maximum amount.
943 The query history is only available if JavaScript is enabled in
946 To allow the usage of this functionality:
948 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
949 * put the table name in :config:option:`$cfg['Servers'][$i]['history']` (e.g.
952 This feature can be disabled by setting the configuration to ``false``.
955 .. config:option:: $cfg['Servers'][$i]['recent']
957 :type: string or false
960 Since release 3.5.0 you can show recently used tables in the
961 navigation panel. It helps you to jump across table directly, without
962 the need to select the database, and then select the table. Using
963 :config:option:`$cfg['NumRecentTables']` you can configure the maximum number
964 of recent tables shown. When you select a table from the list, it will jump to
965 the page specified in :config:option:`$cfg['NavigationTreeDefaultTabTable']`.
967 Without configuring the storage, you can still access the recently used tables,
968 but it will disappear after you logout.
970 To allow the usage of this functionality persistently:
972 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
973 * put the table name in :config:option:`$cfg['Servers'][$i]['recent']` (e.g.
976 This feature can be disabled by setting the configuration to ``false``.
979 .. config:option:: $cfg['Servers'][$i]['favorite']
981 :type: string or false
984 Since release 4.2.0 you can show a list of selected tables in the
985 navigation panel. It helps you to jump to the table directly, without
986 the need to select the database, and then select the table. When you
987 select a table from the list, it will jump to the page specified in
988 :config:option:`$cfg['NavigationTreeDefaultTabTable']`.
990 You can add tables to this list or remove tables from it in database
991 structure page by clicking on the star icons next to table names. Using
992 :config:option:`$cfg['NumFavoriteTables']` you can configure the maximum
993 number of favorite tables shown.
995 Without configuring the storage, you can still access the favorite tables,
996 but it will disappear after you logout.
998 To allow the usage of this functionality persistently:
1000 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
1001 * put the table name in :config:option:`$cfg['Servers'][$i]['favorite']` (e.g.
1004 This feature can be disabled by setting the configuration to ``false``.
1007 .. config:option:: $cfg['Servers'][$i]['table_uiprefs']
1009 :type: string or false
1012 Since release 3.5.0 phpMyAdmin can be configured to remember several
1013 things (sorted column :config:option:`$cfg['RememberSorting']`, column order,
1014 and column visibility from a database table) for browsing tables. Without
1015 configuring the storage, these features still can be used, but the values will
1016 disappear after you logout.
1018 To allow the usage of these functionality persistently:
1020 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
1021 * put the table name in :config:option:`$cfg['Servers'][$i]['table\_uiprefs']` (e.g.
1022 ``pma__table_uiprefs``)
1024 This feature can be disabled by setting the configuration to ``false``.
1026 .. config:option:: $cfg['Servers'][$i]['users']
1028 :type: string or false
1031 The table used by phpMyAdmin to store user name information for associating with user groups.
1032 See the next entry on :config:option:`$cfg['Servers'][$i]['usergroups']` for more details
1033 and the suggested settings.
1035 .. config:option:: $cfg['Servers'][$i]['usergroups']
1037 :type: string or false
1040 Since release 4.1.0 you can create different user groups with menu items
1041 attached to them. Users can be assigned to these groups and the logged in
1042 user would only see menu items configured to the usergroup they are assigned to.
1043 To do this it needs two tables "usergroups" (storing allowed menu items for each
1044 user group) and "users" (storing users and their assignments to user groups).
1046 To allow the usage of this functionality:
1048 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
1049 * put the correct table names in
1050 :config:option:`$cfg['Servers'][$i]['users']` (e.g. ``pma__users``) and
1051 :config:option:`$cfg['Servers'][$i]['usergroups']` (e.g. ``pma__usergroups``)
1053 This feature can be disabled by setting either of the configurations to ``false``.
1055 .. seealso:: :ref:`configurablemenus`
1057 .. _navigationhiding:
1058 .. config:option:: $cfg['Servers'][$i]['navigationhiding']
1060 :type: string or false
1063 Since release 4.1.0 you can hide/show items in the navigation tree.
1065 To allow the usage of this functionality:
1067 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
1068 * put the table name in :config:option:`$cfg['Servers'][$i]['navigationhiding']` (e.g.
1069 ``pma__navigationhiding``)
1071 This feature can be disabled by setting the configuration to ``false``.
1073 .. _central_columns:
1074 .. config:option:: $cfg['Servers'][$i]['central_columns']
1076 :type: string or false
1079 Since release 4.3.0 you can have a central list of columns per database.
1080 You can add/remove columns to the list as per your requirement. These columns
1081 in the central list will be available to use while you create a new column for
1082 a table or create a table itself. You can select a column from central list
1083 while creating a new column, it will save you from writing the same column definition
1084 over again or from writing different names for similar column.
1086 To allow the usage of this functionality:
1088 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
1089 * put the table name in :config:option:`$cfg['Servers'][$i]['central_columns']` (e.g.
1090 ``pma__central_columns``)
1092 This feature can be disabled by setting the configuration to ``false``.
1094 .. _designer_settings:
1095 .. config:option:: $cfg['Servers'][$i]['designer_settings']
1097 :type: string or false
1100 Since release 4.5.0 your designer settings can be remembered.
1101 Your choice regarding 'Angular/Direct Links', 'Snap to Grid', 'Toggle Relation Lines',
1102 'Small/Big All', 'Move Menu' and 'Pin Text' can be remembered persistently.
1104 To allow the usage of this functionality:
1106 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
1107 * put the table name in :config:option:`$cfg['Servers'][$i]['designer_settings']` (e.g.
1108 ``pma__designer_settings``)
1110 This feature can be disabled by setting the configuration to ``false``.
1113 .. config:option:: $cfg['Servers'][$i]['savedsearches']
1115 :type: string or false
1118 Since release 4.2.0 you can save and load query-by-example searches from the Database > Query panel.
1120 To allow the usage of this functionality:
1122 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
1123 * put the table name in :config:option:`$cfg['Servers'][$i]['savedsearches']` (e.g.
1124 ``pma__savedsearches``)
1126 This feature can be disabled by setting the configuration to ``false``.
1128 .. _export_templates:
1129 .. config:option:: $cfg['Servers'][$i]['export_templates']
1131 :type: string or false
1134 Since release 4.5.0 you can save and load export templates.
1136 To allow the usage of this functionality:
1138 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
1139 * put the table name in :config:option:`$cfg['Servers'][$i]['export_templates']` (e.g.
1140 ``pma__export_templates``)
1142 This feature can be disabled by setting the configuration to ``false``.
1145 .. config:option:: $cfg['Servers'][$i]['tracking']
1147 :type: string or false
1150 Since release 3.3.x a tracking mechanism is available. It helps you to
1151 track every :term:`SQL` command which is
1152 executed by phpMyAdmin. The mechanism supports logging of data
1153 manipulation and data definition statements. After enabling it you can
1154 create versions of tables.
1156 The creation of a version has two effects:
1158 * phpMyAdmin saves a snapshot of the table, including structure and
1160 * phpMyAdmin logs all commands which change the structure and/or data of
1161 the table and links these commands with the version number.
1163 Of course you can view the tracked changes. On the :guilabel:`Tracking`
1164 page a complete report is available for every version. For the report you
1165 can use filters, for example you can get a list of statements within a date
1166 range. When you want to filter usernames you can enter \* for all names or
1167 you enter a list of names separated by ','. In addition you can export the
1168 (filtered) report to a file or to a temporary database.
1170 To allow the usage of this functionality:
1172 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
1173 * put the table name in :config:option:`$cfg['Servers'][$i]['tracking']` (e.g.
1176 This feature can be disabled by setting the configuration to ``false``.
1179 .. config:option:: $cfg['Servers'][$i]['tracking_version_auto_create']
1184 Whether the tracking mechanism creates versions for tables and views
1187 If this is set to true and you create a table or view with
1192 and no version exists for it, the mechanism will create a version for
1196 .. config:option:: $cfg['Servers'][$i]['tracking_default_statements']
1199 :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'``
1201 Defines the list of statements the auto-creation uses for new
1205 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_view']
1210 Whether a DROP VIEW IF EXISTS statement will be added as first line to
1211 the log when creating a view.
1214 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_table']
1219 Whether a DROP TABLE IF EXISTS statement will be added as first line
1220 to the log when creating a table.
1223 .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_database']
1228 Whether a DROP DATABASE IF EXISTS statement will be added as first
1229 line to the log when creating a database.
1232 .. config:option:: $cfg['Servers'][$i]['userconfig']
1234 :type: string or false
1237 Since release 3.4.x phpMyAdmin allows users to set most preferences by
1238 themselves and store them in the database.
1240 If you don't allow for storing preferences in
1241 :config:option:`$cfg['Servers'][$i]['pmadb']`, users can still personalize
1242 phpMyAdmin, but settings will be saved in browser's local storage, or, it
1243 is is unavailable, until the end of session.
1245 To allow the usage of this functionality:
1247 * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage
1248 * put the table name in :config:option:`$cfg['Servers'][$i]['userconfig']`
1250 This feature can be disabled by setting the configuration to ``false``.
1252 .. config:option:: $cfg['Servers'][$i]['MaxTableUiprefs']
1257 Maximum number of rows saved in
1258 :config:option:`$cfg['Servers'][$i]['table_uiprefs']` table.
1260 When tables are dropped or renamed,
1261 :config:option:`$cfg['Servers'][$i]['table_uiprefs']` may contain invalid data
1262 (referring to tables which no longer exist). We only keep this number of newest
1263 rows in :config:option:`$cfg['Servers'][$i]['table_uiprefs']` and automatically
1266 .. config:option:: $cfg['Servers'][$i]['SessionTimeZone']
1271 Sets the time zone used by phpMyAdmin. Leave blank to use the time zone of your
1272 database server. Possible values are explained at
1273 https://dev.mysql.com/doc/refman/5.7/en/time-zone-support.html
1275 This is useful when your database server uses a time zone which is different from the
1276 time zone you want to use in phpMyAdmin.
1278 .. config:option:: $cfg['Servers'][$i]['AllowRoot']
1283 Whether to allow root access. This is just a shortcut for the
1284 :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` below.
1286 .. config:option:: $cfg['Servers'][$i]['AllowNoPassword']
1291 Whether to allow logins without a password. The default value of
1292 ``false`` for this parameter prevents unintended access to a MySQL
1293 server with was left with an empty password for root or on which an
1294 anonymous (blank) user is defined.
1296 .. _servers_allowdeny_order:
1297 .. config:option:: $cfg['Servers'][$i]['AllowDeny']['order']
1302 If your rule order is empty, then :term:`IP`
1303 authorization is disabled.
1305 If your rule order is set to
1306 ``'deny,allow'`` then the system applies all deny rules followed by
1307 allow rules. Access is allowed by default. Any client which does not
1308 match a Deny command or does match an Allow command will be allowed
1309 access to the server.
1311 If your rule order is set to ``'allow,deny'``
1312 then the system applies all allow rules followed by deny rules. Access
1313 is denied by default. Any client which does not match an Allow
1314 directive or does match a Deny directive will be denied access to the
1317 If your rule order is set to ``'explicit'``, authorization is
1318 performed in a similar fashion to rule order 'deny,allow', with the
1319 added restriction that your host/username combination **must** be
1320 listed in the *allow* rules, and not listed in the *deny* rules. This
1321 is the **most** secure means of using Allow/Deny rules, and was
1322 available in Apache by specifying allow and deny rules without setting
1325 Please also see :config:option:`$cfg['TrustedProxies']` for
1326 detecting IP address behind proxies.
1328 .. _servers_allowdeny_rules:
1329 .. config:option:: $cfg['Servers'][$i]['AllowDeny']['rules']
1331 :type: array of strings
1334 The general format for the rules is as such:
1336 .. code-block:: none
1338 <'allow' | 'deny'> <username> [from] <ipmask>
1340 If you wish to match all users, it is possible to use a ``'%'`` as a
1341 wildcard in the *username* field.
1343 There are a few shortcuts you can
1344 use in the *ipmask* field as well (please note that those containing
1345 SERVER\_ADDRESS might not be available on all webservers):
1347 .. code-block:: none
1350 'localhost' -> 127.0.0.1/8
1351 'localnetA' -> SERVER_ADDRESS/8
1352 'localnetB' -> SERVER_ADDRESS/16
1353 'localnetC' -> SERVER_ADDRESS/24
1355 Having an empty rule list is equivalent to either using ``'allow %
1356 from all'`` if your rule order is set to ``'deny,allow'`` or ``'deny %
1357 from all'`` if your rule order is set to ``'allow,deny'`` or
1360 For the :term:`IP Address` matching
1361 system, the following work:
1363 * ``xxx.xxx.xxx.xxx`` (an exact :term:`IP Address`)
1364 * ``xxx.xxx.xxx.[yyy-zzz]`` (an :term:`IP Address` range)
1365 * ``xxx.xxx.xxx.xxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IP` addresses)
1367 But the following does not work:
1369 * ``xxx.xxx.xxx.xx[yyy-zzz]`` (partial :term:`IP` address range)
1371 For :term:`IPv6` addresses, the following work:
1373 * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx`` (an exact :term:`IPv6` address)
1374 * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:[yyyy-zzzz]`` (an :term:`IPv6` address range)
1375 * ``xxxx:xxxx:xxxx:xxxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IPv6` addresses)
1377 But the following does not work:
1379 * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xx[yyy-zzz]`` (partial :term:`IPv6` address range)
1383 .. code-block:: none
1385 $cfg['Servers'][$i]['AllowDeny']['order'] = 'allow,deny';
1386 $cfg['Servers'][$i]['AllowDeny']['rules'] = array('allow bob from all');
1387 // Allow only 'bob' to connect from any host
1389 $cfg['Servers'][$i]['AllowDeny']['order'] = 'allow,deny';
1390 $cfg['Servers'][$i]['AllowDeny']['rules'] = array('allow mary from 192.168.100.[50-100]');
1391 // Allow only 'mary' to connect from host 192.168.100.50 through 192.168.100.100
1393 $cfg['Servers'][$i]['AllowDeny']['order'] = 'allow,deny';
1394 $cfg['Servers'][$i]['AllowDeny']['rules'] = array('allow % from 192.168.[5-6].10');
1395 // Allow any user to connect from host 192.168.5.10 or 192.168.6.10
1397 $cfg['Servers'][$i]['AllowDeny']['order'] = 'allow,deny';
1398 $cfg['Servers'][$i]['AllowDeny']['rules'] = array('allow root from 192.168.5.50','allow % from 192.168.6.10');
1399 // Allow any user to connect from 192.168.6.10, and additionally allow root to connect from 192.168.5.50
1401 .. config:option:: $cfg['Servers'][$i]['DisableIS']
1406 Disable using ``INFORMATION_SCHEMA`` to retrieve information (use
1407 ``SHOW`` commands instead), because of speed issues when many
1408 databases are present.
1412 Enabling this option might give you a big performance boost on older
1415 .. config:option:: $cfg['Servers'][$i]['SignonScript']
1420 .. versionadded:: 3.5.0
1422 Name of PHP script to be sourced and executed to obtain login
1423 credentials. This is alternative approach to session based single
1424 signon. The script has to provide a function called
1425 ``get_login_credentials`` which returns list of username and
1426 password, accepting single parameter of existing username (can be
1427 empty). See :file:`examples/signon-script.php` for an example:
1429 .. literalinclude:: ../examples/signon-script.php
1432 .. seealso:: :ref:`auth_signon`
1434 .. config:option:: $cfg['Servers'][$i]['SignonSession']
1439 Name of session which will be used for signon authentication method.
1440 You should use something different than ``phpMyAdmin``, because this
1441 is session which phpMyAdmin uses internally. Takes effect only if
1442 :config:option:`$cfg['Servers'][$i]['SignonScript']` is not configured.
1444 .. seealso:: :ref:`auth_signon`
1446 .. config:option:: $cfg['Servers'][$i]['SignonCookieParams']
1449 :default: ``array()``
1451 .. versionadded:: 4.7.0
1453 An associative array of session cookie parameters of other authentication system.
1454 It is not needed if the other system doesn't use session_set_cookie_params().
1455 Keys should include 'lifetime', 'path', 'domain', 'secure' or 'httponly'.
1456 Valid values are mentioned in `session_get_cookie_params <https://www.php.net/manual/en/
1457 function.session-get-cookie-params.php>`_, they should be set to same values as the
1458 other application uses. Takes effect only if
1459 :config:option:`$cfg['Servers'][$i]['SignonScript']` is not configured.
1461 .. seealso:: :ref:`auth_signon`
1463 .. config:option:: $cfg['Servers'][$i]['SignonURL']
1468 :term:`URL` where user will be redirected
1469 to log in for signon authentication method. Should be absolute
1472 .. seealso:: :ref:`auth_signon`
1474 .. config:option:: $cfg['Servers'][$i]['LogoutURL']
1479 :term:`URL` where user will be redirected
1480 after logout (doesn't affect config authentication method). Should be
1481 absolute including protocol.
1486 .. config:option:: $cfg['DisableShortcutKeys']
1491 You can disable phpMyAdmin shortcut keys by setting :config:option:`$cfg['DisableShortcutKeys']` to false.
1493 .. config:option:: $cfg['ServerDefault']
1498 If you have more than one server configured, you can set
1499 :config:option:`$cfg['ServerDefault']` to any one of them to autoconnect to that
1500 server when phpMyAdmin is started, or set it to 0 to be given a list
1501 of servers without logging in.
1503 If you have only one server configured,
1504 :config:option:`$cfg['ServerDefault']` MUST be set to that server.
1506 .. config:option:: $cfg['VersionCheck']
1511 Enables check for latest versions using JavaScript on the main phpMyAdmin
1512 page or by directly accessing `index.php?route=/version-check`.
1516 This setting can be adjusted by your vendor.
1518 .. config:option:: $cfg['ProxyUrl']
1523 The url of the proxy to be used when phpmyadmin needs to access the outside
1524 internet such as when retrieving the latest version info or submitting error
1525 reports. You need this if the server where phpMyAdmin is installed does not
1526 have direct access to the internet.
1527 The format is: "hostname:portnumber"
1529 .. config:option:: $cfg['ProxyUser']
1534 The username for authenticating with the proxy. By default, no
1535 authentication is performed. If a username is supplied, Basic
1536 Authentication will be performed. No other types of authentication
1537 are currently supported.
1539 .. config:option:: $cfg['ProxyPass']
1544 The password for authenticating with the proxy.
1546 .. config:option:: $cfg['MaxDbList']
1551 The maximum number of database names to be displayed in the main panel's
1554 .. config:option:: $cfg['MaxTableList']
1559 The maximum number of table names to be displayed in the main panel's
1560 list (except on the Export page).
1562 .. config:option:: $cfg['ShowHint']
1567 Whether or not to show hints (for example, hints when hovering over
1570 .. config:option:: $cfg['MaxCharactersInDisplayedSQL']
1575 The maximum number of characters when a :term:`SQL` query is displayed. The
1576 default limit of 1000 should be correct to avoid the display of tons of
1577 hexadecimal codes that represent BLOBs, but some users have real
1578 :term:`SQL` queries that are longer than 1000 characters. Also, if a
1579 query's length exceeds this limit, this query is not saved in the history.
1581 .. config:option:: $cfg['PersistentConnections']
1586 Whether `persistent connections <https://www.php.net/manual/en/features
1587 .persistent-connections.php>`_ should be used or not. Works with
1588 following extensions:
1590 * mysql (`mysql\_pconnect <https://www.php.net/manual/en/function.mysql-
1592 * mysqli (requires PHP 5.3.0 or newer, `more information
1593 <https://www.php.net/manual/en/mysqli.persistconns.php>`_).
1595 .. config:option:: $cfg['ForceSSL']
1600 .. deprecated:: 4.6.0
1602 This setting is no longer available since phpMyAdmin 4.6.0. Please
1603 adjust your webserver instead.
1605 Whether to force using https while accessing phpMyAdmin. In a reverse
1606 proxy setup, setting this to ``true`` is not supported.
1610 In some setups (like separate SSL proxy or load balancer) you might
1611 have to set :config:option:`$cfg['PmaAbsoluteUri']` for correct
1614 .. config:option:: $cfg['MysqlSslWarningSafeHosts']
1617 :default: ``['127.0.0.1', 'localhost']``
1619 This search is case-sensitive and will match the exact string only.
1620 If your setup does not use SSL but is safe because you are using a
1621 local connection or private network, you can add your hostname or :term:`IP` to the list.
1622 You can also remove the default entries to only include yours.
1624 This check uses the value of :config:option:`$cfg['Servers'][$i]['host']`.
1626 .. versionadded:: 5.1.0
1628 Example configuration
1632 $cfg['MysqlSslWarningSafeHosts'] = ['127.0.0.1', 'localhost', 'mariadb.local'];
1635 .. config:option:: $cfg['ExecTimeLimit']
1637 :type: integer [number of seconds]
1640 Set the number of seconds a script is allowed to run. If seconds is
1641 set to zero, no time limit is imposed. This setting is used while
1642 importing/exporting dump files but has
1643 no effect when PHP is running in safe mode.
1645 .. config:option:: $cfg['SessionSavePath']
1650 Path for storing session data (`session\_save\_path PHP parameter
1651 <https://www.php.net/session_save_path>`_).
1655 This folder should not be publicly accessible through the webserver,
1656 otherwise you risk leaking private data from your session.
1658 .. config:option:: $cfg['MemoryLimit']
1660 :type: string [number of bytes]
1663 Set the number of bytes a script is allowed to allocate. If set to
1664 ``'-1'``, no limit is imposed. If set to ``'0'``, no change of the
1665 memory limit is attempted and the :file:`php.ini` ``memory_limit`` is
1668 This setting is used while importing/exporting dump files
1669 so you definitely don't want to put here a too low
1670 value. It has no effect when PHP is running in safe mode.
1672 You can also use any string as in :file:`php.ini`, eg. '16M'. Ensure you
1673 don't omit the suffix (16 means 16 bytes!)
1675 .. config:option:: $cfg['SkipLockedTables']
1680 Mark used tables and make it possible to show databases with locked
1681 tables (since MySQL 3.23.30).
1683 .. config:option:: $cfg['ShowSQL']
1688 Defines whether :term:`SQL` queries
1689 generated by phpMyAdmin should be displayed or not.
1691 .. config:option:: $cfg['RetainQueryBox']
1696 Defines whether the :term:`SQL` query box
1697 should be kept displayed after its submission.
1699 .. config:option:: $cfg['CodemirrorEnable']
1704 Defines whether to use a Javascript code editor for SQL query boxes.
1705 CodeMirror provides syntax highlighting and line numbers. However,
1706 middle-clicking for pasting the clipboard contents in some Linux
1707 distributions (such as Ubuntu) is not supported by all browsers.
1709 .. config:option:: $cfg['DefaultForeignKeyChecks']
1712 :default: ``'default'``
1714 Default value of the checkbox for foreign key checks, to disable/enable
1715 foreign key checks for certain queries. The possible values are ``'default'``,
1716 ``'enable'`` or ``'disable'``. If set to ``'default'``, the value of the
1717 MySQL variable ``FOREIGN_KEY_CHECKS`` is used.
1719 .. config:option:: $cfg['AllowUserDropDatabase']
1726 This is not a security measure as there will be always ways to
1727 circumvent this. If you want to prohibit users from dropping databases,
1728 revoke their corresponding DROP privilege.
1730 Defines whether normal users (non-administrator) are allowed to delete
1731 their own database or not. If set as false, the link :guilabel:`Drop
1732 Database` will not be shown, and even a ``DROP DATABASE mydatabase`` will
1733 be rejected. Quite practical for :term:`ISP` 's with many customers.
1735 This limitation of :term:`SQL` queries is not as strict as when using MySQL
1736 privileges. This is due to nature of :term:`SQL` queries which might be
1737 quite complicated. So this choice should be viewed as help to avoid
1738 accidental dropping rather than strict privilege limitation.
1740 .. config:option:: $cfg['Confirm']
1745 Whether a warning ("Are your really sure...") should be displayed when
1746 you're about to lose data.
1748 .. config:option:: $cfg['UseDbSearch']
1753 Define whether the "search string inside database" is enabled or not.
1755 .. config:option:: $cfg['IgnoreMultiSubmitErrors']
1760 Define whether phpMyAdmin will continue executing a multi-query
1761 statement if one of the queries fails. Default is to abort execution.
1763 .. config:option:: $cfg['enable_drag_drop_import']
1768 Whether or not the drag and drop import feature is enabled.
1769 When enabled, a user can drag a file in to their browser and phpMyAdmin will
1770 attempt to import the file.
1772 Cookie authentication options
1773 -----------------------------
1775 .. config:option:: $cfg['blowfish_secret']
1780 The "cookie" auth\_type uses AES algorithm to encrypt the password. If you
1781 are using the "cookie" auth\_type, enter here a random passphrase of your
1782 choice. It will be used internally by the AES algorithm: you won’t be
1783 prompted for this passphrase.
1785 The secret should be 32 characters long. Using shorter will lead to weaker security
1786 of encrypted cookies, using longer will cause no harm.
1790 The configuration is called blowfish_secret for historical reasons as
1791 Blowfish algorithm was originally used to do the encryption.
1793 .. versionchanged:: 3.1.0
1794 Since version 3.1.0 phpMyAdmin can generate this on the fly, but it
1795 makes a bit weaker security as this generated secret is stored in
1796 session and furthermore it makes impossible to recall user name from
1799 .. config:option:: $cfg['CookieSameSite']
1802 :default: ``'Strict'``
1804 .. versionadded:: 5.1.0
1806 It sets SameSite attribute of the Set-Cookie :term:`HTTP` response header.
1813 .. seealso:: `rfc6265 bis <https://tools.ietf.org/id/draft-ietf-httpbis-rfc6265bis-03.html#rfc.section.5.3.7>`_
1815 .. config:option:: $cfg['LoginCookieRecall']
1820 Define whether the previous login should be recalled or not in cookie
1821 authentication mode.
1823 This is automatically disabled if you do not have
1824 configured :config:option:`$cfg['blowfish_secret']`.
1826 .. config:option:: $cfg['LoginCookieValidity']
1828 :type: integer [number of seconds]
1831 Define how long a login cookie is valid. Please note that php
1832 configuration option `session.gc\_maxlifetime
1833 <https://www.php.net/manual/en/session.configuration.php#ini.session.gc-
1834 maxlifetime>`_ might limit session validity and if the session is lost,
1835 the login cookie is also invalidated. So it is a good idea to set
1836 ``session.gc_maxlifetime`` at least to the same value of
1837 :config:option:`$cfg['LoginCookieValidity']`.
1839 .. config:option:: $cfg['LoginCookieStore']
1841 :type: integer [number of seconds]
1844 Define how long login cookie should be stored in browser. Default 0
1845 means that it will be kept for existing session. This is recommended
1846 for not trusted environments.
1848 .. config:option:: $cfg['LoginCookieDeleteAll']
1853 If enabled (default), logout deletes cookies for all servers,
1854 otherwise only for current one. Setting this to false makes it easy to
1855 forget to log out from other server, when you are using more of them.
1857 .. _AllowArbitraryServer:
1858 .. config:option:: $cfg['AllowArbitraryServer']
1863 If enabled, allows you to log in to arbitrary servers using cookie
1868 Please use this carefully, as this may allow users access to MySQL servers
1869 behind the firewall where your :term:`HTTP` server is placed.
1870 See also :config:option:`$cfg['ArbitraryServerRegexp']`.
1872 .. config:option:: $cfg['ArbitraryServerRegexp']
1877 Restricts the MySQL servers to which the user can log in when
1878 :config:option:`$cfg['AllowArbitraryServer']` is enabled by
1879 matching the :term:`IP` or the hostname of the MySQL server
1880 to the given regular expression. The regular expression must be enclosed
1881 with a delimiter character.
1883 It is recommended to include start and end symbols in the regular
1884 expression, so that you can avoid partial matches on the string.
1890 // Allow connection to three listed servers:
1891 $cfg['ArbitraryServerRegexp'] = '/^(server|another|yetdifferent)$/';
1893 // Allow connection to range of IP addresses:
1894 $cfg['ArbitraryServerRegexp'] = '@^192\.168\.0\.[0-9]{1,}$@';
1896 // Allow connection to server name ending with -mysql:
1897 $cfg['ArbitraryServerRegexp'] = '@^[^:]\-mysql$@';
1901 The whole server name is matched, it can include port as well. Due to
1902 way MySQL is permissive in connection parameters, it is possible to use
1903 connection strings as ```server:3306-mysql```. This can be used to
1904 bypass regular expression by the suffix, while connecting to another
1907 .. config:option:: $cfg['CaptchaMethod']
1910 :default: ``'invisible'``
1914 * ``'invisible'`` Use an invisible captcha checking method;
1915 * ``'checkbox'`` Use a checkbox to confirm the user is not a robot.
1917 .. versionadded:: 5.0.3
1919 .. config:option:: $cfg['CaptchaApi']
1922 :default: ``'https://www.google.com/recaptcha/api.js'``
1924 .. versionadded:: 5.1.0
1926 The URL for the reCaptcha v2 service's API, either Google's or a compatible one.
1928 .. config:option:: $cfg['CaptchaCsp']
1931 :default: ``'https://apis.google.com https://www.google.com/recaptcha/ https://www.gstatic.com/recaptcha/ https://ssl.gstatic.com/'``
1933 .. versionadded:: 5.1.0
1935 The Content-Security-Policy snippet (URLs from which to allow embedded content)
1936 for the reCaptcha v2 service, either Google's or a compatible one.
1938 .. config:option:: $cfg['CaptchaRequestParam']
1941 :default: ``'g-recaptcha'``
1943 .. versionadded:: 5.1.0
1945 The request parameter used for the reCaptcha v2 service.
1947 .. config:option:: $cfg['CaptchaResponseParam']
1950 :default: ``'g-recaptcha-response'``
1952 .. versionadded:: 5.1.0
1954 The response parameter used for the reCaptcha v2 service.
1956 .. config:option:: $cfg['CaptchaLoginPublicKey']
1961 The public key for the reCaptcha service that can be obtained from the
1962 "Admin Console" on https://www.google.com/recaptcha/about/.
1964 .. seealso:: <https://developers.google.com/recaptcha/docs/v3>
1966 reCaptcha will be then used in :ref:`cookie`.
1968 .. config:option:: $cfg['CaptchaLoginPrivateKey']
1973 The private key for the reCaptcha service that can be obtained from the
1974 "Admin Console" on https://www.google.com/recaptcha/about/.
1976 .. seealso:: <https://developers.google.com/recaptcha/docs/v3>
1978 reCaptcha will be then used in :ref:`cookie`.
1980 .. config:option:: $cfg['CaptchaSiteVerifyURL']
1985 The URL for the reCaptcha service to do siteverify action.
1987 reCaptcha will be then used in :ref:`cookie`.
1989 .. versionadded:: 5.1.0
1991 Navigation panel setup
1992 ----------------------
1994 .. config:option:: $cfg['ShowDatabasesNavigationAsTree']
1999 In the navigation panel, replaces the database tree with a selector
2001 .. config:option:: $cfg['FirstLevelNavigationItems']
2006 The number of first level databases that can be displayed on each page
2009 .. config:option:: $cfg['MaxNavigationItems']
2014 The number of items (tables, columns, indexes) that can be displayed on each
2015 page of the navigation tree.
2017 .. config:option:: $cfg['NavigationTreeEnableGrouping']
2022 Defines whether to group the databases based on a common prefix
2023 in their name :config:option:`$cfg['NavigationTreeDbSeparator']`.
2025 .. config:option:: $cfg['NavigationTreeDbSeparator']
2030 The string used to separate the parts of the database name when
2031 showing them in a tree.
2033 .. config:option:: $cfg['NavigationTreeTableSeparator']
2035 :type: string or array
2038 Defines a string to be used to nest table spaces. This means if you have
2039 tables like ``first__second__third`` this will be shown as a three-level
2040 hierarchy like: first > second > third. If set to false or empty, the
2041 feature is disabled. NOTE: You should not use this separator at the
2042 beginning or end of a table name or multiple times after another without
2043 any other characters in between.
2045 .. config:option:: $cfg['NavigationTreeTableLevel']
2050 Defines how many sublevels should be displayed when splitting up
2051 tables by the above separator.
2053 .. config:option:: $cfg['NumRecentTables']
2058 The maximum number of recently used tables shown in the navigation
2059 panel. Set this to 0 (zero) to disable the listing of recent tables.
2061 .. config:option:: $cfg['NumFavoriteTables']
2066 The maximum number of favorite tables shown in the navigation
2067 panel. Set this to 0 (zero) to disable the listing of favorite tables.
2069 .. config:option:: $cfg['ZeroConf']
2074 Enables Zero Configuration mode in which the user will be offered a choice to
2075 create phpMyAdmin configuration storage in the current database
2076 or use the existing one, if already present.
2078 This setting has no effect if the phpMyAdmin configuration storage database
2079 is properly created and the related configuration directives (such as
2080 :config:option:`$cfg['Servers'][$i]['pmadb']` and so on) are configured.
2082 .. config:option:: $cfg['NavigationLinkWithMainPanel']
2087 Defines whether or not to link with main panel by highlighting
2088 the current database or table.
2090 .. config:option:: $cfg['NavigationDisplayLogo']
2095 Defines whether or not to display the phpMyAdmin logo at the top of
2096 the navigation panel.
2098 .. config:option:: $cfg['NavigationLogoLink']
2101 :default: ``'index.php'``
2103 Enter the :term:`URL` where the logo in the navigation panel will point to.
2104 For use especially with self made theme which changes this.
2105 For relative/internal URLs, you need to have leading `` ./ `` or trailing characters `` ? `` such as ``'./index.php?route=/server/sql?'``.
2106 For external URLs, you should include URL protocol schemes (``http`` or ``https``) with absolute URLs.
2108 You may want to make the link open in a new browser tab, for that you need to use :config:option:`$cfg['NavigationLogoLinkWindow']`
2110 .. config:option:: $cfg['NavigationLogoLinkWindow']
2113 :default: ``'main'``
2115 Whether to open the linked page in the main window (``main``) or in a
2116 new one (``new``). Note: use ``new`` if you are linking to
2119 To open the link in the main window you will need to add the value of :config:option:`$cfg['NavigationLogoLink']`
2120 to :config:option:`$cfg['CSPAllow']` because of the :term:`Content Security Policy` header.
2122 .. config:option:: $cfg['NavigationTreeDisplayItemFilterMinimum']
2127 Defines the minimum number of items (tables, views, routines and
2128 events) to display a JavaScript filter box above the list of items in
2129 the navigation tree.
2131 To disable the filter completely some high number can be used (e.g. 9999)
2133 .. config:option:: $cfg['NavigationTreeDisplayDbFilterMinimum']
2138 Defines the minimum number of databases to display a JavaScript filter
2139 box above the list of databases in the navigation tree.
2141 To disable the filter completely some high number can be used
2144 .. config:option:: $cfg['NavigationDisplayServers']
2149 Defines whether or not to display a server choice at the top of the
2152 .. config:option:: $cfg['DisplayServersList']
2157 Defines whether to display this server choice as links instead of in a
2160 .. config:option:: $cfg['NavigationTreeDefaultTabTable']
2163 :default: ``'structure'``
2165 Defines the tab displayed by default when clicking the small icon next
2166 to each table name in the navigation panel. The possible values are the
2167 localized equivalent of:
2175 .. config:option:: $cfg['NavigationTreeDefaultTabTable2']
2180 Defines the tab displayed by default when clicking the second small icon next
2181 to each table name in the navigation panel. The possible values are the
2182 localized equivalent of:
2191 .. config:option:: $cfg['NavigationTreeEnableExpansion']
2196 Whether to offer the possibility of tree expansion in the navigation panel.
2198 .. config:option:: $cfg['NavigationTreeShowTables']
2203 Whether to show tables under database in the navigation panel.
2205 .. config:option:: $cfg['NavigationTreeShowViews']
2210 Whether to show views under database in the navigation panel.
2212 .. config:option:: $cfg['NavigationTreeShowFunctions']
2217 Whether to show functions under database in the navigation panel.
2219 .. config:option:: $cfg['NavigationTreeShowProcedures']
2224 Whether to show procedures under database in the navigation panel.
2226 .. config:option:: $cfg['NavigationTreeShowEvents']
2231 Whether to show events under database in the navigation panel.
2233 .. config:option:: $cfg['NavigationWidth']
2238 Navigation panel width, set to 0 to collapse it by default.
2243 .. config:option:: $cfg['ShowStats']
2248 Defines whether or not to display space usage and statistics about
2249 databases and tables. Note that statistics requires at least MySQL
2250 3.23.3 and that, at this date, MySQL doesn't return such information
2251 for Berkeley DB tables.
2253 .. config:option:: $cfg['ShowServerInfo']
2258 Defines whether to display detailed server information on main page.
2259 You can additionally hide more information by using
2260 :config:option:`$cfg['Servers'][$i]['verbose']`.
2262 .. config:option:: $cfg['ShowPhpInfo']
2267 Defines whether to display the :guilabel:`PHP information` or not at
2268 the starting main (right) frame.
2270 Please note that to block the usage of ``phpinfo()`` in scripts, you have to
2271 put this in your :file:`php.ini`:
2275 disable_functions = phpinfo()
2279 Enabling phpinfo page will leak quite a lot of information about server
2280 setup. Is it not recommended to enable this on shared installations.
2282 This might also make easier some remote attacks on your installations,
2283 so enable this only when needed.
2285 .. config:option:: $cfg['ShowChgPassword']
2290 Defines whether to display the :guilabel:`Change password` link or not at
2291 the starting main (right) frame. This setting does not check MySQL commands
2294 Please note that enabling the :guilabel:`Change password` link has no effect
2295 with config authentication mode: because of the hard coded password value
2296 in the configuration file, end users can't be allowed to change their
2299 .. config:option:: $cfg['ShowCreateDb']
2304 Defines whether to display the form for creating database or not at the
2305 starting main (right) frame. This setting does not check MySQL commands
2308 .. config:option:: $cfg['ShowGitRevision']
2313 Defines whether to display information about the current Git revision (if
2314 applicable) on the main panel.
2316 .. config:option:: $cfg['MysqlMinVersion']
2320 Defines the minimum supported MySQL version. The default is chosen
2321 by the phpMyAdmin team; however this directive was asked by a developer
2322 of the Plesk control panel to ease integration with older MySQL servers
2323 (where most of the phpMyAdmin features work).
2328 .. config:option:: $cfg['ShowDbStructureCreation']
2333 Defines whether the database structure page (tables list) has a
2334 "Creation" column that displays when each table was created.
2336 .. config:option:: $cfg['ShowDbStructureLastUpdate']
2341 Defines whether the database structure page (tables list) has a "Last
2342 update" column that displays when each table was last updated.
2344 .. config:option:: $cfg['ShowDbStructureLastCheck']
2349 Defines whether the database structure page (tables list) has a "Last
2350 check" column that displays when each table was last checked.
2352 .. config:option:: $cfg['HideStructureActions']
2357 Defines whether the table structure actions are hidden under a "More"
2360 .. config:option:: $cfg['ShowColumnComments']
2365 Defines whether to show column comments as a column in the table structure view.
2370 .. config:option:: $cfg['TableNavigationLinksMode']
2373 :default: ``'icons'``
2375 Defines whether the table navigation links contain ``'icons'``, ``'text'``
2378 .. config:option:: $cfg['ActionLinksMode']
2381 :default: ``'both'``
2383 If set to ``icons``, will display icons instead of text for db and table
2384 properties links (like :guilabel:`Browse`, :guilabel:`Select`,
2385 :guilabel:`Insert`, ...). Can be set to ``'both'``
2386 if you want icons AND text. When set to ``text``, will only show text.
2388 .. config:option:: $cfg['RowActionType']
2391 :default: ``'both'``
2393 Whether to display icons or text or both icons and text in table row action
2394 segment. Value can be either of ``'icons'``, ``'text'`` or ``'both'``.
2396 .. config:option:: $cfg['ShowAll']
2401 Defines whether a user should be displayed a "Show all" button in browse
2402 mode or not in all cases. By default it is shown only on small tables (less
2403 than 500 rows) to avoid performance issues while getting too many rows.
2405 .. config:option:: $cfg['MaxRows']
2410 Number of rows displayed when browsing a result set and no LIMIT
2411 clause is used. If the result set contains more rows, "Previous" and
2412 "Next" links will be shown. Possible values: 25,50,100,250,500.
2414 .. config:option:: $cfg['Order']
2417 :default: ``'SMART'``
2419 Defines whether columns are displayed in ascending (``ASC``) order, in
2420 descending (``DESC``) order or in a "smart" (``SMART``) order - I.E.
2421 descending order for columns of type TIME, DATE, DATETIME and
2422 TIMESTAMP, ascending order else- by default.
2424 .. versionchanged:: 3.4.0
2425 Since phpMyAdmin 3.4.0 the default value is ``'SMART'``.
2427 .. config:option:: $cfg['GridEditing']
2430 :default: ``'double-click'``
2432 Defines which action (``double-click`` or ``click``) triggers grid
2433 editing. Can be deactivated with the ``disabled`` value.
2435 .. config:option:: $cfg['RelationalDisplay']
2440 Defines the initial behavior for Options > Relational. ``K``, which
2441 is the default, displays the key while ``D`` shows the display column.
2443 .. config:option:: $cfg['SaveCellsAtOnce']
2448 Defines whether or not to save all edited cells at once for grid
2454 .. config:option:: $cfg['ProtectBinary']
2456 :type: boolean or string
2457 :default: ``'blob'``
2459 Defines whether ``BLOB`` or ``BINARY`` columns are protected from
2460 editing when browsing a table's content. Valid values are:
2462 * ``false`` to allow editing of all columns;
2463 * ``'blob'`` to allow editing of all columns except ``BLOBS``;
2464 * ``'noblob'`` to disallow editing of all columns except ``BLOBS`` (the
2465 opposite of ``'blob'``);
2466 * ``'all'`` to disallow editing of all ``BINARY`` or ``BLOB`` columns.
2468 .. config:option:: $cfg['ShowFunctionFields']
2473 Defines whether or not MySQL functions fields should be initially
2474 displayed in edit/insert mode. Since version 2.10, the user can toggle
2475 this setting from the interface.
2477 .. config:option:: $cfg['ShowFieldTypesInDataEditView']
2482 Defines whether or not type fields should be initially displayed in
2483 edit/insert mode. The user can toggle this setting from the interface.
2485 .. config:option:: $cfg['InsertRows']
2490 Defines the default number of rows to be entered from the Insert page.
2491 Users can manually change this from the bottom of that page to add or remove
2494 .. config:option:: $cfg['ForeignKeyMaxLimit']
2499 If there are fewer items than this in the set of foreign keys, then a
2500 drop-down box of foreign keys is presented, in the style described by
2501 the :config:option:`$cfg['ForeignKeyDropdownOrder']` setting.
2503 .. config:option:: $cfg['ForeignKeyDropdownOrder']
2506 :default: array('content-id', 'id-content')
2508 For the foreign key drop-down fields, there are several methods of
2509 display, offering both the key and value data. The contents of the
2510 array should be one or both of the following strings: ``content-id``,
2513 Export and import settings
2514 --------------------------
2516 .. config:option:: $cfg['ZipDump']
2521 .. config:option:: $cfg['GZipDump']
2526 .. config:option:: $cfg['BZipDump']
2531 Defines whether to allow the use of zip/GZip/BZip2 compression when
2532 creating a dump file
2534 .. config:option:: $cfg['CompressOnFly']
2539 Defines whether to allow on the fly compression for GZip/BZip2
2540 compressed exports. This doesn't affect smaller dumps and allows users
2541 to create larger dumps that won't otherwise fit in memory due to php
2542 memory limit. Produced files contain more GZip/BZip2 headers, but all
2543 normal programs handle this correctly.
2545 .. config:option:: $cfg['Export']
2548 :default: array(...)
2550 In this array are defined default parameters for export, names of
2551 items are similar to texts seen on export page, so you can easily
2552 identify what they mean.
2554 .. config:option:: $cfg['Export']['format']
2559 Default export format.
2561 .. config:option:: $cfg['Export']['method']
2564 :default: ``'quick'``
2566 Defines how the export form is displayed when it loads. Valid values
2569 * ``quick`` to display the minimum number of options to configure
2570 * ``custom`` to display every available option to configure
2571 * ``custom-no-form`` same as ``custom`` but does not display the option
2572 of using quick export
2574 .. config:option:: $cfg['Export']['charset']
2579 Defines charset for generated export. By default no charset conversion is
2580 done assuming UTF-8.
2582 .. config:option:: $cfg['Export']['file_template_table']
2585 :default: ``'@TABLE@'``
2587 Default filename template for table exports.
2589 .. seealso:: :ref:`faq6_27`
2591 .. config:option:: $cfg['Export']['file_template_database']
2594 :default: ``'@DATABASE@'``
2596 Default filename template for database exports.
2598 .. seealso:: :ref:`faq6_27`
2600 .. config:option:: $cfg['Export']['file_template_server']
2603 :default: ``'@SERVER@'``
2605 Default filename template for server exports.
2607 .. seealso:: :ref:`faq6_27`
2609 .. config:option:: $cfg['Import']
2612 :default: array(...)
2614 In this array are defined default parameters for import, names of
2615 items are similar to texts seen on import page, so you can easily
2616 identify what they mean.
2618 .. config:option:: $cfg['Import']['charset']
2623 Defines charset for import. By default no charset conversion is done
2626 Tabs display settings
2627 ---------------------
2629 .. config:option:: $cfg['TabsMode']
2632 :default: ``'both'``
2634 Defines whether the menu tabs contain ``'icons'``, ``'text'`` or ``'both'``.
2636 .. config:option:: $cfg['PropertiesNumColumns']
2641 How many columns will be utilized to display the tables on the database
2642 property view? When setting this to a value larger than 1, the type of the
2643 database will be omitted for more display space.
2645 .. config:option:: $cfg['DefaultTabServer']
2648 :default: ``'welcome'``
2650 Defines the tab displayed by default on server view. The possible values
2651 are the localized equivalent of:
2653 * ``welcome`` (recommended for multi-user setups)
2659 .. config:option:: $cfg['DefaultTabDatabase']
2662 :default: ``'structure'``
2664 Defines the tab displayed by default on database view. The possible values
2665 are the localized equivalent of:
2672 .. config:option:: $cfg['DefaultTabTable']
2675 :default: ``'browse'``
2677 Defines the tab displayed by default on table view. The possible values
2678 are the localized equivalent of:
2689 .. config:option:: $cfg['PDFPageSizes']
2692 :default: ``array('A3', 'A4', 'A5', 'letter', 'legal')``
2694 Array of possible paper sizes for creating PDF pages.
2696 You should never need to change this.
2698 .. config:option:: $cfg['PDFDefaultPageSize']
2703 Default page size to use when creating PDF pages. Valid values are any
2704 listed in :config:option:`$cfg['PDFPageSizes']`.
2709 .. config:option:: $cfg['DefaultLang']
2714 Defines the default language to use, if not browser-defined or user-
2715 defined. The corresponding language file needs to be in
2716 locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
2718 .. config:option:: $cfg['DefaultConnectionCollation']
2721 :default: ``'utf8mb4_general_ci'``
2723 Defines the default connection collation to use, if not user-defined.
2724 See the `MySQL documentation for charsets
2725 <https://dev.mysql.com/doc/refman/5.7/en/charset-charsets.html>`_
2726 for list of possible values.
2728 .. config:option:: $cfg['Lang']
2733 Force language to use. The corresponding language file needs to be in
2734 locale/*code*/LC\_MESSAGES/phpmyadmin.mo.
2736 .. config:option:: $cfg['FilterLanguages']
2741 Limit list of available languages to those matching the given regular
2742 expression. For example if you want only Czech and English, you should
2743 set filter to ``'^(cs|en)'``.
2745 .. config:option:: $cfg['RecodingEngine']
2748 :default: ``'auto'``
2750 You can select here which functions will be used for character set
2751 conversion. Possible values are:
2753 * auto - automatically use available one (first is tested iconv, then
2755 * iconv - use iconv or libiconv functions
2756 * recode - use recode\_string function
2757 * mb - use :term:`mbstring` extension
2758 * none - disable encoding conversion
2760 Enabled charset conversion activates a pull-down menu in the Export
2761 and Import pages, to choose the character set when exporting a file.
2762 The default value in this menu comes from
2763 :config:option:`$cfg['Export']['charset']` and :config:option:`$cfg['Import']['charset']`.
2765 .. config:option:: $cfg['IconvExtraParams']
2768 :default: ``'//TRANSLIT'``
2770 Specify some parameters for iconv used in charset conversion. See
2771 `iconv documentation <https://www.gnu.org/savannah-checkouts/gnu/libiconv/documentati
2772 on/libiconv-1.15/iconv_open.3.html>`_ for details. By default
2773 ``//TRANSLIT`` is used, so that invalid characters will be
2776 .. config:option:: $cfg['AvailableCharsets']
2779 :default: array(...)
2781 Available character sets for MySQL conversion. You can add your own
2782 (any of supported by recode/iconv) or remove these which you don't
2783 use. Character sets will be shown in same order as here listed, so if
2784 you frequently use some of these move them to the top.
2789 .. config:option:: $cfg['OBGzip']
2791 :type: string/boolean
2792 :default: ``'auto'``
2794 Defines whether to use GZip output buffering for increased speed in
2795 :term:`HTTP` transfers. Set to
2796 true/false for enabling/disabling. When set to 'auto' (string),
2797 phpMyAdmin tries to enable output buffering and will automatically
2798 disable it if your browser has some problems with buffering. IE6 with
2799 a certain patch is known to cause data corruption when having enabled
2802 .. config:option:: $cfg['TrustedProxies']
2807 Lists proxies and HTTP headers which are trusted for
2808 :config:option:`$cfg['Servers'][$i]['AllowDeny']['order']`. This list is by
2809 default empty, you need to fill in some trusted proxy servers if you
2810 want to use rules for IP addresses behind proxy.
2812 The following example specifies that phpMyAdmin should trust a
2813 HTTP\_X\_FORWARDED\_FOR (``X-Forwarded-For``) header coming from the proxy
2818 $cfg['TrustedProxies'] = array('1.2.3.4' => 'HTTP_X_FORWARDED_FOR');
2820 The :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` directive uses the
2821 client's IP address as usual.
2823 .. config:option:: $cfg['GD2Available']
2826 :default: ``'auto'``
2828 Specifies whether GD >= 2 is available. If yes it can be used for MIME
2829 transformations. Possible values are:
2831 * auto - automatically detect
2832 * yes - GD 2 functions can be used
2833 * no - GD 2 function cannot be used
2835 .. config:option:: $cfg['CheckConfigurationPermissions']
2840 We normally check the permissions on the configuration file to ensure
2841 it's not world writable. However, phpMyAdmin could be installed on a
2842 NTFS filesystem mounted on a non-Windows server, in which case the
2843 permissions seems wrong but in fact cannot be detected. In this case a
2844 sysadmin would set this parameter to ``false``.
2846 .. config:option:: $cfg['LinkLengthLimit']
2851 Limit for length of :term:`URL` in links. When length would be above this
2852 limit, it is replaced by form with button. This is required as some web
2853 servers (:term:`IIS`) have problems with long :term:`URL` .
2855 .. config:option:: $cfg['CSPAllow']
2860 Additional string to include in allowed script and image sources in Content
2861 Security Policy header.
2863 This can be useful when you want to include some external JavaScript files
2864 in :file:`config.footer.inc.php` or :file:`config.header.inc.php`, which
2865 would be normally not allowed by :term:`Content Security Policy`.
2867 To allow some sites, just list them within the string:
2871 $cfg['CSPAllow'] = 'example.com example.net';
2873 .. versionadded:: 4.0.4
2875 .. config:option:: $cfg['DisableMultiTableMaintenance']
2880 In the database Structure page, it's possible to mark some tables then
2881 choose an operation like optimizing for many tables. This can slow
2882 down a server; therefore, setting this to ``true`` prevents this kind
2883 of multiple maintenance operation.
2888 Please directly modify :file:`themes/themename/scss/_variables.scss`, although
2889 your changes will be overwritten with the next update.
2891 Design customization
2892 --------------------
2894 .. config:option:: $cfg['NavigationTreePointerEnable']
2899 When set to true, hovering over an item in the navigation panel causes that item to be marked
2900 (the background is highlighted).
2902 .. config:option:: $cfg['BrowsePointerEnable']
2907 When set to true, hovering over a row in the Browse page causes that row to be marked (the background
2910 .. config:option:: $cfg['BrowseMarkerEnable']
2915 When set to true, a data row is marked (the background is highlighted) when the row is selected
2918 .. config:option:: $cfg['LimitChars']
2923 Maximum number of characters shown in any non-numeric field on browse
2924 view. Can be turned off by a toggle button on the browse page.
2926 .. config:option:: $cfg['RowActionLinks']
2929 :default: ``'left'``
2931 Defines the place where table row links (Edit, Copy, Delete) would be
2932 put when tables contents are displayed (you may have them displayed at
2933 the left side, right side, both sides or nowhere).
2935 .. config:option:: $cfg['RowActionLinksWithoutUnique']
2940 Defines whether to show row links (Edit, Copy, Delete) and checkboxes
2941 for multiple row operations even when the selection does not have a :term:`unique key`.
2942 Using row actions in the absence of a unique key may result in different/more
2943 rows being affected since there is no guaranteed way to select the exact row(s).
2945 .. config:option:: $cfg['RememberSorting']
2950 If enabled, remember the sorting of each table when browsing them.
2952 .. config:option:: $cfg['TablePrimaryKeyOrder']
2955 :default: ``'NONE'``
2957 This defines the default sort order for the tables, having a :term:`primary key`,
2958 when there is no sort order defines externally.
2959 Acceptable values : ['NONE', 'ASC', 'DESC']
2961 .. config:option:: $cfg['ShowBrowseComments']
2966 .. config:option:: $cfg['ShowPropertyComments']
2971 By setting the corresponding variable to ``true`` you can enable the
2972 display of column comments in Browse or Property display. In browse
2973 mode, the comments are shown inside the header. In property mode,
2974 comments are displayed using a CSS-formatted dashed-line below the
2975 name of the column. The comment is shown as a tool-tip for that
2978 .. config:option:: $cfg['FirstDayOfCalendar']
2983 This will define the first day of week in the calendar. The number
2984 can be set from 0 to 6, which represents the seven days of the week,
2985 Sunday to Saturday respectively. This value can also be configured by the user
2986 in server settings -> features -> general -> First Day calendar field.
2991 .. config:option:: $cfg['CharEditing']
2994 :default: ``'input'``
2996 Defines which type of editing controls should be used for CHAR and
2997 VARCHAR columns. Applies to data editing and also to the default values
2998 in structure editing. Possible values are:
3000 * input - this allows to limit size of text to size of columns in MySQL,
3001 but has problems with newlines in columns
3002 * textarea - no problems with newlines in columns, but also no length
3005 .. config:option:: $cfg['MinSizeForInputField']
3010 Defines the minimum size for input fields generated for CHAR and
3013 .. config:option:: $cfg['MaxSizeForInputField']
3018 Defines the maximum size for input fields generated for CHAR and
3021 .. config:option:: $cfg['TextareaCols']
3026 .. config:option:: $cfg['TextareaRows']
3031 .. config:option:: $cfg['CharTextareaCols']
3036 .. config:option:: $cfg['CharTextareaRows']
3041 Number of columns and rows for the textareas. This value will be
3042 emphasized (\*2) for :term:`SQL` query
3043 textareas and (\*1.25) for :term:`SQL`
3044 textareas inside the query window.
3046 The Char\* values are used for CHAR
3047 and VARCHAR editing (if configured via :config:option:`$cfg['CharEditing']`).
3049 .. config:option:: $cfg['LongtextDoubleTextarea']
3054 Defines whether textarea for LONGTEXT columns should have double size.
3056 .. config:option:: $cfg['TextareaAutoSelect']
3061 Defines if the whole textarea of the query box will be selected on
3064 .. config:option:: $cfg['EnableAutocompleteForTablesAndColumns']
3069 Whether to enable autocomplete for table and column names in any
3072 SQL query box settings
3073 ----------------------
3075 .. config:option:: $cfg['SQLQuery']['Edit']
3080 Whether to display an edit link to change a query in any SQL Query
3083 .. config:option:: $cfg['SQLQuery']['Explain']
3088 Whether to display a link to explain a SELECT query in any SQL Query
3091 .. config:option:: $cfg['SQLQuery']['ShowAsPHP']
3096 Whether to display a link to wrap a query in PHP code in any SQL Query
3099 .. config:option:: $cfg['SQLQuery']['Refresh']
3104 Whether to display a link to refresh a query in any SQL Query box.
3108 Web server upload/save/import directories
3109 -----------------------------------------
3111 If PHP is running in safe mode, all directories must be owned by the same user
3112 as the owner of the phpMyAdmin scripts.
3114 If the directory where phpMyAdmin is installed is subject to an
3115 ``open_basedir`` restriction, you need to create a temporary directory in some
3116 directory accessible by the PHP interpreter.
3118 For security reasons, all directories should be outside the tree published by
3119 webserver. If you cannot avoid having this directory published by webserver,
3120 limit access to it either by web server configuration (for example using
3121 .htaccess or web.config files) or place at least an empty :file:`index.html`
3122 file there, so that directory listing is not possible. However as long as the
3123 directory is accessible by web server, an attacker can guess filenames to download
3126 .. config:option:: $cfg['UploadDir']
3131 The name of the directory where :term:`SQL` files have been uploaded by
3132 other means than phpMyAdmin (for example, FTP). Those files are available
3133 under a drop-down box when you click the database or table name, then the
3137 you want different directory for each user, %u will be replaced with
3140 Please note that the file names must have the suffix ".sql"
3141 (or ".sql.bz2" or ".sql.gz" if support for compressed formats is
3144 This feature is useful when your file is too big to be
3145 uploaded via :term:`HTTP`, or when file
3146 uploads are disabled in PHP.
3150 Please see top of this chapter (:ref:`web-dirs`) for instructions how
3151 to setup this directory and how to make its usage secure.
3155 See :ref:`faq1_16` for alternatives.
3157 .. config:option:: $cfg['SaveDir']
3162 The name of the webserver directory where exported files can be saved.
3164 If you want a different directory for each user, %u will be replaced with the
3167 Please note that the directory must exist and has to be writable for
3168 the user running webserver.
3172 Please see top of this chapter (:ref:`web-dirs`) for instructions how
3173 to setup this directory and how to make its usage secure.
3175 .. config:option:: $cfg['TempDir']
3178 :default: ``'./tmp/'``
3180 The name of the directory where temporary files can be stored. It is used
3181 for several purposes, currently:
3183 * The templates cache which speeds up page loading.
3184 * ESRI Shapefiles import, see :ref:`faq6_30`.
3185 * To work around limitations of ``open_basedir`` for uploaded files, see
3188 This directory should have as strict permissions as possible as the only
3189 user required to access this directory is the one who runs the webserver.
3190 If you have root privileges, simply make this user owner of this directory
3191 and make it accessible only by it:
3195 chown www-data:www-data tmp
3198 If you cannot change owner of the directory, you can achieve a similar
3199 setup using :term:`ACL`:
3204 setfacl -m "g:www-data:rwx" tmp
3205 setfacl -d -m "g:www-data:rwx" tmp
3207 If neither of above works for you, you can still make the directory
3208 :command:`chmod 777`, but it might impose risk of other users on system
3209 reading and writing data in this directory.
3213 Please see top of this chapter (:ref:`web-dirs`) for instructions how
3214 to setup this directory and how to make its usage secure.
3216 Various display setting
3217 -----------------------
3219 .. config:option:: $cfg['RepeatCells']
3224 Repeat the headers every X cells, or 0 to deactivate.
3226 .. config:option:: $cfg['QueryHistoryDB']
3231 .. config:option:: $cfg['QueryHistoryMax']
3236 If :config:option:`$cfg['QueryHistoryDB']` is set to ``true``, all your
3237 Queries are logged to a table, which has to be created by you (see
3238 :config:option:`$cfg['Servers'][$i]['history']`). If set to false, all your
3239 queries will be appended to the form, but only as long as your window is
3240 opened they remain saved.
3242 When using the JavaScript based query window, it will always get updated
3243 when you click on a new table/db to browse and will focus if you click on
3244 :guilabel:`Edit SQL` after using a query. You can suppress updating the
3245 query window by checking the box :guilabel:`Do not overwrite this query
3246 from outside the window` below the query textarea. Then you can browse
3247 tables/databases in the background without losing the contents of the
3248 textarea, so this is especially useful when composing a query with tables
3249 you first have to look in. The checkbox will get automatically checked
3250 whenever you change the contents of the textarea. Please uncheck the button
3251 whenever you definitely want the query window to get updated even though
3252 you have made alterations.
3254 If :config:option:`$cfg['QueryHistoryDB']` is set to ``true`` you can
3255 specify the amount of saved history items using
3256 :config:option:`$cfg['QueryHistoryMax']`.
3258 .. config:option:: $cfg['BrowseMIME']
3263 Enable :ref:`transformations`.
3265 .. config:option:: $cfg['MaxExactCount']
3270 For InnoDB tables, determines for how large tables phpMyAdmin should
3271 get the exact row count using ``SELECT COUNT``. If the approximate row
3272 count as returned by ``SHOW TABLE STATUS`` is smaller than this value,
3273 ``SELECT COUNT`` will be used, otherwise the approximate count will be
3276 .. versionchanged:: 4.8.0
3278 The default value was lowered to 50000 for performance reasons.
3280 .. versionchanged:: 4.2.6
3282 The default value was changed to 500000.
3284 .. seealso:: :ref:`faq3_11`
3286 .. config:option:: $cfg['MaxExactCountViews']
3291 For VIEWs, since obtaining the exact count could have an impact on
3292 performance, this value is the maximum to be displayed, using a
3293 ``SELECT COUNT ... LIMIT``. Setting this to 0 bypasses any row
3296 .. config:option:: $cfg['NaturalOrder']
3301 Sorts database and table names according to natural order (for
3302 example, t1, t2, t10). Currently implemented in the navigation panel
3303 and in Database view, for the table list.
3305 .. config:option:: $cfg['InitialSlidersState']
3308 :default: ``'closed'``
3310 If set to ``'closed'``, the visual sliders are initially in a closed
3311 state. A value of ``'open'`` does the reverse. To completely disable
3312 all visual sliders, use ``'disabled'``.
3314 .. config:option:: $cfg['UserprefsDisallow']
3319 Contains names of configuration options (keys in ``$cfg`` array) that
3320 users can't set through user preferences. For possible values, refer
3321 to classes under :file:`libraries/classes/Config/Forms/User/`.
3323 .. config:option:: $cfg['UserprefsDeveloperTab']
3328 Activates in the user preferences a tab containing options for
3329 developers of phpMyAdmin.
3334 .. config:option:: $cfg['TitleTable']
3337 :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ / @TABLE@ | @PHPMYADMIN@'``
3339 .. config:option:: $cfg['TitleDatabase']
3342 :default: ``'@HTTP_HOST@ / @VSERVER@ / @DATABASE@ | @PHPMYADMIN@'``
3344 .. config:option:: $cfg['TitleServer']
3347 :default: ``'@HTTP_HOST@ / @VSERVER@ | @PHPMYADMIN@'``
3349 .. config:option:: $cfg['TitleDefault']
3352 :default: ``'@HTTP_HOST@ | @PHPMYADMIN@'``
3354 Allows you to specify window's title bar. You can use :ref:`faq6_27`.
3356 Theme manager settings
3357 ----------------------
3359 .. config:option:: $cfg['ThemeManager']
3364 Enables user-selectable themes. See :ref:`faqthemes`.
3366 .. config:option:: $cfg['ThemeDefault']
3369 :default: ``'pmahomme'``
3371 The default theme (a subdirectory under :file:`./themes/`).
3373 .. config:option:: $cfg['ThemePerServer']
3378 Whether to allow different theme for each server.
3380 .. config:option:: $cfg['FontSize']
3385 .. deprecated:: 5.0.0
3387 This setting was removed as the browser is more efficient,
3388 thus no need of this option.
3390 Font size to use, is applied in CSS.
3395 .. config:option:: $cfg['DefaultQueryTable']
3398 :default: ``'SELECT * FROM @TABLE@ WHERE 1'``
3400 .. config:option:: $cfg['DefaultQueryDatabase']
3405 Default queries that will be displayed in query boxes when user didn't
3406 specify any. You can use standard :ref:`faq6_27`.
3411 .. config:option:: $cfg['DefaultFunctions']
3414 :default: array(...)
3416 Functions selected by default when inserting/changing row, Functions
3417 are defined for meta types as (FUNC\_NUMBER, FUNC\_DATE, FUNC\_CHAR,
3418 FUNC\_SPATIAL, FUNC\_UUID) and for ``first_timestamp``, which is used
3419 for first timestamp column in table.
3421 Default options for Transformations
3422 -----------------------------------
3424 .. config:option:: $cfg['DefaultTransformations']
3427 :default: An array with below listed key-values
3429 .. config:option:: $cfg['DefaultTransformations']['Substring']
3432 :default: array(0, 'all', '…')
3434 .. config:option:: $cfg['DefaultTransformations']['Bool2Text']
3437 :default: array('T', 'F')
3439 .. config:option:: $cfg['DefaultTransformations']['External']
3442 :default: array(0, '-f /dev/null -i -wrap -q', 1, 1)
3444 .. config:option:: $cfg['DefaultTransformations']['PreApPend']
3447 :default: array('', '')
3449 .. config:option:: $cfg['DefaultTransformations']['Hex']
3452 :default: array('2')
3454 .. config:option:: $cfg['DefaultTransformations']['DateFormat']
3457 :default: array(0, '', 'local')
3459 .. config:option:: $cfg['DefaultTransformations']['Inline']
3462 :default: array('100', 100)
3464 .. config:option:: $cfg['DefaultTransformations']['TextImageLink']
3467 :default: array('', 100, 50)
3469 .. config:option:: $cfg['DefaultTransformations']['TextLink']
3472 :default: array('', '', '')
3479 These settings are mostly meant to be changed by user.
3481 .. config:option:: $cfg['Console']['StartHistory']
3486 Show query history at start
3488 .. config:option:: $cfg['Console']['AlwaysExpand']
3493 Always expand query messages
3495 .. config:option:: $cfg['Console']['CurrentQuery']
3500 Show current browsing query
3502 .. config:option:: $cfg['Console']['EnterExecutes']
3507 Execute queries on Enter and insert new line with Shift + Enter
3509 .. config:option:: $cfg['Console']['DarkTheme']
3514 Switch to dark theme
3516 .. config:option:: $cfg['Console']['Mode']
3523 .. config:option:: $cfg['Console']['Height']
3535 These settings might have huge effect on performance or security.
3537 .. config:option:: $cfg['environment']
3540 :default: ``'production'``
3542 Sets the working environment.
3544 This only needs to be changed when you are developing phpMyAdmin itself.
3545 The ``development`` mode may display debug information in some places.
3547 Possible values are ``'production'`` or ``'development'``.
3549 .. config:option:: $cfg['DBG']
3552 :default: array(...)
3554 .. config:option:: $cfg['DBG']['sql']
3559 Enable logging queries and execution times to be
3560 displayed in the console's Debug SQL tab.
3562 .. config:option:: $cfg['DBG']['sqllog']
3567 Enable logging of queries and execution times to the syslog.
3568 Requires :config:option:`$cfg['DBG']['sql']` to be enabled.
3570 .. config:option:: $cfg['DBG']['demo']
3575 Enable to let server present itself as demo server.
3576 This is used for `phpMyAdmin demo server <https://www.phpmyadmin.net/try/>`_.
3578 It currently changes following behavior:
3580 * There is welcome message on the main page.
3581 * There is footer information about demo server and used git revision.
3582 * The setup script is enabled even with existing configuration.
3583 * The setup does not try to connect to the MySQL server.
3585 .. config:option:: $cfg['DBG']['simple2fa']
3590 Can be used for testing two-factor authentication using :ref:`simple2fa`.
3592 .. _config-examples:
3597 See following configuration snippets for typical setups of phpMyAdmin.
3602 Example configuration file, which can be copied to :file:`config.inc.php` to
3603 get some core configuration layout; it is distributed with phpMyAdmin as
3604 :file:`config.sample.inc.php`. Please note that it does not contain all
3605 configuration options, only the most frequently used ones.
3607 .. literalinclude:: ../config.sample.inc.php
3612 Don't use the controluser 'pma' if it does not yet exist and don't use 'pmapass'
3617 Example for signon authentication
3618 +++++++++++++++++++++++++++++++++
3620 This example uses :file:`examples/signon.php` to demonstrate usage of :ref:`auth_signon`:
3627 $cfg['Servers'][$i]['auth_type'] = 'signon';
3628 $cfg['Servers'][$i]['SignonSession'] = 'SignonSession';
3629 $cfg['Servers'][$i]['SignonURL'] = 'examples/signon.php';
3631 Example for IP address limited autologin
3632 ++++++++++++++++++++++++++++++++++++++++
3634 If you want to automatically login when accessing phpMyAdmin locally while asking
3635 for a password when accessing remotely, you can achieve it using following snippet:
3639 if ($_SERVER["REMOTE_ADDR"] == "127.0.0.1") {
3640 $cfg['Servers'][$i]['auth_type'] = 'config';
3641 $cfg['Servers'][$i]['user'] = 'root';
3642 $cfg['Servers'][$i]['password'] = 'yourpassword';
3644 $cfg['Servers'][$i]['auth_type'] = 'cookie';
3649 Filtering based on IP addresses isn't reliable over the internet, use it
3650 only for local address.
3652 Example for using multiple MySQL servers
3653 ++++++++++++++++++++++++++++++++++++++++
3655 You can configure any number of servers using :config:option:`$cfg['Servers']`,
3656 following example shows two of them:
3661 $cfg['blowfish_secret']='multiServerExample70518';
3662 //any string of your choice
3666 $cfg['Servers'][$i]['auth_type'] = 'cookie';
3667 $cfg['Servers'][$i]['verbose'] = 'no1';
3668 $cfg['Servers'][$i]['host'] = 'localhost';
3669 // more options for #1 ...
3672 $cfg['Servers'][$i]['auth_type'] = 'cookie';
3673 $cfg['Servers'][$i]['verbose'] = 'no2';
3674 $cfg['Servers'][$i]['host'] = 'remote.host.addr';//or ip:'10.9.8.1'
3675 // this server must allow remote clients, e.g., host 10.9.8.%
3676 // not only in mysql.host but also in the startup configuration
3677 // more options for #2 ...
3679 // end of server sections
3680 $cfg['ServerDefault'] = 0; // to choose the server on startup
3682 // further general options ...
3684 .. _example-google-ssl:
3686 Google Cloud SQL with SSL
3687 +++++++++++++++++++++++++
3689 To connect to Google Could SQL, you currently need to disable certificate
3690 verification. This is caused by the certificate being issued for CN matching
3691 your instance name, but you connect to an IP address and PHP tries to match
3692 these two. With verification you end up with error message like:
3694 .. code-block:: text
3696 Peer certificate CN=`api-project-851612429544:pmatest' did not match expected CN=`8.8.8.8'
3700 With disabled verification your traffic is encrypted, but you're open to
3701 man in the middle attacks.
3703 To connect phpMyAdmin to Google Cloud SQL using SSL download the client and
3704 server certificates and tell phpMyAdmin to use them:
3708 // IP address of your instance
3709 $cfg['Servers'][$i]['host'] = '8.8.8.8';
3710 // Use SSL for connection
3711 $cfg['Servers'][$i]['ssl'] = true;
3712 // Client secret key
3713 $cfg['Servers'][$i]['ssl_key'] = '../client-key.pem';
3714 // Client certificate
3715 $cfg['Servers'][$i]['ssl_cert'] = '../client-cert.pem';
3716 // Server certification authority
3717 $cfg['Servers'][$i]['ssl_ca'] = '../server-ca.pem';
3718 // Disable SSL verification (see above note)
3719 $cfg['Servers'][$i]['ssl_verify'] = false;
3724 :config:option:`$cfg['Servers'][$i]['ssl']`,
3725 :config:option:`$cfg['Servers'][$i]['ssl_key']`,
3726 :config:option:`$cfg['Servers'][$i]['ssl_cert']`,
3727 :config:option:`$cfg['Servers'][$i]['ssl_ca']`,
3728 :config:option:`$cfg['Servers'][$i]['ssl_verify']`,
3729 <https://bugs.php.net/bug.php?id=72048>
3731 reCaptcha using hCaptcha
3732 ++++++++++++++++++++++++
3736 $cfg['CaptchaApi'] = 'https://www.hcaptcha.com/1/api.js';
3737 $cfg['CaptchaCsp'] = 'https://hcaptcha.com https://*.hcaptcha.com';
3738 $cfg['CaptchaRequestParam'] = 'h-captcha';
3739 $cfg['CaptchaResponseParam'] = 'h-captcha-response';
3740 $cfg['CaptchaSiteVerifyURL'] = 'https://hcaptcha.com/siteverify';
3741 // This is the secret key from hCaptcha dashboard
3742 $cfg['CaptchaLoginPrivateKey'] = '0xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
3743 // This is the site key from hCaptcha dashboard
3744 $cfg['CaptchaLoginPublicKey'] = 'xxx-xxx-xxx-xxx-xxxx';
3746 .. seealso:: `hCaptcha website <https://www.hcaptcha.com/>`_
3747 .. seealso:: `hCaptcha Developer Guide <https://docs.hcaptcha.com/>`_