NG4R3P
Linux kimuko-static 5.10.0-19-cloud-amd64 #1 SMP Debian 5.10.149-2 (2022-10-21) x86_64
  SOFT : Apache/2.4.66 (Debian) PHP : 7.4.33
/mnt/disks/kimuko-static/html/phpmyadmin/doc/
10.174.0.2

 
[ NAME ] [ SIZE ] [ PERM ] [ DATE ] [ ACT ]
+FILE +DIR
_ext dir drwxrwxr-x 2022-11-15 16:41 R D
doctrees dir drwxrwxr-x 2022-11-15 16:41 R D
html dir drwxrwxr-x 2022-11-15 16:41 R D
  Makefile 5.444 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  conf.py 8.975 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  config.rst 85.518 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  copyright.rst 1.145 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  credits.rst 12.865 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  developers.rst 0.372 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  faq.rst 79.713 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  glossary.rst 11.9 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  index.rst 0.548 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  intro.rst 2.682 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  make.bat 4.984 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  other.rst 0.528 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  privileges.rst 2.269 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  require.rst 1.396 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  setup.rst 16.616 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  transformations.rst 6.295 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  user.rst 0.097 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
  vendors.rst 1.132 KB -rwxrwxr-x 2022-11-15 16:41 R E G D
REQUEST EXIT
.. index:: config.inc.php .. _config: Configuration ============= Almost all configurable data is placed in :file:`config.inc.php`. If this file does not exist, please refer to the :ref:`setup` section to create one. This file only needs to contain the parameters you want to change from their corresponding default value in :file:`libraries/config.default.php`. The parameters which relate to design (like colors) are placed in :file:`themes/themename/layout.inc.php`. You might also want to create :file:`config.footer.inc.php` and :file:`config.header.inc.php` files to add your site specific code to be included on start and end of each page. .. note:: Some distributions (eg. Debian or Ubuntu) store :file:`config.inc.php` in ``/etc/phpmyadmin`` instead of within phpMyAdmin sources. .. warning:: :term:`Mac` users should note that if you are on a version before :term:`Mac OS X`, PHP does not seem to like :term:`Mac` end of lines character (``\r``). So ensure you choose the option that allows to use the \*nix end of line character (``\n``) in your text editor before saving a script you have modified. Basic settings -------------- .. config:option:: $cfg['PmaAbsoluteUri'] :type: string :default: ``''`` Sets here the complete :term:`URL` (with full path) to your phpMyAdmin installation's directory. E.g. ``http://www.example.net/path_to_your_phpMyAdmin_directory/``. Note also that the :term:`URL` on some web servers are case��sensitive. Don��t forget the trailing slash at the end. Starting with version 2.3.0, it is advisable to try leaving this blank. In most cases phpMyAdmin automatically detects the proper setting. Users of port forwarding will need to set :config:option:`$cfg['PmaAbsoluteUri']` (`more info `_). A good test is to browse a table, edit a row and save it. There should be an error message if phpMyAdmin is having trouble auto��detecting the correct value. If you get an error that this must be set or if the autodetect code fails to detect your path, please post a bug report on our bug tracker so we can improve the code. .. seealso:: :ref:`faq1_40` .. config:option:: $cfg['PmaNoRelation_DisableWarning'] :type: boolean :default: false Starting with version 2.3.0 phpMyAdmin offers a lot of features to work with master / foreign �� tables (see :config:option:`$cfg['Servers'][$i]['pmadb']`). If you tried to set this up and it does not work for you, have a look on the :guilabel:`Structure` page of one database where you would like to use it. You will find a link that will analyze why those features have been disabled. If you do not want to use those features set this variable to ``true`` to stop this message from appearing. .. config:option:: $cfg['SuhosinDisableWarning'] :type: boolean :default: false A warning is displayed on the main page if Suhosin is detected. You can set this parameter to ``true`` to stop this message from appearing. .. config:option:: $cfg['McryptDisableWarning'] :type: boolean :default: false Disable the default warning that is displayed if mcrypt is missing for cookie authentication. You can set this parameter to ``true`` to stop this message from appearing. .. config:option:: $cfg['ServerLibraryDifference_DisableWarning'] :type: boolean :default: false A warning is displayed on the main page if there is a difference between the MySQL library and server version. You can set this parameter to ``true`` to stop this message from appearing. .. config:option:: $cfg['ReservedWordDisableWarning'] :type: boolean :default: false This warning is displayed on the Structure page of a table if one or more column names match with words which are MySQL reserved. If you want to turn off this warning, you can set it to ``true`` and warning will not longer be displayed .. config:option:: $cfg['TranslationWarningThreshold'] :type: integer :default: 80 Show warning about incomplete translations on certain threshold. .. config:option:: $cfg['AllowThirdPartyFraming'] :type: boolean :default: false Setting this to ``true`` allows phpMyAdmin to be included inside a frame, and is a potential security hole allowing cross-frame scripting attacks or clickjacking. Server connection settings -------------------------- .. config:option:: $cfg['Servers'] :type: array :default: one server array with settings listed bellow Since version 1.4.2, phpMyAdmin supports the administration of multiple MySQL servers. Therefore, a :config:option:`$cfg['Servers']`-array has been added which contains the login information for the different servers. The first :config:option:`$cfg['Servers'][$i]['host']` contains the hostname of the first server, the second :config:option:`$cfg['Servers'][$i]['host']` the hostname of the second server, etc. In :file:`libraries/config.default.php`, there is only one section for server definition, however you can put as many as you need in :file:`config.inc.php`, copy that block or needed parts (you don't have to define all settings, just those you need to change). .. note:: The :config:option:`$cfg['Servers']` array starts with $cfg['Servers'][1]. Do not use $cfg['Servers'][0]. If you want more than one server, just copy following section (including $i incrementation) serveral times. There is no need to define full server array, just define values you need to change. .. config:option:: $cfg['Servers'][$i]['host'] :type: string :default: ``'localhost'`` The hostname or :term:`IP` address of your $i-th MySQL-server. E.g. ``localhost``. Possible values are: * hostname, e.g., ``'localhost'`` or ``'mydb.example.org'`` * IP address, e.g., ``'127.0.0.1'`` or ``'192.168.10.1'`` * dot - ``'.'``, i.e., use named pipes on windows systems * empty - ``''``, disables this server .. config:option:: $cfg['Servers'][$i]['port'] :type: string :default: ``''`` The port-number of your $i-th MySQL-server. Default is 3306 (leave blank). .. note:: If you use ``localhost`` as the hostname, MySQL ignores this port number and connects with the socket, so if you want to connect to a port different from the default port, use ``127.0.0.1`` or the real hostname in :config:option:`$cfg['Servers'][$i]['host']`. .. config:option:: $cfg['Servers'][$i]['socket'] :type: string :default: ``''`` The path to the socket to use. Leave blank for default. To determine the correct socket, check your MySQL configuration or, using the :command:`mysql` command��line client, issue the ``status`` command. Among the resulting information displayed will be the socket used. .. config:option:: $cfg['Servers'][$i]['ssl'] :type: boolean :default: false Whether to enable SSL for connection to MySQL server. .. config:option:: $cfg['Servers'][$i]['connect_type'] :type: string :default: ``'tcp'`` What type connection to use with the MySQL server. Your options are ``'socket'`` and ``'tcp'``. It defaults to tcp as that is nearly guaranteed to be available on all MySQL servers, while sockets are not supported on some platforms. To use the socket mode, your MySQL server must be on the same machine as the Web server. .. config:option:: $cfg['Servers'][$i]['extension'] :type: string :default: ``'mysqli'`` What php MySQL extension to use for the connection. Valid options are: ``mysql`` The classic MySQL extension. ``mysqli`` The improved MySQL extension. This extension became available with PHP 5.0.0 and is the recommended way to connect to a server running MySQL 4.1.x or newer. .. config:option:: $cfg['Servers'][$i]['compress'] :type: boolean :default: false Whether to use a compressed protocol for the MySQL server connection or not (experimental). .. _controlhost: .. config:option:: $cfg['Servers'][$i]['controlhost'] :type: string :default: ``''`` Permits to use an alternate host to hold the configuration storage data. .. _controluser: .. config:option:: $cfg['Servers'][$i]['controluser'] :type: string :default: ``''`` .. config:option:: $cfg['Servers'][$i]['controlpass'] :type: string :default: ``''`` This special account is used for 2 distinct purposes: to make possible all relational features (see :config:option:`$cfg['Servers'][$i]['pmadb']`) and, for a MySQL server running with ``--skip-show-database``, to enable a multi-user installation (:term:`HTTP` or cookie authentication mode). When using :term:`HTTP` or cookie authentication modes (or 'config' authentication mode since phpMyAdmin 2.2.1), you need to supply the details of a MySQL account that has ``SELECT`` privilege on the *mysql.user (all columns except "Password")*, *mysql.db (all columns)* and *mysql.tables\_priv (all columns except "Grantor" and "Timestamp")* tables. This account is used to check what databases the user will see at login. .. versionchanged:: 2.2.5 those were called ``stduser`` and ``stdpass`` .. seealso:: :ref:`setup`, :ref:`authentication_modes` .. config:option:: $cfg['Servers'][$i]['auth_type'] :type: string :default: ``'cookie'`` Whether config or cookie or :term:`HTTP` or signon authentication should be used for this server. * 'config' authentication (``$auth_type�=�'config'``) is the plain old way: username and password are stored in :file:`config.inc.php`. * 'cookie' authentication mode (``$auth_type�=�'cookie'``) as introduced in 2.2.3 allows you to log in as any valid MySQL user with the help of cookies. Username and password are stored in cookies during the session and password is deleted when it ends. This can also allow you to log in in arbitrary server if :config:option:`$cfg['AllowArbitraryServer']` enabled. * 'http' authentication (was called 'advanced' in previous versions and can be written also as 'http') (``$auth_type�=�'http';'``) as introduced in 1.3.0 allows you to log in as any valid MySQL user via HTTP-Auth. * 'signon' authentication mode (``$auth_type�=�'signon'``) as introduced in 2.10.0 allows you to log in from prepared PHP session data or using supplied PHP script. This is useful for implementing single signon from another application. Sample way how to seed session is in signon example: :file:`examples/signon.php`. There is also alternative example using OpenID - :file:`examples/openid.php` and example for scripts based solution - :file:`examples/signon-script.php`. You need to configure :config:option:`$cfg['Servers'][$i]['SignonSession']` or :config:option:`$cfg['Servers'][$i]['SignonScript']` and :config:option:`$cfg['Servers'][$i]['SignonURL']` to use this authentication method. .. seealso:: :ref:`authentication_modes` .. _servers_auth_http_realm: .. config:option:: $cfg['Servers'][$i]['auth_http_realm'] :type: string :default: ``''`` When using auth\_type = ``http``, this field allows to define a custom :term:`HTTP` Basic Auth Realm which will be displayed to the user. If not explicitly specified in your configuration, a string combined of "phpMyAdmin " and either :config:option:`$cfg['Servers'][$i]['verbose']` or :config:option:`$cfg['Servers'][$i]['host']` will be used. .. _servers_user: .. config:option:: $cfg['Servers'][$i]['user'] :type: string :default: ``'root'`` .. config:option:: $cfg['Servers'][$i]['password'] :type: string :default: ``''`` When using :config:option:`$cfg['Servers'][$i]['auth_type']` set to 'config', this is the user/password-pair which phpMyAdmin will use to connect to the MySQL server. This user/password pair is not needed when :term:`HTTP` or cookie authentication is used and should be empty. .. _servers_nopassword: .. config:option:: $cfg['Servers'][$i]['nopassword'] :type: boolean :default: false Allow attempt to log in without password when a login with password fails. This can be used together with http authentication, when authentication is done some other way and phpMyAdmin gets user name from auth and uses empty password for connecting to MySQL. Password login is still tried first, but as fallback, no password method is tried. .. _servers_only_db: .. config:option:: $cfg['Servers'][$i]['only_db'] :type: string or array :default: ``''`` If set to a (an array of) database name(s), only this (these) database(s) will be shown to the user. Since phpMyAdmin 2.2.1, this/these database(s) name(s) may contain MySQL wildcards characters ("\_" and "%"): if you want to use literal instances of these characters, escape them (I.E. use ``'my\_db'`` and not ``'my_db'``). This setting is an efficient way to lower the server load since the latter does not need to send MySQL requests to build the available database list. But **it does not replace the privileges rules of the MySQL database server**. If set, it just means only these databases will be displayed but **not that all other databases can't be used.** An example of using more that one database: .. code-block:: php $cfg['Servers'][$i]['only_db'] = array('db1', 'db2'); .. versionchanged:: 4.0.0 Previous versions permitted to specify the display order of the database names via this directive. .. config:option:: $cfg['Servers'][$i]['hide_db'] :type: string :default: ``''`` Regular expression for hiding some databases from unprivileged users. This only hides them from listing, but a user is still able to access them (using, for example, the SQL query area). To limit access, use the MySQL privilege system. For example, to hide all databases starting with the letter "a", use .. code-block:: php $cfg['Servers'][$i]['hide_db'] = '^a'; and to hide both "db1" and "db2" use .. code-block:: php $cfg['Servers'][$i]['hide_db'] = '^(db1|db2)$'; More information on regular expressions can be found in the `PCRE pattern syntax `_ portion of the PHP reference manual. .. config:option:: $cfg['Servers'][$i]['verbose'] :type: string :default: ``''`` Only useful when using phpMyAdmin with multiple server entries. If set, this string will be displayed instead of the hostname in the pull-down menu on the main page. This can be useful if you want to show only certain databases on your system, for example. For HTTP auth, all non-US-ASCII characters will be stripped. .. config:option:: $cfg['Servers'][$i]['pmadb'] :type: string :default: ``''`` The name of the database containing the phpMyAdmin configuration storage. See the :ref:`linked-tables` section in this document to see the benefits of this feature, and for a quick way of creating this database and the needed tables. If you are the only user of this phpMyAdmin installation, you can use your current database to store those special tables; in this case, just put your current database name in :config:option:`$cfg['Servers'][$i]['pmadb']`. For a multi-user installation, set this parameter to the name of your central database containing the phpMyAdmin configuration storage. .. _bookmark: .. config:option:: $cfg['Servers'][$i]['bookmarktable'] :type: string :default: ``''`` Since release 2.2.0 phpMyAdmin allows users to bookmark queries. This can be useful for queries you often run. To allow the usage of this functionality: * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage * enter the table name in :config:option:`$cfg['Servers'][$i]['bookmarktable']` .. _relation: .. config:option:: $cfg['Servers'][$i]['relation'] :type: string :default: ``''`` Since release 2.2.4 you can describe, in a special 'relation' table, which column is a key in another table (a foreign key). phpMyAdmin currently uses this to * make clickable, when you browse the master table, the data values that point to the foreign table; * display in an optional tool-tip the "display column" when browsing the master table, if you move the mouse to a column containing a foreign key (use also the 'table\_info' table); (see :ref:`faqdisplay`) * in edit/insert mode, display a drop-down list of possible foreign keys (key value and "display column" are shown) (see :ref:`faq6_21`) * display links on the table properties page, to check referential integrity (display missing foreign keys) for each described key; * in query-by-example, create automatic joins (see :ref:`faq6_6`) * enable you to get a :term:`PDF` schema of your database (also uses the table\_coords table). The keys can be numeric or character. To allow the usage of this functionality: * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage * put the relation table name in :config:option:`$cfg['Servers'][$i]['relation']` * now as normal user open phpMyAdmin and for each one of your tables where you want to use this feature, click :guilabel:`Structure/Relation view/` and choose foreign columns. .. note:: In the current version, ``master_db`` must be the same as ``foreign_db``. Those columns have been put in future development of the cross-db relations. .. _table_info: .. config:option:: $cfg['Servers'][$i]['table_info'] :type: string :default: ``''`` Since release 2.3.0 you can describe, in a special 'table\_info' table, which column is to be displayed as a tool-tip when moving the cursor over the corresponding key. This configuration variable will hold the name of this special table. To allow the usage of this functionality: * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage * put the table name in :config:option:`$cfg['Servers'][$i]['table\_info']` (e.g. ``pma__table_info``) * then for each table where you want to use this feature, click "Structure/Relation view/Choose column to display" to choose the column. .. seealso:: :ref:`faqdisplay` .. _table_coords: .. config:option:: $cfg['Servers'][$i]['table_coords'] :type: string :default: ``''`` .. config:option:: $cfg['Servers'][$i]['pdf_pages'] :type: string :default: ``''`` Since release 2.3.0 you can have phpMyAdmin create :term:`PDF` pages showing the relations between your tables. To do this it needs two tables "pdf\_pages" (storing information about the available :term:`PDF` pages) and "table\_coords" (storing coordinates where each table will be placed on a :term:`PDF` schema output). You must be using the "relation" feature. To allow the usage of this functionality: * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage * put the correct table names in :config:option:`$cfg['Servers'][$i]['table\_coords']` and :config:option:`$cfg['Servers'][$i]['pdf\_pages']` .. seealso:: :ref:`faqpdf`. .. _col_com: .. config:option:: $cfg['Servers'][$i]['column_info'] :type: string :default: ``''`` This part requires a content update! Since release 2.3.0 you can store comments to describe each column for each table. These will then be shown on the "printview". Starting with release 2.5.0, comments are consequently used on the table property pages and table browse view, showing up as tool-tips above the column name (properties page) or embedded within the header of table in browse view. They can also be shown in a table dump. Please see the relevant configuration directives later on. Also new in release 2.5.0 is a MIME- transformation system which is also based on the following table structure. See :ref:`transformations` for further information. To use the MIME- transformation system, your column\_info table has to have the three new columns 'mimetype', 'transformation', 'transformation\_options'. To allow the usage of this functionality: * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage * put the table name in :config:option:`$cfg['Servers'][$i]['column\_info']` (e.g. ``pma__column_info``) * to update your PRE-2.5.0 Column\_comments Table use this: and remember that the Variable in :file:`config.inc.php` has been renamed from :config:option:`$cfg['Servers'][$i]['column\_comments']` to :config:option:`$cfg['Servers'][$i]['column\_info']` .. code-block:: mysql ALTER TABLE `pma__column_comments` ADD `mimetype` VARCHAR( 255 ) NOT NULL, ADD `transformation` VARCHAR( 255 ) NOT NULL, ADD `transformation_options` VARCHAR( 255 ) NOT NULL; .. _history: .. config:option:: $cfg['Servers'][$i]['history'] :type: string :default: ``''`` Since release 2.5.0 you can store your :term:`SQL` history, which means all queries you entered manually into the phpMyAdmin interface. If you don't want to use a table-based history, you can use the JavaScript-based history. Using that, all your history items are deleted when closing the window. Using :config:option:`$cfg['QueryHistoryMax']` you can specify an amount of history items you want to have on hold. On every login, this list gets cut to the maximum amount. The query history is only available if JavaScript is enabled in your browser. To allow the usage of this functionality: * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage * put the table name in :config:option:`$cfg['Servers'][$i]['history']` (e.g. ``pma__history``) .. _recent: .. config:option:: $cfg['Servers'][$i]['recent'] :type: string :default: ``''`` Since release 3.5.0 you can show recently used tables in the navigation panel. It helps you to jump across table directly, without the need to select the database, and then select the table. Using :config:option:`$cfg['NumRecentTables']` you can configure the maximum number of recent tables shown. When you select a table from the list, it will jump to the page specified in :config:option:`$cfg['NavigationTreeDefaultTabTable']`. Without configuring the storage, you can still access the recently used tables, but it will disappear after you logout. To allow the usage of this functionality persistently: * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage * put the table name in :config:option:`$cfg['Servers'][$i]['recent']` (e.g. ``pma__recent``) .. _table_uiprefs: .. config:option:: $cfg['Servers'][$i]['table_uiprefs'] :type: string :default: ``''`` Since release 3.5.0 phpMyAdmin can be configured to remember several things (sorted column :config:option:`$cfg['RememberSorting']`, column order, and column visibility from a database table) for browsing tables. Without configuring the storage, these features still can be used, but the values will disappear after you logout. To allow the usage of these functionality persistently: * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage * put the table name in :config:option:`$cfg['Servers'][$i]['table\_uiprefs']` (e.g. ``pma__table_uiprefs``) .. _tracking: .. config:option:: $cfg['Servers'][$i]['tracking'] :type: string :default: ``''`` Since release 3.3.x a tracking mechanism is available. It helps you to track every :term:`SQL` command which is executed by phpMyAdmin. The mechanism supports logging of data manipulation and data definition statements. After enabling it you can create versions of tables. The creation of a version has two effects: * phpMyAdmin saves a snapshot of the table, including structure and indexes. * phpMyAdmin logs all commands which change the structure and/or data of the table and links these commands with the version number. Of course you can view the tracked changes. On the :guilabel:`Tracking` page a complete report is available for every version. For the report you can use filters, for example you can get a list of statements within a date range. When you want to filter usernames you can enter \* for all names or you enter a list of names separated by ','. In addition you can export the (filtered) report to a file or to a temporary database. To allow the usage of this functionality: * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage * put the table name in :config:option:`$cfg['Servers'][$i]['tracking']` (e.g. ``pma__tracking``) .. _tracking2: .. config:option:: $cfg['Servers'][$i]['tracking_version_auto_create'] :type: boolean :default: false Whether the tracking mechanism creates versions for tables and views automatically. If this is set to true and you create a table or view with * CREATE TABLE ... * CREATE VIEW ... and no version exists for it, the mechanism will create a version for you automatically. .. _tracking3: .. config:option:: $cfg['Servers'][$i]['tracking_default_statements'] :type: string :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'`` Defines the list of statements the auto-creation uses for new versions. .. _tracking4: .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_view'] :type: boolean :default: true Whether a DROP VIEW IF EXISTS statement will be added as first line to the log when creating a view. .. _tracking5: .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_table'] :type: boolean :default: true Whether a DROP TABLE IF EXISTS statement will be added as first line to the log when creating a table. .. _tracking6: .. config:option:: $cfg['Servers'][$i]['tracking_add_drop_database'] :type: boolean :default: true Whether a DROP DATABASE IF EXISTS statement will be added as first line to the log when creating a database. .. _userconfig: .. config:option:: $cfg['Servers'][$i]['userconfig'] :type: string :default: ``''`` Since release 3.4.x phpMyAdmin allows users to set most preferences by themselves and store them in the database. If you don't allow for storing preferences in :config:option:`$cfg['Servers'][$i]['pmadb']`, users can still personalize phpMyAdmin, but settings will be saved in browser's local storage, or, it is is unavailable, until the end of session. To allow the usage of this functionality: * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage * put the table name in :config:option:`$cfg['Servers'][$i]['userconfig']` .. _designer_coords: .. config:option:: $cfg['Servers'][$i]['designer_coords'] :type: string :default: ``''`` Since release 2.10.0 a Designer interface is available; it permits to visually manage the relations. To allow the usage of this functionality: * set up :config:option:`$cfg['Servers'][$i]['pmadb']` and the phpMyAdmin configuration storage * put the table name in :config:option:`$cfg['Servers'][$i]['designer\_coords']` (e.g. ``pma__designer_coords``) .. config:option:: $cfg['Servers'][$i]['MaxTableUiprefs'] :type: integer :default: 100 Maximum number of rows saved in :config:option:`$cfg['Servers'][$i]['table_uiprefs']` table. When tables are dropped or renamed, :config:option:`$cfg['Servers'][$i]['table_uiprefs']` may contain invalid data (referring to tables which no longer exist). We only keep this number of newest rows in :config:option:`$cfg['Servers'][$i]['table_uiprefs']` and automatically delete older rows. .. config:option:: $cfg['Servers'][$i]['AllowRoot'] :type: boolean :default: true Whether to allow root access. This is just a shortcut for the :config:option:`$cfg['Servers'][$i]['AllowDeny']['rules']` below. .. config:option:: $cfg['Servers'][$i]['AllowNoPassword'] :type: boolean :default: false Whether to allow logins without a password. The default value of ``false`` for this parameter prevents unintended access to a MySQL server with was left with an empty password for root or on which an anonymous (blank) user is defined. .. _servers_allowdeny_order: .. config:option:: $cfg['Servers'][$i]['AllowDeny']['order'] :type: string :default: ``''`` If your rule order is empty, then :term:`IP` authorization is disabled. If your rule order is set to ``'deny,allow'`` then the system applies all deny rules followed by allow rules. Access is allowed by default. Any client which does not match a Deny command or does match an Allow command will be allowed access to the server. If your rule order is set to ``'allow,deny'`` then the system applies all allow rules followed by deny rules. Access is denied by default. Any client which does not match an Allow directive or does match a Deny directive will be denied access to the server. If your rule order is set to ``'explicit'``, authorization is performed in a similar fashion to rule order 'deny,allow', with the added restriction that your host/username combination **must** be listed in the *allow* rules, and not listed in the *deny* rules. This is the **most** secure means of using Allow/Deny rules, and was available in Apache by specifying allow and deny rules without setting any order. Please also see :config:option:`$cfg['TrustedProxies']` for detecting IP address behind proxies. .. _servers_allowdeny_rules: .. config:option:: $cfg['Servers'][$i]['AllowDeny']['rules'] :type: array of strings :default: array() The general format for the rules is as such: .. code-block:: none <'allow' | 'deny'> [from] If you wish to match all users, it is possible to use a ``'%'`` as a wildcard in the *username* field. There are a few shortcuts you can use in the *ipmask* field as well (please note that those containing SERVER\_ADDRESS might not be available on all webservers): .. code-block:: none 'all' -> 0.0.0.0/0 'localhost' -> 127.0.0.1/8 'localnetA' -> SERVER_ADDRESS/8 'localnetB' -> SERVER_ADDRESS/16 'localnetC' -> SERVER_ADDRESS/24 Having an empty rule list is equivalent to either using ``'allow % from all'`` if your rule order is set to ``'deny,allow'`` or ``'deny % from all'`` if your rule order is set to ``'allow,deny'`` or ``'explicit'``. For the :term:`IP address` matching system, the following work: * ``xxx.xxx.xxx.xxx`` (an exact :term:`IP address`) * ``xxx.xxx.xxx.[yyy-zzz]`` (an :term:`IP address` range) * ``xxx.xxx.xxx.xxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IP` addresses) But the following does not work: * ``xxx.xxx.xxx.xx[yyy-zzz]`` (partial :term:`IP` address range) For :term:`IPv6` addresses, the following work: * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx`` (an exact :term:`IPv6` address) * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:[yyyy-zzzz]`` (an :term:`IPv6` address range) * ``xxxx:xxxx:xxxx:xxxx/nn`` (CIDR, Classless Inter-Domain Routing type :term:`IPv6` addresses) But the following does not work: * ``xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xx[yyy-zzz]`` (partial :term:`IPv6` address range) .. config:option:: $cfg['Servers'][$i]['DisableIS'] :type: boolean :default: true Disable using ``INFORMATION_SCHEMA`` to retrieve information (use ``SHOW`` commands instead), because of speed issues when many databases are present. Currently used in some parts of the code, more to come. .. config:option:: $cfg['Servers'][$i]['ShowDatabasesCommand'] :type: string :default: ``'SHOW DATABASES'`` On a server with a huge number of databases, the default ``SHOW DATABASES`` command used to fetch the name of available databases will probably be too slow, so it can be replaced by faster commands. You can use ``#user#`` string will be replaced by current user. When using ``false``, it will disable fetching databases from the server, only databases in :config:option:`$cfg['Servers'][$i]['only_db']` will be displayed. Examples: * ``'SHOW DATABASES'`` * ``"SHOW DATABASES LIKE '#user#\_%'"`` * ``'SELECT DISTINCT TABLE_SCHEMA FROM information_schema.SCHEMA_PRIVILEGES'`` * ``'SELECT SCHEMA_NAME FROM information_schema.SCHEMATA'`` * ``false`` .. config:option:: $cfg['Servers'][$i]['SignonScript'] :type: string :default: ``''`` Name of PHP script to be sourced and executed to obtain login credentials. This is alternative approach to session based single signon. The script needs to provide function ``get_login_credentials`` which returns list of username and password, accepting single parameter of existing username (can be empty). See :file:`examples/signon-script.php` for an example. .. config:option:: $cfg['Servers'][$i]['SignonSession'] :type: string :default: ``''`` Name of session which will be used for signon authentication method. You should use something different than ``phpMyAdmin``, because this is session which phpMyAdmin uses internally. Takes effect only if :config:option:`$cfg['Servers'][$i]['SignonScript']` is not configured. .. config:option:: $cfg['Servers'][$i]['SignonURL'] :type: string :default: ``''`` :term:`URL` where user will be redirected to log in for signon authentication method. Should be absolute including protocol. .. config:option:: $cfg['Servers'][$i]['LogoutURL'] :type: string :default: ``''`` :term:`URL` where user will be redirected after logout (doesn't affect config authentication method). Should be absolute including protocol. .. config:option:: $cfg['Servers'][$i]['StatusCacheDatabases'] :type: array of strings :default: array() Enables caching of ``TABLE STATUS`` outputs for specific databases on this server (in some cases ``TABLE STATUS`` can be very slow, so you may want to cache it). APC is used (if the PHP extension is available, if not, this setting is ignored silently). You have to provide :config:option:`$cfg['Servers'][$i]['StatusCacheLifetime']`. Takes effect only if :config:option:`$cfg['Servers'][$i]['DisableIS']` is ``true``. .. config:option:: $cfg['Servers'][$i]['StatusCacheLifetime'] :type: integer :default: 0 Lifetime in seconds of the ``TABLE STATUS`` cache if :config:option:`$cfg['Servers'][$i]['StatusCacheDatabases']` is used. Generic settings ---------------- .. config:option:: $cfg['ServerDefault'] :type: integer :default: 1 If you have more than one server configured, you can set :config:option:`$cfg['ServerDefault']` to any one of them to autoconnect to that server when phpMyAdmin is started, or set it to 0 to be given a list of servers without logging in. If you have only one server configured, :config:option:`$cfg['ServerDefault']` MUST be set to that server. .. config:option:: $cfg['VersionCheck'] :type: boolean :default: true Enables check for latest versions using javascript on main phpMyAdmin page. .. note:: This setting can be adjusted by your vendor. .. config:option:: $cfg['MaxDbList'] :type: integer :default: 100 The maximum number of database names to be displayed in the main panel's database list. .. config:option:: $cfg['MaxNavigationItems'] :type: integer :default: 250 The number of items that can be displayed on each page of the navigation tree. .. config:option:: $cfg['MaxTableList'] :type: integer :default: 250 The maximum number of table names to be displayed in the main panel's list (except on the Export page). This limit is also enforced in the navigation panel when in Light mode. .. config:option:: $cfg['ShowHint'] :type: boolean :default: true Whether or not to show hints (for example, hints when hovering over table headers). .. config:option:: $cfg['MaxCharactersInDisplayedSQL'] :type: integer :default: 1000 The maximum number of characters when a :term:`SQL` query is displayed. The default limit of 1000 should be correct to avoid the display of tons of hexadecimal codes that represent BLOBs, but some users have real :term:`SQL` queries that are longer than 1000 characters. Also, if a query's length exceeds this limit, this query is not saved in the history. .. config:option:: $cfg['PersistentConnections'] :type: boolean :default: false Whether `persistent connections `_ should be used or not. Works with following extensions: * mysql (`mysql\_pconnect `_), * mysqli (requires PHP 5.3.0 or newer, `more information `_). .. config:option:: $cfg['ForceSSL'] :type: boolean :default: false Whether to force using https while accessing phpMyAdmin. .. config:option:: $cfg['ExecTimeLimit'] :type: integer [number of seconds] :default: 300 Set the number of seconds a script is allowed to run. If seconds is set to zero, no time limit is imposed. This setting is used while importing/exporting dump files but has no effect when PHP is running in safe mode. .. config:option:: $cfg['SessionSavePath'] :type: string :default: ``''`` Path for storing session data (`session\_save\_path PHP parameter `_). .. config:option:: $cfg['MemoryLimit'] :type: string [number of bytes] :default: ``'0'`` Set the number of bytes a script is allowed to allocate. If set to zero, no limit is imposed. This setting is used while importing/exporting dump files and at some other places in phpMyAdmin so you definitely don't want to put here a too low value. It has no effect when PHP is running in safe mode. You can also use any string as in :file:`php.ini`, eg. '16M'. Ensure you don't omit the suffix (16 means 16 bytes!) .. config:option:: $cfg['SkipLockedTables'] :type: boolean :default: false Mark used tables and make it possible to show databases with locked tables (since MySQL 3.23.30). .. config:option:: $cfg['ShowSQL'] :type: boolean :default: true Defines whether :term:`SQL` queries generated by phpMyAdmin should be displayed or not. .. config:option:: $cfg['RetainQueryBox'] :type: boolean :default: false Defines whether the :term:`SQL` query box should be kept displayed after its submission. .. config:option:: $cfg['CodemirrorEnable'] :type: boolean :default: true Defines whether to use a Javascript code editor for SQL query boxes. CodeMirror provides syntax highlighting and line numbers. However, middle-clicking for pasting the clipboard contents in some Linux distributions (such as Ubuntu) is not supported by all browsers. .. config:option:: $cfg['AllowUserDropDatabase'] :type: boolean :default: false Defines whether normal users (non-administrator) are allowed to delete their own database or not. If set as false, the link :guilabel:`Drop Database` will not be shown, and even a ``DROP DATABASE mydatabase`` will be rejected. Quite practical for :term:`ISP` 's with many customers. .. note:: This limitation of :term:`SQL` queries is not as strict as when using MySQL privileges. This is due to nature of :term:`SQL` queries which might be quite complicated. So this choice should be viewed as help to avoid accidental dropping rather than strict privilege limitation. .. config:option:: $cfg['Confirm'] :type: boolean :default: true Whether a warning ("Are your really sure...") should be displayed when you're about to lose data. .. config:option:: $cfg['UseDbSearch'] :type: boolean :default: true Define whether the "search string inside database" is enabled or not. .. config:option:: $cfg['IgnoreMultiSubmitErrors'] :type: boolean :default: false Define whether phpMyAdmin will continue executing a multi-query statement if one of the queries fails. Default is to abort execution. Cookie authentication options ----------------------------- .. config:option:: $cfg['blowfish_secret'] :type: string :default: ``''`` The "cookie" auth\_type uses AES algorithm to encrypt the password. If you are using the "cookie" auth\_type, enter here a random passphrase of your choice. It will be used internally by the AES algorithm: you won��t be prompted for this passphrase. The secret should be 32 characters long. Using shorter will lead to weaker security of encrypted cookies, using longer will cause no harm. .. note:: The configuration is called blowfish_secret for historical reasons as Blowfish algorithm was originally used to do the encryption. .. versionchanged:: 3.1.0 Since version 3.1.0 phpMyAdmin can generate this on the fly, but it makes a bit weaker security as this generated secret is stored in session and furthermore it makes impossible to recall user name from cookie. .. config:option:: $cfg['LoginCookieRecall'] :type: boolean :default: true Define whether the previous login should be recalled or not in cookie authentication mode. This is automatically disabled if you do not have configured :config:option:`$cfg['blowfish_secret']`. .. config:option:: $cfg['LoginCookieValidity'] :type: integer [number of seconds] :default: 1440 Define how long a login cookie is valid. Please note that php configuration option `session.gc\_maxlifetime `_ might limit session validity and if the session is lost, the login cookie is also invalidated. So it is a good idea to set ``session.gc_maxlifetime`` at least to the same value of :config:option:`$cfg['LoginCookieValidity']`. .. config:option:: $cfg['LoginCookieStore'] :type: integer [number of seconds] :default: 0 Define how long login cookie should be stored in browser. Default 0 means that it will be kept for existing session. This is recommended for not trusted environments. .. config:option:: $cfg['LoginCookieDeleteAll'] :type: boolean :default: true If enabled (default), logout deletes cookies for all servers, otherwise only for current one. Setting this to false makes it easy to forget to log out from other server, when you are using more of them. .. _AllowArbitraryServer: .. config:option:: $cfg['AllowArbitraryServer'] :type: boolean :default: false If enabled, allows you to log in to arbitrary servers using cookie authentication. .. note:: Please use this carefully, as this may allow users access to MySQL servers behind the firewall where your :term:`HTTP` server is placed. Navigation panel setup ---------------------- .. config:option:: $cfg['NavigationTreeEnableGrouping'] :type: boolean :default: true Defines whether to group the databases based on a common prefix in their name :config:option:`$cfg['NavigationTreeDbSeparator']`. .. config:option:: $cfg['NavigationTreeDbSeparator'] :type: string or array :default: ``'_'`` The string used to separate the parts of the database name when showing them in a tree. Alternatively you can specify more strings in an array and all of them will be used as a separator. .. config:option:: $cfg['NavigationTreeTableSeparator'] :type: string or array :default: ``'__'`` Defines a string to be used to nest table spaces. This means if you have tables like ``first__second__third`` this will be shown as a three-level hierarchy like: first > second > third. If set to false or empty, the feature is disabled. NOTE: You should not use this separator at the beginning or end of a table name or multiple times after another without any other characters in between. .. config:option:: $cfg['NavigationTreeTableLevel'] :type: integer :default: 1 Defines how many sublevels should be displayed when splitting up tables by the above separator. .. config:option:: $cfg['NumRecentTables'] :type: integer :default: 10 The maximum number of recently used tables shown in the navigation panel. Set this to 0 (zero) to disable the listing of recent tables. .. config:option:: $cfg['NavigationDisplayLogo'] :type: boolean :default: true Defines whether or not to display the phpMyAdmin logo at the top of the navigation panel. .. config:option:: $cfg['NavigationLogoLink'] :type: string :default: ``'index.php'`` Enter :term:`URL` where logo in the navigation panel will point to. For use especially with self made theme which changes this. .. config:option:: $cfg['NavigationLogoLinkWindow'] :type: string :default: ``'main'`` Whether to open the linked page in the main window (``main``) or in a new one (``new``). Note: use ``new`` if you are linking to ``phpmyadmin.net``. .. config:option:: $cfg['NavigationTreeDisplayItemFilterMinimum'] :type: integer :default: 30 Defines the minimum number of items (tables, views, routines and events) to display a JavaScript filter box above the list of items in the navigation tree. To disable the filter completely some high number can be used (e.g. 9999) .. config:option:: $cfg['NavigationTreeDisplayDbFilterMinimum'] :type: integer :default: 30 Defines the minimum number of databases to display a JavaScript filter box above the list of databases in the navigation tree. To disable the filter completely some high number can be used (e.g. 9999) .. config:option:: $cfg['NavigationDisplayServers'] :type: boolean :default: true Defines whether or not to display a server choice at the top of the navigation panel. .. config:option:: $cfg['DisplayServersList'] :type: boolean :default: false Defines whether to display this server choice as links instead of in a drop-down. .. config:option:: $cfg['NavigationTreeDefaultTabTable'] :type: string :default: ``'tbl_structure.php'`` Defines the tab displayed by default when clicking the small icon next to each table name in the navigation panel. Possible values: * ``tbl_structure.php`` * ``tbl_sql.php`` * ``tbl_select.php`` * ``tbl_change.php`` * ``sql.php`` Main panel ---------- .. config:option:: $cfg['ShowStats'] :type: boolean :default: true Defines whether or not to display space usage and statistics about databases and tables. Note that statistics requires at least MySQL 3.23.3 and that, at this date, MySQL doesn't return such information for Berkeley DB tables. .. config:option:: $cfg['ShowServerInfo'] :type: boolean :default: true Defines whether to display detailed server information on main page. You can additionally hide more information by using :config:option:`$cfg['Servers'][$i]['verbose']`. .. config:option:: $cfg['ShowChgPassword'] :type: boolean :default: true .. config:option:: $cfg['ShowCreateDb'] :type: boolean :default: true Defines whether to display the :guilabel:`Change password` links and form for creating database or not at the starting main (right) frame. This setting does not check MySQL commands entered directly. Also note that enabling the :guilabel:`Change password` link has no effect with config authentication mode: because of the hard coded password value in the configuration file, end users can't be allowed to change their passwords. Database structure ------------------ .. config:option:: $cfg['ShowDbStructureCreation'] :type: boolean :default: false Defines whether the database structure page (tables list) has a "Creation" column that displays when each table was created. .. config:option:: $cfg['ShowDbStructureLastUpdate'] :type: boolean :default: false Defines whether the database structure page (tables list) has a "Last update" column that displays when each table was last updated. .. config:option:: $cfg['ShowDbStructureLastCheck'] :type: boolean :default: false Defines whether the database structure page (tables list) has a "Last check" column that displays when each table was last checked. .. config:option:: $cfg['HideStructureActions'] :type: boolean :default: true Defines whether the table structure actions are hidden under a "More" drop-down. Browse mode ----------- .. config:option:: $cfg['TableNavigationLinksMode'] :type: string :default: ``'icons'`` Defines whether the table navigation links contain ``'icons'``, ``'text'`` or ``'both'``. .. config:option:: $cfg['ShowAll'] :type: boolean :default: false Defines whether a user should be displayed a "Show all" button in browse mode or not in all cases. By default it is shown only on small tables (less than 5 � :config:option:`$cfg['MaxRows']` rows) to avoid performance issues while getting too many rows. .. config:option:: $cfg['MaxRows'] :type: integer :default: 30 Number of rows displayed when browsing a result set and no LIMIT clause is used. If the result set contains more rows, "Previous" and "Next" links will be shown. .. config:option:: $cfg['Order'] :type: string :default: ``'SMART'`` Defines whether columns are displayed in ascending (``ASC``) order, in descending (``DESC``) order or in a "smart" (``SMART``) order - I.E. descending order for columns of type TIME, DATE, DATETIME and TIMESTAMP, ascending order else- by default. .. config:option:: $cfg['DisplayBinaryAsHex'] :type: boolean :default: true Defines whether the "Show binary contents as HEX" browse option is ticked by default. .. config:option:: $cfg['GridEditing'] :type: string :default: ``'double-click'`` Defines which action (``double-click`` or ``click``) triggers grid editing. Can be deactived with the ``disabled`` value. .. config:option:: $cfg['SaveCellsAtOnce'] :type: boolean :default: false Defines whether or not to save all edited cells at once for grid editing. Editing mode ------------ .. config:option:: $cfg['ProtectBinary'] :type: boolean or string :default: ``'blob'`` Defines whether ``BLOB`` or ``BINARY`` columns are protected from editing when browsing a table's content. Valid values are: * ``false`` to allow editing of all columns; * ``'blob'`` to allow editing of all columns except ``BLOBS``; * ``'noblob'`` to disallow editing of all columns except ``BLOBS`` (the opposite of ``'blob'``); * ``'all'`` to disallow editing of all ``BINARY`` or ``BLOB`` columns. .. config:option:: $cfg['ShowFunctionFields'] :type: boolean :default: true Defines whether or not MySQL functions fields should be initially displayed in edit/insert mode. Since version 2.10, the user can toggle this setting from the interface. .. config:option:: $cfg['ShowFieldTypesInDataEditView'] :type: boolean :default: true Defines whether or not type fields should be initially displayed in edit/insert mode. The user can toggle this setting from the interface. .. config:option:: $cfg['InsertRows'] :type: integer :default: 2 Defines the maximum number of concurrent entries for the Insert page. .. config:option:: $cfg['ForeignKeyMaxLimit'] :type: integer :default: 100 If there are fewer items than this in the set of foreign keys, then a drop-down box of foreign keys is presented, in the style described by the :config:option:`$cfg['ForeignKeyDropdownOrder']` setting. .. config:option:: $cfg['ForeignKeyDropdownOrder'] :type: array :default: array('content-id', 'id-content') For the foreign key drop-down fields, there are several methods of display, offering both the key and value data. The contents of the array should be one or both of the following strings: ``content-id``, ``id-content``. Export and import settings -------------------------- .. config:option:: $cfg['ZipDump'] :type: boolean :default: true .. config:option:: $cfg['GZipDump'] :type: boolean :default: true .. config:option:: $cfg['BZipDump'] :type: boolean :default: true Defines whether to allow the use of zip/GZip/BZip2 compression when creating a dump file .. config:option:: $cfg['CompressOnFly'] :type: boolean :default: true Defines whether to allow on the fly compression for GZip/BZip2 compressed exports. This doesn't affect smaller dumps and allows users to create larger dumps that won't otherwise fit in memory due to php memory limit. Produced files contain more GZip/BZip2 headers, but all normal programs handle this correctly. .. config:option:: $cfg['Export'] :type: array :default: array(...) In this array are defined default parameters for export, names of items are similar to texts seen on export page, so you can easily identify what they mean. .. config:option:: $cfg['Export']['method'] :type: string :default: ``'quick'`` Defines how the export form is displayed when it loads. Valid values are: * ``quick`` to display the minimum number of options to configure * ``custom`` to display every available option to configure * ``custom-no-form`` same as ``custom`` but does not display the option of using quick export .. config:option:: $cfg['Import'] :type: array :default: array(...) In this array are defined default parameters for import, names of items are similar to texts seen on import page, so you can easily identify what they mean. Tabs display settings --------------------- .. config:option:: $cfg['TabsMode'] :type: string :default: ``'both'`` Defines whether the menu tabs contain ``'icons'``, ``'text'`` or ``'both'``. .. config:option:: $cfg['ActionLinksMode'] :type: string :default: ``'both'`` If set to ``icons``, will display icons instead of text for db and table properties links (like :guilabel:`Browse`, :guilabel:`Select`, :guilabel:`Insert`, ...). Can be set to ``'both'`` if you want icons AND text. When set to ``text``, will only show text. .. config:option:: $cfg['PropertiesNumColumns'] :type: integer :default: 1 How many columns will be utilized to display the tables on the database property view? When setting this to a value larger than 1, the type of the database will be omitted for more display space. .. config:option:: $cfg['DefaultTabServer'] :type: string :default: ``'index.php'`` Defines the tab displayed by default on server view. Possible values: * ``main.php`` (recommended for multi-user setups) * ``serv