diff options
Diffstat (limited to 'srcs/phpmyadmin/doc/html/_sources')
23 files changed, 0 insertions, 10038 deletions
diff --git a/srcs/phpmyadmin/doc/html/_sources/bookmarks.txt b/srcs/phpmyadmin/doc/html/_sources/bookmarks.txt deleted file mode 100644 index 0da9194..0000000 --- a/srcs/phpmyadmin/doc/html/_sources/bookmarks.txt +++ /dev/null @@ -1,77 +0,0 @@ -.. _bookmarks: - -Bookmarks -========= - -.. note:: - - You need to have configured the :ref:`linked-tables` for using bookmarks - feature. - -Storing bookmarks ------------------ - -Any query that is executed can be marked as a bookmark on the page -where the results are displayed. You will find a button labeled -:guilabel:`Bookmark this query` just at the end of the page. As soon as you have -stored a bookmark, that query is linked to the database. -You can now access a bookmark dropdown on each page where the query box appears on for that database. - -Variables inside bookmarks --------------------------- - -Inside a query, you can also add placeholders for variables. -This is done by inserting into the query SQL comments between ``/*`` and -``*/``. The special string ``[VARIABLE{variable-number}]`` is used inside the comments. -Be aware that the whole query minus the SQL comments must be -valid by itself, otherwise you won't be able to store it as a bookmark. -Also, note that the text 'VARIABLE' is case-sensitive. - -When you execute the bookmark, everything typed into the *Variables* -input boxes on the query box page will replace the strings ``/*[VARIABLE{variable-number}]*/`` in -your stored query. - -Also remember, that everything else inside the ``/*[VARIABLE{variable-number}]*/`` string for -your query will remain the way it is, but will be stripped of the ``/**/`` -chars. So you can use: - -.. code-block:: mysql - - /*, [VARIABLE1] AS myname */ - -which will be expanded to - -.. code-block:: mysql - - , VARIABLE1 as myname - -in your query, where VARIABLE1 is the string you entered in the Variable 1 input box. - -A more complex example, say you have stored this query: - -.. code-block:: mysql - - SELECT Name, Address FROM addresses WHERE 1 /* AND Name LIKE '%[VARIABLE1]%' */ - -If you wish to enter "phpMyAdmin" as the variable for the stored query, the full -query will be: - -.. code-block:: mysql - - SELECT Name, Address FROM addresses WHERE 1 AND Name LIKE '%phpMyAdmin%' - -**NOTE THE ABSENCE OF SPACES** inside the ``/**/`` construct. Any spaces -inserted there will be later also inserted as spaces in your query and may lead -to unexpected results especially when using the variable expansion inside of a -"LIKE ''" expression. - -Browsing a table using a bookmark ---------------------------------- - -When a bookmark has the same name as the table, it will be used as the query when browsing -this table. - -.. seealso:: - - :ref:`faqbookmark`, - :ref:`faq6_22` diff --git a/srcs/phpmyadmin/doc/html/_sources/charts.txt b/srcs/phpmyadmin/doc/html/_sources/charts.txt deleted file mode 100644 index 4896d9d..0000000 --- a/srcs/phpmyadmin/doc/html/_sources/charts.txt +++ /dev/null @@ -1,143 +0,0 @@ -.. _charts: - -Charts -====== - -.. versionadded:: 3.4.0 - -Since phpMyAdmin version 3.4.0, you can easily generate charts from a SQL query -by clicking the "Display chart" link in the "Query results operations" area. - -.. image:: images/query_result_operations.png - -A window layer "Display chart" is shown in which you can customize the chart with the following options. - -- Chart type: Allows you to choose the type of chart. Supported types are bar charts, column charts, line charts, spline charts, area charts, pie charts and timeline charts (only the chart types applicable for current series selection are offered). -- X-axis: Allows to choose the field for the main axis. -- Series: Allows to choose series for the chart. You can choose multiple series. -- Title: Allows specifying a title for the chart which is displayed above the chart. -- X-axis and Y-axis labels: Allows specifying labels for axes. -- Start row and a number of rows: Allows generating charts only for a specified number of rows of the results set. - -.. image:: images/chart.png - -Chart implementation --------------------- - -Charts in phpMyAdmin are drawn using `jqPlot <http://www.jqplot.com/>`_ jQuery library. - -Examples --------- - -Pie chart -+++++++++ - -Query results for a simple pie chart can be generated with: - -.. code-block:: mysql - - SELECT 'Food' AS 'expense', - 1250 AS 'amount' UNION - SELECT 'Accommodation', 500 UNION - SELECT 'Travel', 720 UNION - SELECT 'Misc', 220 - -And the result of this query is: - -+---------------+--------+ -| expense | amount | -+===============+========+ -| Food | 1250 | -+---------------+--------+ -| Accommodation | 500 | -+---------------+--------+ -| Travel | 720 | -+---------------+--------+ -| Misc | 220 | -+---------------+--------+ - -Choosing expense as the X-axis and amount in series: - -.. image:: images/pie_chart.png - -Bar and column chart -++++++++++++++++++++ - -Both bar charts and column chats support stacking. Upon selecting one of these types a checkbox is displayed to select stacking. - -Query results for a simple bar or column chart can be generated with: - -.. code-block:: mysql - - SELECT - 'ACADEMY DINOSAUR' AS 'title', - 0.99 AS 'rental_rate', - 20.99 AS 'replacement_cost' UNION - SELECT 'ACE GOLDFINGER', 4.99, 12.99 UNION - SELECT 'ADAPTATION HOLES', 2.99, 18.99 UNION - SELECT 'AFFAIR PREJUDICE', 2.99, 26.99 UNION - SELECT 'AFRICAN EGG', 2.99, 22.99 - -And the result of this query is: - -+------------------+--------------+-------------------+ -| title | rental_rate | replacement_cost | -+==================+==============+===================+ -| ACADEMY DINOSAUR | 0.99 | 20.99 | -+------------------+--------------+-------------------+ -| ACE GOLDFINGER | 4.99 | 12.99 | -+------------------+--------------+-------------------+ -| ADAPTATION HOLES | 2.99 | 18.99 | -+------------------+--------------+-------------------+ -| AFFAIR PREJUDICE | 2.99 | 26.99 | -+------------------+--------------+-------------------+ -| AFRICAN EGG | 2.99 | 22.99 | -+------------------+--------------+-------------------+ - -Choosing title as the X-axis and rental_rate and replacement_cost as series: - -.. image:: images/column_chart.png - -Scatter chart -+++++++++++++ - -Scatter charts are useful in identifying the movement of one or more variable(s) compared to another variable. - -Using the same data set from bar and column charts section and choosing replacement_cost as the X-axis and rental_rate in series: - -.. image:: images/scatter_chart.png - -Line, spline and timeline charts -++++++++++++++++++++++++++++++++ - -These charts can be used to illustrate trends in underlying data. Spline charts draw smooth lines while timeline charts draw X-axis taking the distances between the dates/time into consideration. - -Query results for a simple line, spline or timeline chart can be generated with: - -.. code-block:: mysql - - SELECT - DATE('2006-01-08') AS 'date', - 2056 AS 'revenue', - 1378 AS 'cost' UNION - SELECT DATE('2006-01-09'), 1898, 2301 UNION - SELECT DATE('2006-01-15'), 1560, 600 UNION - SELECT DATE('2006-01-17'), 3457, 1565 - -And the result of this query is: - -+------------+---------+------+ -| date | revenue | cost | -+============+=========+======+ -| 2016-01-08 | 2056 | 1378 | -+------------+---------+------+ -| 2006-01-09 | 1898 | 2301 | -+------------+---------+------+ -| 2006-01-15 | 1560 | 600 | -+------------+---------+------+ -| 2006-01-17 | 3457 | 1565 | -+------------+---------+------+ - -.. image:: images/line_chart.png -.. image:: images/spline_chart.png -.. image:: images/timeline_chart.png diff --git a/srcs/phpmyadmin/doc/html/_sources/config.txt b/srcs/phpmyadmin/doc/html/_sources/config.txt deleted file mode 100644 index 97d7902..0000000 --- a/srcs/phpmyadmin/doc/html/_sources/config.txt +++ /dev/null @@ -1,3609 +0,0 @@ -.. index:: config.inc.php - -.. _config: - -Configuration -============= - -All configurable data is placed in :file:`config.inc.php` in phpMyAdmin's -toplevel directory. 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` (this file is not inteded for changes). - -.. seealso:: - - :ref:`config-examples` for examples of configurations - -If a directive is missing from your file, you can just add another line with -the file. This file is for over-writing the defaults; if you wish to use the -default value there's no need to add a line here. - -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: ``''`` - - .. versionchanged:: 4.6.5 - - This setting was not available in phpMyAdmin 4.6.0 - 4.6.4. - - Sets here the complete :term:`URL` (with full path) to your phpMyAdmin - installation's directory. E.g. - ``https://www.example.net/path_to_your_phpMyAdmin_directory/``. Note also - that the :term:`URL` on most of web servers are case sensitive (even on - Windows). 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 or complex reverse proxy setup might need to set this. - - 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`, :ref:`faq2_5`, :ref:`faq4_7`, :ref:`faq5_16` - -.. 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['AuthLog'] - - :type: string - :default: ``'auto'`` - - .. versionadded:: 4.8.0 - - This is supported since phpMyAdmin 4.8.0. - - Configure authentication logging destination. Failed (or all, depending on - :config:option:`$cfg['AuthLogSuccess']`) authentication attempts will be - logged according to this directive: - - ``auto`` - Let phpMyAdmin automatically choose between ``syslog`` and ``php``. - ``syslog`` - Log using syslog, using AUTH facility, on most systems this ends up - in :file:`/var/log/auth.log`. - ``php`` - Log into PHP error log. - ``sapi`` - Log into PHP SAPI logging. - ``/path/to/file`` - Any other value is treated as a filename and log entries are written there. - - .. note:: - - When logging to a file, make sure its permissions are correctly set - for a web server user, the setup should closely match instructions - described in :config:option:`$cfg['TempDir']`: - -.. config:option:: $cfg['AuthLogSuccess'] - - :type: boolean - :default: false - - .. versionadded:: 4.8.0 - - This is supported since phpMyAdmin 4.8.0. - - Whether to log successful authentication attempts into - :config:option:`$cfg['AuthLog']`. - -.. 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['LoginCookieValidityDisableWarning'] - - :type: boolean - :default: false - - A warning is displayed on the main page if the PHP parameter - session.gc_maxlifetime is lower than cookie validity configured in phpMyAdmin. - - You can set this parameter to ``true`` to stop this message from appearing. - -.. config:option:: $cfg['ServerLibraryDifference_DisableWarning'] - - :type: boolean - :default: false - - .. deprecated:: 4.7.0 - - This setting was removed as the warning has been removed as well. - - 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 no longer be displayed. - -.. config:option:: $cfg['TranslationWarningThreshold'] - - :type: integer - :default: 80 - - Show warning about incomplete translations on certain threshold. - -.. config:option:: $cfg['SendErrorReports'] - - :type: string - :default: ``'ask'`` - - Sets the default behavior for JavaScript error reporting. - - Whenever an error is detected in the JavaScript execution, an error report - may be sent to the phpMyAdmin team if the user agrees. - - The default setting of ``'ask'`` will ask the user everytime there is a new - error report. However you can set this parameter to ``'always'`` to send error - reports without asking for confirmation or you can set it to ``'never'`` to - never send error reports. - - This directive is available both in the configuration file and in users - preferences. If the person in charge of a multi-user installation prefers - to disable this feature for all users, a value of ``'never'`` should be - set, and the :config:option:`$cfg['UserprefsDisallow']` directive should - contain ``'SendErrorReports'`` in one of its array values. - -.. config:option:: $cfg['ConsoleEnterExecutes'] - - :type: boolean - :default: false - - Setting this to ``true`` allows the user to execute queries by pressing Enter - instead of Ctrl+Enter. A new line can be inserted by pressing Shift + Enter. - - The behaviour of the console can be temporarily changed using console's - settings interface. - -.. config:option:: $cfg['AllowThirdPartyFraming'] - - :type: boolean|string - :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. Setting this to 'sameorigin' prevents phpMyAdmin to be - included from another document in a frame, unless that document belongs - to the same domain. - -Server connection settings --------------------------- - -.. config:option:: $cfg['Servers'] - - :type: array - :default: one server array with settings listed below - - 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'`` - * IPv6 address, e.g. ``2001:cdba:0000:0000:0000:0000:3257:9652`` - * dot - ``'.'``, i.e., use named pipes on windows systems - * empty - ``''``, disables this server - - .. note:: - - The hostname ``localhost`` is handled specially by MySQL and it uses - the socket based connection protocol. To use TCP/IP networking, use an - IP address or hostname such as ``127.0.0.1`` or ``db.example.com``. You - can configure the path to the socket with - :config:option:`$cfg['Servers'][$i]['socket']`. - - .. seealso:: - - :config:option:`$cfg['Servers'][$i]['port']`, - <https://dev.mysql.com/doc/refman/5.7/en/connecting.html> - -.. 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']`. - - .. seealso:: - - :config:option:`$cfg['Servers'][$i]['host']`, - <https://dev.mysql.com/doc/refman/5.7/en/connecting.html> - -.. 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. - - .. note:: - - This takes effect only if :config:option:`$cfg['Servers'][$i]['host']` is set - to ``localhost``. - - .. seealso:: - - :config:option:`$cfg['Servers'][$i]['host']`, - <https://dev.mysql.com/doc/refman/5.7/en/connecting.html> - -.. config:option:: $cfg['Servers'][$i]['ssl'] - - :type: boolean - :default: false - - Whether to enable SSL for the connection between phpMyAdmin and the MySQL - server to secure the connection. - - When using the ``'mysql'`` extension, - none of the remaining ``'ssl...'`` configuration options apply. - - We strongly recommend the ``'mysqli'`` extension when using this option. - - .. seealso:: - - :ref:`ssl`, - :ref:`example-google-ssl`, - :config:option:`$cfg['Servers'][$i]['ssl_key']`, - :config:option:`$cfg['Servers'][$i]['ssl_cert']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`, - :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`, - :config:option:`$cfg['Servers'][$i]['ssl_verify']` - -.. config:option:: $cfg['Servers'][$i]['ssl_key'] - - :type: string - :default: NULL - - Path to the client key file when using SSL for connecting to the MySQL - server. This is used to authenticate the client to the server. - - For example: - - .. code-block:: php - - $cfg['Servers'][$i]['ssl_key'] = '/etc/mysql/server-key.pem'; - - .. seealso:: - - :ref:`ssl`, - :ref:`example-google-ssl`, - :config:option:`$cfg['Servers'][$i]['ssl']`, - :config:option:`$cfg['Servers'][$i]['ssl_cert']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`, - :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`, - :config:option:`$cfg['Servers'][$i]['ssl_verify']` - -.. config:option:: $cfg['Servers'][$i]['ssl_cert'] - - :type: string - :default: NULL - - Path to the client certificate file when using SSL for connecting to the - MySQL server. This is used to authenticate the client to the server. - - .. seealso:: - - :ref:`ssl`, - :ref:`example-google-ssl`, - :config:option:`$cfg['Servers'][$i]['ssl']`, - :config:option:`$cfg['Servers'][$i]['ssl_key']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`, - :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`, - :config:option:`$cfg['Servers'][$i]['ssl_verify']` - -.. config:option:: $cfg['Servers'][$i]['ssl_ca'] - - :type: string - :default: NULL - - Path to the CA file when using SSL for connecting to the MySQL server. - - .. seealso:: - - :ref:`ssl`, - :ref:`example-google-ssl`, - :config:option:`$cfg['Servers'][$i]['ssl']`, - :config:option:`$cfg['Servers'][$i]['ssl_key']`, - :config:option:`$cfg['Servers'][$i]['ssl_cert']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`, - :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`, - :config:option:`$cfg['Servers'][$i]['ssl_verify']` - -.. config:option:: $cfg['Servers'][$i]['ssl_ca_path'] - - :type: string - :default: NULL - - Directory containing trusted SSL CA certificates in PEM format. - - .. seealso:: - - :ref:`ssl`, - :ref:`example-google-ssl`, - :config:option:`$cfg['Servers'][$i]['ssl']`, - :config:option:`$cfg['Servers'][$i]['ssl_key']`, - :config:option:`$cfg['Servers'][$i]['ssl_cert']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca']`, - :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`, - :config:option:`$cfg['Servers'][$i]['ssl_verify']` - -.. config:option:: $cfg['Servers'][$i]['ssl_ciphers'] - - :type: string - :default: NULL - - List of allowable ciphers for SSL connections to the MySQL server. - - .. seealso:: - - :ref:`ssl`, - :ref:`example-google-ssl`, - :config:option:`$cfg['Servers'][$i]['ssl']`, - :config:option:`$cfg['Servers'][$i]['ssl_key']`, - :config:option:`$cfg['Servers'][$i]['ssl_cert']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`, - :config:option:`$cfg['Servers'][$i]['ssl_verify']` - -.. config:option:: $cfg['Servers'][$i]['ssl_verify'] - - :type: boolean - :default: true - - .. versionadded:: 4.6.0 - - This is supported since phpMyAdmin 4.6.0. - - If your PHP install uses the MySQL Native Driver (mysqlnd), your - MySQL server is 5.6 or later, and your SSL certificate is self-signed, - there is a chance your SSL connection will fail due to validation. - Setting this to ``false`` will disable the validation check. - - Since PHP 5.6.0 it also verifies whether server name matches CN of its - certificate. There is currently no way to disable just this check without - disabling complete SSL verification. - - .. warning:: - - Disabling the certificate verification defeats purpose of using SSL. - This will make the connection vulnerable to man in the middle attacks. - - .. note:: - - This flag only works with PHP 5.6.16 or later. - - .. seealso:: - - :ref:`ssl`, - :ref:`example-google-ssl`, - :config:option:`$cfg['Servers'][$i]['ssl']`, - :config:option:`$cfg['Servers'][$i]['ssl_key']`, - :config:option:`$cfg['Servers'][$i]['ssl_cert']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`, - :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`, - :config:option:`$cfg['Servers'][$i]['ssl_verify']` - -.. config:option:: $cfg['Servers'][$i]['connect_type'] - - :type: string - :default: ``'tcp'`` - - .. deprecated:: 4.7.0 - - This setting is no longer used as of 4.7.0, since MySQL decides the - connection type based on host, so it could lead to unexpected results. - Please set :config:option:`$cfg['Servers'][$i]['host']` accordingly - instead. - - 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]['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. - - .. seealso:: - - :config:option:`$cfg['Servers'][$i]['control_*']` - -.. _controlport: -.. config:option:: $cfg['Servers'][$i]['controlport'] - - :type: string - :default: ``''`` - - Permits to use an alternate port to connect to the host that - holds the configuration storage. - - .. seealso:: - - :config:option:`$cfg['Servers'][$i]['control_*']` - -.. _controluser: -.. config:option:: $cfg['Servers'][$i]['controluser'] - - :type: string - :default: ``''`` - -.. config:option:: $cfg['Servers'][$i]['controlpass'] - - :type: string - :default: ``''`` - - This special account is used to access :ref:`linked-tables`. - You don't need it in single user case, but if phpMyAdmin is shared it - is recommended to give access to :ref:`linked-tables` only to this user - and configure phpMyAdmin to use it. All users will then be able to use - the features without need to have direct access to :ref:`linked-tables`. - - .. versionchanged:: 2.2.5 - those were called ``stduser`` and ``stdpass`` - - .. seealso:: - - :ref:`setup`, - :ref:`authentication_modes`, - :ref:`linked-tables`, - :config:option:`$cfg['Servers'][$i]['pmadb']`, - :config:option:`$cfg['Servers'][$i]['controlhost']`, - :config:option:`$cfg['Servers'][$i]['controlport']`, - :config:option:`$cfg['Servers'][$i]['control_*']` - -.. config:option:: $cfg['Servers'][$i]['control_*'] - - :type: mixed - - .. versionadded:: 4.7.0 - - You can change any MySQL connection setting for control link (used to - access :ref:`linked-tables`) using configuration prefixed with ``control_``. - - This can be used to change any aspect of the control connection, which by - default uses same parameters as the user one. - - For example you can configure SSL for the control connection: - - .. code-block:: php - - // Enable SSL - $cfg['Servers'][$i]['control_ssl'] = true; - // Client secret key - $cfg['Servers'][$i]['control_ssl_key'] = '../client-key.pem'; - // Client certificate - $cfg['Servers'][$i]['control_ssl_cert'] = '../client-cert.pem'; - // Server certification authority - $cfg['Servers'][$i]['control_ssl_ca'] = '../server-ca.pem'; - - .. seealso:: - - :config:option:`$cfg['Servers'][$i]['ssl']`, - :config:option:`$cfg['Servers'][$i]['ssl_key']`, - :config:option:`$cfg['Servers'][$i]['ssl_cert']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca']`, - :config:option:`$cfg['Servers'][$i]['ssl_ca_path']`, - :config:option:`$cfg['Servers'][$i]['ssl_ciphers']`, - :config:option:`$cfg['Servers'][$i]['ssl_verify']` - -.. 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'``) allows you to - log in as any valid MySQL user with the help of cookies. - * 'http' authentication allows you to log in as any - valid MySQL user via HTTP-Auth. - * 'signon' authentication mode (``$auth_type = 'signon'``) allows you to - log in from prepared PHP session data or using supplied PHP script. - - .. 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 - - .. deprecated:: 4.7.0 - - This setting was removed as it can produce unexpected results. - - 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: ``''`` |