diff options
Diffstat (limited to 'srcs/phpmyadmin/doc/html/config.html')
| -rw-r--r-- | srcs/phpmyadmin/doc/html/config.html | 6243 |
1 files changed, 6243 insertions, 0 deletions
diff --git a/srcs/phpmyadmin/doc/html/config.html b/srcs/phpmyadmin/doc/html/config.html new file mode 100644 index 0000000..f341736 --- /dev/null +++ b/srcs/phpmyadmin/doc/html/config.html @@ -0,0 +1,6243 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>Configuration — phpMyAdmin 5.0.1 documentation</title> + + <link rel="stylesheet" href="_static/classic.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: './', + VERSION: '5.0.1', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="copyright" title="Copyright" href="copyright.html" /> + <link rel="top" title="phpMyAdmin 5.0.1 documentation" href="index.html" /> + <link rel="next" title="User Guide" href="user.html" /> + <link rel="prev" title="Installation" href="setup.html" /> + </head> + <body role="document"> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="user.html" title="User Guide" + accesskey="N">next</a> |</li> + <li class="right" > + <a href="setup.html" title="Installation" + accesskey="P">previous</a> |</li> + <li class="nav-item nav-item-0"><a href="index.html">phpMyAdmin 5.0.1 documentation</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <div class="section" id="configuration"> +<span id="config"></span><span id="index-0"></span><h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h1> +<p>All configurable data is placed in <code class="file docutils literal"><span class="pre">config.inc.php</span></code> in phpMyAdmin’s +toplevel directory. If this file does not exist, please refer to the +<a class="reference internal" href="setup.html#setup"><span class="std std-ref">Installation</span></a> section to create one. This file only needs to contain the +parameters you want to change from their corresponding default value in +<code class="file docutils literal"><span class="pre">libraries/config.default.php</span></code> (this file is not inteded for changes).</p> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><a class="reference internal" href="#config-examples"><span class="std std-ref">Examples</span></a> for examples of configurations</p> +</div> +<p>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.</p> +<p>The parameters which relate to design (like colors) are placed in +<code class="file docutils literal"><span class="pre">themes/themename/layout.inc.php</span></code>. You might also want to create +<code class="file docutils literal"><span class="pre">config.footer.inc.php</span></code> and <code class="file docutils literal"><span class="pre">config.header.inc.php</span></code> files to add +your site specific code to be included on start and end of each page.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">Some distributions (eg. Debian or Ubuntu) store <code class="file docutils literal"><span class="pre">config.inc.php</span></code> in +<code class="docutils literal"><span class="pre">/etc/phpmyadmin</span></code> instead of within phpMyAdmin sources.</p> +</div> +<div class="admonition warning"> +<p class="first admonition-title">Warning</p> +<p class="last"><a class="reference internal" href="glossary.html#term-mac"><span class="xref std std-term">Mac</span></a> users should note that if you are on a version before +<a class="reference internal" href="glossary.html#term-mac-os-x"><span class="xref std std-term">Mac OS X</span></a>, PHP does not seem to +like <a class="reference internal" href="glossary.html#term-mac"><span class="xref std std-term">Mac</span></a> end of lines character (<code class="docutils literal"><span class="pre">\r</span></code>). So +ensure you choose the option that allows to use the *nix end of line +character (<code class="docutils literal"><span class="pre">\n</span></code>) in your text editor before saving a script you have +modified.</p> +</div> +<div class="section" id="basic-settings"> +<h2>Basic settings<a class="headerlink" href="#basic-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_PmaAbsoluteUri"> +<code class="descname">$cfg['PmaAbsoluteUri']</code><a class="headerlink" href="#cfg_PmaAbsoluteUri" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><code class="docutils literal"><span class="pre">''</span></code></td> +</tr> +</tbody> +</table> +<div class="versionchanged"> +<p><span class="versionmodified">Changed in version 4.6.5: </span>This setting was not available in phpMyAdmin 4.6.0 - 4.6.4.</p> +</div> +<p>Sets here the complete <a class="reference internal" href="glossary.html#term-url"><span class="xref std std-term">URL</span></a> (with full path) to your phpMyAdmin +installation’s directory. E.g. +<code class="docutils literal"><span class="pre">https://www.example.net/path_to_your_phpMyAdmin_directory/</span></code>. Note also +that the <a class="reference internal" href="glossary.html#term-url"><span class="xref std std-term">URL</span></a> on most of web servers are case sensitive (even on +Windows). Don’t forget the trailing slash at the end.</p> +<p>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.</p> +<p>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.</p> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><a class="reference internal" href="faq.html#faq1-40"><span class="std std-ref">1.40 When accessing phpMyAdmin via an Apache reverse proxy, cookie login does not work.</span></a>, <a class="reference internal" href="faq.html#faq2-5"><span class="std std-ref">2.5 Each time I want to insert or change a row or drop a database or a table, an error 404 (page not found) is displayed or, with HTTP or cookie authentication, I’m asked to log in again. What’s wrong?</span></a>, <a class="reference internal" href="faq.html#faq4-7"><span class="std std-ref">4.7 Authentication window is displayed more than once, why?</span></a>, <a class="reference internal" href="faq.html#faq5-16"><span class="std std-ref">5.16 With Internet Explorer, I get “Access is denied” Javascript errors. Or I cannot make phpMyAdmin work under Windows.</span></a></p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_PmaNoRelation_DisableWarning"> +<code class="descname">$cfg['PmaNoRelation_DisableWarning']</code><a class="headerlink" href="#cfg_PmaNoRelation_DisableWarning" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Starting with version 2.3.0 phpMyAdmin offers a lot of features to +work with master / foreign – tables (see <span class="target" id="index-1"></span><a class="reference internal" href="#cfg_Servers_pmadb"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['pmadb']</span></code></a>).</p> +<p>If you tried to set this +up and it does not work for you, have a look on the <span class="guilabel">Structure</span> 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.</p> +<p>If you do not want to use those features set this variable to <code class="docutils literal"><span class="pre">true</span></code> to +stop this message from appearing.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_AuthLog"> +<code class="descname">$cfg['AuthLog']</code><a class="headerlink" href="#cfg_AuthLog" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><code class="docutils literal"><span class="pre">'auto'</span></code></td> +</tr> +</tbody> +</table> +<div class="versionadded"> +<p><span class="versionmodified">New in version 4.8.0: </span>This is supported since phpMyAdmin 4.8.0.</p> +</div> +<p>Configure authentication logging destination. Failed (or all, depending on +<span class="target" id="index-2"></span><a class="reference internal" href="#cfg_AuthLogSuccess"><code class="xref config config-option docutils literal"><span class="pre">$cfg['AuthLogSuccess']</span></code></a>) authentication attempts will be +logged according to this directive:</p> +<dl class="docutils"> +<dt><code class="docutils literal"><span class="pre">auto</span></code></dt> +<dd>Let phpMyAdmin automatically choose between <code class="docutils literal"><span class="pre">syslog</span></code> and <code class="docutils literal"><span class="pre">php</span></code>.</dd> +<dt><code class="docutils literal"><span class="pre">syslog</span></code></dt> +<dd>Log using syslog, using AUTH facility, on most systems this ends up +in <code class="file docutils literal"><span class="pre">/var/log/auth.log</span></code>.</dd> +<dt><code class="docutils literal"><span class="pre">php</span></code></dt> +<dd>Log into PHP error log.</dd> +<dt><code class="docutils literal"><span class="pre">sapi</span></code></dt> +<dd>Log into PHP SAPI logging.</dd> +<dt><code class="docutils literal"><span class="pre">/path/to/file</span></code></dt> +<dd>Any other value is treated as a filename and log entries are written there.</dd> +</dl> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">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 <span class="target" id="index-3"></span><a class="reference internal" href="#cfg_TempDir"><code class="xref config config-option docutils literal"><span class="pre">$cfg['TempDir']</span></code></a>:</p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_AuthLogSuccess"> +<code class="descname">$cfg['AuthLogSuccess']</code><a class="headerlink" href="#cfg_AuthLogSuccess" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<div class="versionadded"> +<p><span class="versionmodified">New in version 4.8.0: </span>This is supported since phpMyAdmin 4.8.0.</p> +</div> +<p>Whether to log successful authentication attempts into +<span class="target" id="index-4"></span><a class="reference internal" href="#cfg_AuthLog"><code class="xref config config-option docutils literal"><span class="pre">$cfg['AuthLog']</span></code></a>.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SuhosinDisableWarning"> +<code class="descname">$cfg['SuhosinDisableWarning']</code><a class="headerlink" href="#cfg_SuhosinDisableWarning" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>A warning is displayed on the main page if Suhosin is detected.</p> +<p>You can set this parameter to <code class="docutils literal"><span class="pre">true</span></code> to stop this message from appearing.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_LoginCookieValidityDisableWarning"> +<code class="descname">$cfg['LoginCookieValidityDisableWarning']</code><a class="headerlink" href="#cfg_LoginCookieValidityDisableWarning" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>A warning is displayed on the main page if the PHP parameter +session.gc_maxlifetime is lower than cookie validity configured in phpMyAdmin.</p> +<p>You can set this parameter to <code class="docutils literal"><span class="pre">true</span></code> to stop this message from appearing.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ServerLibraryDifference_DisableWarning"> +<code class="descname">$cfg['ServerLibraryDifference_DisableWarning']</code><a class="headerlink" href="#cfg_ServerLibraryDifference_DisableWarning" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<div class="deprecated"> +<p><span class="versionmodified">Deprecated since version 4.7.0: </span>This setting was removed as the warning has been removed as well.</p> +</div> +<p>A warning is displayed on the main page if there is a difference +between the MySQL library and server version.</p> +<p>You can set this parameter to <code class="docutils literal"><span class="pre">true</span></code> to stop this message from appearing.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ReservedWordDisableWarning"> +<code class="descname">$cfg['ReservedWordDisableWarning']</code><a class="headerlink" href="#cfg_ReservedWordDisableWarning" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>This warning is displayed on the Structure page of a table if one or more +column names match with words which are MySQL reserved.</p> +<p>If you want to turn off this warning, you can set it to <code class="docutils literal"><span class="pre">true</span></code> and +warning will no longer be displayed.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_TranslationWarningThreshold"> +<code class="descname">$cfg['TranslationWarningThreshold']</code><a class="headerlink" href="#cfg_TranslationWarningThreshold" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">integer</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">80</td> +</tr> +</tbody> +</table> +<p>Show warning about incomplete translations on certain threshold.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_SendErrorReports"> +<code class="descname">$cfg['SendErrorReports']</code><a class="headerlink" href="#cfg_SendErrorReports" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><code class="docutils literal"><span class="pre">'ask'</span></code></td> +</tr> +</tbody> +</table> +<p>Sets the default behavior for JavaScript error reporting.</p> +<p>Whenever an error is detected in the JavaScript execution, an error report +may be sent to the phpMyAdmin team if the user agrees.</p> +<p>The default setting of <code class="docutils literal"><span class="pre">'ask'</span></code> will ask the user everytime there is a new +error report. However you can set this parameter to <code class="docutils literal"><span class="pre">'always'</span></code> to send error +reports without asking for confirmation or you can set it to <code class="docutils literal"><span class="pre">'never'</span></code> to +never send error reports.</p> +<p>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 <code class="docutils literal"><span class="pre">'never'</span></code> should be +set, and the <span class="target" id="index-5"></span><a class="reference internal" href="#cfg_UserprefsDisallow"><code class="xref config config-option docutils literal"><span class="pre">$cfg['UserprefsDisallow']</span></code></a> directive should +contain <code class="docutils literal"><span class="pre">'SendErrorReports'</span></code> in one of its array values.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_ConsoleEnterExecutes"> +<code class="descname">$cfg['ConsoleEnterExecutes']</code><a class="headerlink" href="#cfg_ConsoleEnterExecutes" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Setting this to <code class="docutils literal"><span class="pre">true</span></code> allows the user to execute queries by pressing Enter +instead of Ctrl+Enter. A new line can be inserted by pressing Shift + Enter.</p> +<p>The behaviour of the console can be temporarily changed using console’s +settings interface.</p> +</dd></dl> + +<dl class="option"> +<dt id="cfg_AllowThirdPartyFraming"> +<code class="descname">$cfg['AllowThirdPartyFraming']</code><a class="headerlink" href="#cfg_AllowThirdPartyFraming" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean|string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Setting this to <code class="docutils literal"><span class="pre">true</span></code> 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.</p> +</dd></dl> + +</div> +<div class="section" id="server-connection-settings"> +<h2>Server connection settings<a class="headerlink" href="#server-connection-settings" title="Permalink to this headline">¶</a></h2> +<dl class="option"> +<dt id="cfg_Servers"> +<code class="descname">$cfg['Servers']</code><a class="headerlink" href="#cfg_Servers" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">array</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">one server array with settings listed below</td> +</tr> +</tbody> +</table> +<p>Since version 1.4.2, phpMyAdmin supports the administration of multiple +MySQL servers. Therefore, a <span class="target" id="index-6"></span><a class="reference internal" href="#cfg_Servers"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers']</span></code></a>-array has been +added which contains the login information for the different servers. The +first <span class="target" id="index-7"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a> contains the hostname of +the first server, the second <span class="target" id="index-8"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a> +the hostname of the second server, etc. In +<code class="file docutils literal"><span class="pre">libraries/config.default.php</span></code>, there is only one section for server +definition, however you can put as many as you need in +<code class="file docutils literal"><span class="pre">config.inc.php</span></code>, copy that block or needed parts (you don’t have to +define all settings, just those you need to change).</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">The <span class="target" id="index-9"></span><a class="reference internal" href="#cfg_Servers"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers']</span></code></a> 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.</p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_host"> +<code class="descname">$cfg['Servers'][$i]['host']</code><a class="headerlink" href="#cfg_Servers_host" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><code class="docutils literal"><span class="pre">'localhost'</span></code></td> +</tr> +</tbody> +</table> +<p>The hostname or <a class="reference internal" href="glossary.html#term-ip"><span class="xref std std-term">IP</span></a> address of your $i-th MySQL-server. E.g. +<code class="docutils literal"><span class="pre">localhost</span></code>.</p> +<p>Possible values are:</p> +<ul class="simple"> +<li>hostname, e.g., <code class="docutils literal"><span class="pre">'localhost'</span></code> or <code class="docutils literal"><span class="pre">'mydb.example.org'</span></code></li> +<li>IP address, e.g., <code class="docutils literal"><span class="pre">'127.0.0.1'</span></code> or <code class="docutils literal"><span class="pre">'192.168.10.1'</span></code></li> +<li>IPv6 address, e.g. <code class="docutils literal"><span class="pre">2001:cdba:0000:0000:0000:0000:3257:9652</span></code></li> +<li>dot - <code class="docutils literal"><span class="pre">'.'</span></code>, i.e., use named pipes on windows systems</li> +<li>empty - <code class="docutils literal"><span class="pre">''</span></code>, disables this server</li> +</ul> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">The hostname <code class="docutils literal"><span class="pre">localhost</span></code> 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 <code class="docutils literal"><span class="pre">127.0.0.1</span></code> or <code class="docutils literal"><span class="pre">db.example.com</span></code>. You +can configure the path to the socket with +<span class="target" id="index-10"></span><a class="reference internal" href="#cfg_Servers_socket"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['socket']</span></code></a>.</p> +</div> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><span class="target" id="index-11"></span><a class="reference internal" href="#cfg_Servers_port"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['port']</span></code></a>, +<<a class="reference external" href="https://dev.mysql.com/doc/refman/5.7/en/connecting.html">https://dev.mysql.com/doc/refman/5.7/en/connecting.html</a>></p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_port"> +<code class="descname">$cfg['Servers'][$i]['port']</code><a class="headerlink" href="#cfg_Servers_port" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><code class="docutils literal"><span class="pre">''</span></code></td> +</tr> +</tbody> +</table> +<p>The port-number of your $i-th MySQL-server. Default is 3306 (leave +blank).</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">If you use <code class="docutils literal"><span class="pre">localhost</span></code> 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 <code class="docutils literal"><span class="pre">127.0.0.1</span></code> or the real hostname +in <span class="target" id="index-12"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a>.</p> +</div> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><span class="target" id="index-13"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a>, +<<a class="reference external" href="https://dev.mysql.com/doc/refman/5.7/en/connecting.html">https://dev.mysql.com/doc/refman/5.7/en/connecting.html</a>></p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_socket"> +<code class="descname">$cfg['Servers'][$i]['socket']</code><a class="headerlink" href="#cfg_Servers_socket" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body"><code class="docutils literal"><span class="pre">''</span></code></td> +</tr> +</tbody> +</table> +<p>The path to the socket to use. Leave blank for default. To determine +the correct socket, check your MySQL configuration or, using the +<strong class="command">mysql</strong> command–line client, issue the <code class="docutils literal"><span class="pre">status</span></code> command. Among the +resulting information displayed will be the socket used.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">This takes effect only if <span class="target" id="index-14"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a> is set +to <code class="docutils literal"><span class="pre">localhost</span></code>.</p> +</div> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><span class="target" id="index-15"></span><a class="reference internal" href="#cfg_Servers_host"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['host']</span></code></a>, +<<a class="reference external" href="https://dev.mysql.com/doc/refman/5.7/en/connecting.html">https://dev.mysql.com/doc/refman/5.7/en/connecting.html</a>></p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_ssl"> +<code class="descname">$cfg['Servers'][$i]['ssl']</code><a class="headerlink" href="#cfg_Servers_ssl" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">false</td> +</tr> +</tbody> +</table> +<p>Whether to enable SSL for the connection between phpMyAdmin and the MySQL +server to secure the connection.</p> +<p>When using the <code class="docutils literal"><span class="pre">'mysql'</span></code> extension, +none of the remaining <code class="docutils literal"><span class="pre">'ssl...'</span></code> configuration options apply.</p> +<p>We strongly recommend the <code class="docutils literal"><span class="pre">'mysqli'</span></code> extension when using this option.</p> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><a class="reference internal" href="setup.html#ssl"><span class="std std-ref">Using SSL for connection to database server</span></a>, +<a class="reference internal" href="#example-google-ssl"><span class="std std-ref">Google Cloud SQL with SSL</span></a>, +<span class="target" id="index-16"></span><a class="reference internal" href="#cfg_Servers_ssl_key"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['ssl_key']</span></code></a>, +<span class="target" id="index-17"></span><a class="reference internal" href="#cfg_Servers_ssl_cert"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['ssl_cert']</span></code></a>, +<span class="target" id="index-18"></span><a class="reference internal" href="#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['ssl_ca']</span></code></a>, +<span class="target" id="index-19"></span><a class="reference internal" href="#cfg_Servers_ssl_ca_path"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['ssl_ca_path']</span></code></a>, +<span class="target" id="index-20"></span><a class="reference internal" href="#cfg_Servers_ssl_ciphers"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['ssl_ciphers']</span></code></a>, +<span class="target" id="index-21"></span><a class="reference internal" href="#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></code></a></p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_ssl_key"> +<code class="descname">$cfg['Servers'][$i]['ssl_key']</code><a class="headerlink" href="#cfg_Servers_ssl_key" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">NULL</td> +</tr> +</tbody> +</table> +<p>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.</p> +<p>For example:</p> +<div class="highlight-php"><div class="highlight"><pre><span></span><span class="nv">$cfg</span><span class="p">[</span><span class="s1">'Servers'</span><span class="p">][</span><span class="nv">$i</span><span class="p">][</span><span class="s1">'ssl_key'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'/etc/mysql/server-key.pem'</span><span class="p">;</span> +</pre></div> +</div> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><a class="reference internal" href="setup.html#ssl"><span class="std std-ref">Using SSL for connection to database server</span></a>, +<a class="reference internal" href="#example-google-ssl"><span class="std std-ref">Google Cloud SQL with SSL</span></a>, +<span class="target" id="index-22"></span><a class="reference internal" href="#cfg_Servers_ssl"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['ssl']</span></code></a>, +<span class="target" id="index-23"></span><a class="reference internal" href="#cfg_Servers_ssl_cert"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['ssl_cert']</span></code></a>, +<span class="target" id="index-24"></span><a class="reference internal" href="#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['ssl_ca']</span></code></a>, +<span class="target" id="index-25"></span><a class="reference internal" href="#cfg_Servers_ssl_ca_path"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['ssl_ca_path']</span></code></a>, +<span class="target" id="index-26"></span><a class="reference internal" href="#cfg_Servers_ssl_ciphers"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['ssl_ciphers']</span></code></a>, +<span class="target" id="index-27"></span><a class="reference internal" href="#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal"><span class="pre">$cfg['Servers'][$i]['ssl_verify']</span></code></a></p> +</div> +</dd></dl> + +<dl class="option"> +<dt id="cfg_Servers_ssl_cert"> +<code class="descname">$cfg['Servers'][$i]['ssl_cert']</code><a class="headerlink" href="#cfg_Servers_ssl_cert" title="Permalink to this definition">¶</a></dt> +<dd><table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">string</td> +</tr> +<tr class="field-even field"><th class="field-name">Default value:</th><td class="field-body">NULL</td> +</tr> +</tbody> +</table> +<p>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.</p> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><a class="reference internal" href="setup.html#ssl"><span class="std std-ref">Using SSL for connection to database server</span></a>, |