File Manager

Editing File: /usr/share/doc/phpmyadmin/html/setup.html

<!DOCTYPE html>

<html>
 <head>
 <meta charset="utf-8" />
 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 <title>Installation &#8212; phpMyAdmin 5.0.4 documentation</title>
 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 <link rel="stylesheet" href="_static/classic.css" type="text/css" />
 
 <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
 <script src="_static/jquery.js"></script>
 <script src="_static/underscore.js"></script>
 <script 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="next" title="Configuration" href="config.html" />
 <link rel="prev" title="Requirements" href="require.html" /> 
 </head><body>
 <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="config.html" title="Configuration"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="require.html" title="Requirements"
 accesskey="P">previous</a> |</li>
 <li class="nav-item nav-item-0"><a href="index.html">phpMyAdmin 5.0.4 documentation</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Installation</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
phpMyAdmin does not apply any special security methods to the MySQL
database server. It is still the system administrator’s job to grant
permissions on the MySQL databases properly. phpMyAdmin’s Users
page can be used for this.
<div class="admonition warning">
Warning
<a class="reference internal" href="glossary.html#term-Mac">Mac</a> users should note that if you are on a version before
<a class="reference internal" href="glossary.html#term-Mac-OS-X">Mac OS X</a>, StuffIt unstuffs with <a class="reference internal" href="glossary.html#term-Mac">Mac</a> formats. So you’ll have
to resave as in BBEdit to Unix style ALL phpMyAdmin scripts before
uploading them to your server, as PHP seems not to like <a class="reference internal" href="glossary.html#term-Mac">Mac</a>-style
end of lines character (“<code class="docutils literal notranslate">\r</code>”).
</div>
<div class="section" id="linux-distributions">
<h2>Linux distributions<a class="headerlink" href="#linux-distributions" title="Permalink to this headline">¶</a></h2>
phpMyAdmin is included in most Linux distributions. It is recommended to use
distribution packages when possible - they usually provide integration to your
distribution and you will automatically get security updates from your distribution.
<div class="section" id="debian-and-ubuntu">
<h3>Debian and Ubuntu<a class="headerlink" href="#debian-and-ubuntu" title="Permalink to this headline">¶</a></h3>
Debian’s package repositories include a phpMyAdmin package, but be aware that
the configuration file is maintained in <code class="docutils literal notranslate">/etc/phpmyadmin</code> and may differ in
some ways from the official phpMyAdmin documentation. Specifically, it does:
<ul class="simple">
<li>Configuration of a web server (works for Apache and lighttpd).</li>
<li>Creating of <a class="reference internal" href="#linked-tables">phpMyAdmin configuration storage</a> using dbconfig-common.</li>
<li>Securing setup script, see <a class="reference internal" href="#debian-setup">Setup script on Debian, Ubuntu and derivatives</a>.</li>
</ul>
<div class="admonition seealso">
See also
More information can be found in <a class="reference external" href="https://salsa.debian.org/phpmyadmin-team/phpmyadmin/blob/master/debian/README.Debian">README.Debian</a>
(it is installed as <code class="file docutils literal notranslate">/usr/share/doc/phmyadmin/README.Debian</code> with the package).
</div>
</div>
<div class="section" id="opensuse">
<h3>OpenSUSE<a class="headerlink" href="#opensuse" title="Permalink to this headline">¶</a></h3>
OpenSUSE already comes with phpMyAdmin package, just install packages from
the <a class="reference external" href="https://software.opensuse.org/package/phpMyAdmin">openSUSE Build Service</a>.
</div>
<div class="section" id="gentoo">
<h3>Gentoo<a class="headerlink" href="#gentoo" title="Permalink to this headline">¶</a></h3>
Gentoo ships the phpMyAdmin package, both in a near-stock configuration as well
as in a <code class="docutils literal notranslate">webapp-config</code> configuration. Use <code class="docutils literal notranslate">emerge dev-db/phpmyadmin</code> to
install.
</div>
<div class="section" id="mandriva">
<h3>Mandriva<a class="headerlink" href="#mandriva" title="Permalink to this headline">¶</a></h3>
Mandriva ships the phpMyAdmin package in their <code class="docutils literal notranslate">contrib</code> branch and can be
installed via the usual Control Center.
</div>
<div class="section" id="fedora">
<h3>Fedora<a class="headerlink" href="#fedora" title="Permalink to this headline">¶</a></h3>
Fedora ships the phpMyAdmin package, but be aware that the configuration file
is maintained in <code class="docutils literal notranslate">/etc/phpMyAdmin/</code> and may differ in some ways from the
official phpMyAdmin documentation.
</div>
<div class="section" id="red-hat-enterprise-linux">
<h3>Red Hat Enterprise Linux<a class="headerlink" href="#red-hat-enterprise-linux" title="Permalink to this headline">¶</a></h3>
Red Hat Enterprise Linux itself and thus derivatives like CentOS don’t
ship phpMyAdmin, but the Fedora-driven repository
<a class="reference external" href="https://fedoraproject.org/wiki/EPEL">Extra Packages for Enterprise Linux (EPEL)</a>
is doing so, if it’s
<a class="reference external" href="https://fedoraproject.org/wiki/EPEL/FAQ#howtouse">enabled</a>.
But be aware that the configuration file is maintained in
<code class="docutils literal notranslate">/etc/phpMyAdmin/</code> and may differ in some ways from the
official phpMyAdmin documentation.
</div>
</div>
<div class="section" id="installing-on-windows">
<h2>Installing on Windows<a class="headerlink" href="#installing-on-windows" title="Permalink to this headline">¶</a></h2>
The easiest way to get phpMyAdmin on Windows is using third party products
which include phpMyAdmin together with a database and web server such as
<a class="reference external" href="https://www.apachefriends.org/index.html">XAMPP</a>.
You can find more of such options at <a class="reference external" href="https://en.wikipedia.org/wiki/List_of_AMP_packages">Wikipedia</a>.
</div>
<div class="section" id="installing-from-git">
<h2>Installing from Git<a class="headerlink" href="#installing-from-git" title="Permalink to this headline">¶</a></h2>
In order to install from Git, you’ll need a few supporting applications:
<ul class="simple">
<li><a class="reference external" href="https://git-scm.com/downloads">Git</a> to download the source, or you can download the most recent source directly from <a class="reference external" href="https://codeload.github.com/phpmyadmin/phpmyadmin/zip/master">Github</a></li>
<li><a class="reference external" href="https://getcomposer.org/download/">Composer</a></li>
<li><a class="reference external" href="https://nodejs.org/en/download/">Node.js</a> (version 8 or higher)</li>
<li><a class="reference external" href="https://classic.yarnpkg.com/en/docs/install">Yarn</a></li>
</ul>
You can clone current phpMyAdmin source from
<code class="docutils literal notranslate">https://github.com/phpmyadmin/phpmyadmin.git</code>:
<div class="highlight-sh notranslate"><div class="highlight"><pre>git clone https://github.com/phpmyadmin/phpmyadmin.git
</pre></div>
</div>
Additionally you need to install dependencies using <a class="reference external" href="https://getcomposer.org">Composer</a>:
<div class="highlight-sh notranslate"><div class="highlight"><pre>composer update
</pre></div>
</div>
If you do not intend to develop, you can skip the installation of developer tools
by invoking:
<div class="highlight-sh notranslate"><div class="highlight"><pre>composer update --no-dev
</pre></div>
</div>
Finally, you’ll need to use <a class="reference external" href="https://classic.yarnpkg.com/en/docs/install">Yarn</a> to install some JavaScript dependencies:
<div class="highlight-sh notranslate"><div class="highlight"><pre>yarn install --production
</pre></div>
</div>
</div>
<div class="section" id="installing-using-composer">
<h2>Installing using Composer<a class="headerlink" href="#installing-using-composer" title="Permalink to this headline">¶</a></h2>
You can install phpMyAdmin using the <a class="reference external" href="https://getcomposer.org/">Composer tool</a>, since 4.7.0 the releases
are automatically mirrored to the default <a class="reference external" href="https://packagist.org/">Packagist</a> repository.
<div class="admonition note">
Note
The content of the Composer repository is automatically generated
separately from the releases, so the content doesn’t have to be
100% same as when you download the tarball. There should be no
functional differences though.
</div>
To install phpMyAdmin simply run:
<div class="highlight-sh notranslate"><div class="highlight"><pre>composer create-project phpmyadmin/phpmyadmin
</pre></div>
</div>
Alternatively you can use our own composer repository, which contains
the release tarballs and is available at
&lt;<a class="reference external" href="https://www.phpmyadmin.net/packages.json">https://www.phpmyadmin.net/packages.json</a>&gt;:
<div class="highlight-sh notranslate"><div class="highlight"><pre>composer create-project phpmyadmin/phpmyadmin --repository-url=https://www.phpmyadmin.net/packages.json --no-dev
</pre></div>
</div>
</div>
<div class="section" id="installing-using-docker">
<h2>Installing using Docker<a class="headerlink" href="#installing-using-docker" title="Permalink to this headline">¶</a></h2>
phpMyAdmin comes with a <a class="reference external" href="https://hub.docker.com/_/phpmyadmin">Docker official image</a>, which you can easily deploy. You can
download it using:
<div class="highlight-sh notranslate"><div class="highlight"><pre>docker pull phpmyadmin
</pre></div>
</div>
The phpMyAdmin server will listen on port 80. It supports several ways of
configuring the link to the database server, either by Docker’s link feature
by linking your database container to <code class="docutils literal notranslate">db</code> for phpMyAdmin (by specifying
<code class="docutils literal notranslate">--link your_db_host:db</code>) or by environment variables (in this case it’s up
to you to set up networking in Docker to allow the phpMyAdmin container to access
the database container over the network).
<div class="section" id="docker-environment-variables">
<h3>Docker environment variables<a class="headerlink" href="#docker-environment-variables" title="Permalink to this headline">¶</a></h3>
You can configure several phpMyAdmin features using environment variables:
<dl class="std envvar">
<dt id="envvar-PMA_ARBITRARY">
<code class="sig-name descname">PMA_ARBITRARY</code><a class="headerlink" href="#envvar-PMA_ARBITRARY" title="Permalink to this definition">¶</a></dt>
<dd>Allows you to enter a database server hostname on login form.
<div class="admonition seealso">
See also
<a class="reference internal" href="config.html#cfg_AllowArbitraryServer"><code class="xref config config-option docutils literal notranslate">$cfg['AllowArbitraryServer']</code></a>
</div>
</dd></dl>

<dl class="std envvar">
<dt id="envvar-PMA_HOST">
<code class="sig-name descname">PMA_HOST</code><a class="headerlink" href="#envvar-PMA_HOST" title="Permalink to this definition">¶</a></dt>
<dd>Hostname or IP address of the database server to use.
<div class="admonition seealso">
See also
<a class="reference internal" href="config.html#cfg_Servers_host"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['host']</code></a>
</div>
</dd></dl>

<dl class="std envvar">
<dt id="envvar-PMA_HOSTS">
<code class="sig-name descname">PMA_HOSTS</code><a class="headerlink" href="#envvar-PMA_HOSTS" title="Permalink to this definition">¶</a></dt>
<dd>Comma-separated hostnames or IP addresses of the database servers to use.
<div class="admonition note">
Note
Used only if <a class="reference internal" href="#envvar-PMA_HOST"><code class="xref std std-envvar docutils literal notranslate">PMA_HOST</code></a> is empty.
</div>
</dd></dl>

<dl class="std envvar">
<dt id="envvar-PMA_VERBOSE">
<code class="sig-name descname">PMA_VERBOSE</code><a class="headerlink" href="#envvar-PMA_VERBOSE" title="Permalink to this definition">¶</a></dt>
<dd>Verbose name of the database server.
<div class="admonition seealso">
See also
<a class="reference internal" href="config.html#cfg_Servers_verbose"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['verbose']</code></a>
</div>
</dd></dl>

<dl class="std envvar">
<dt id="envvar-PMA_VERBOSES">
<code class="sig-name descname">PMA_VERBOSES</code><a class="headerlink" href="#envvar-PMA_VERBOSES" title="Permalink to this definition">¶</a></dt>
<dd>Comma-separated verbose name of the database servers.
<div class="admonition note">
Note
Used only if <a class="reference internal" href="#envvar-PMA_VERBOSE"><code class="xref std std-envvar docutils literal notranslate">PMA_VERBOSE</code></a> is empty.
</div>
</dd></dl>

<dl class="std envvar">
<dt id="envvar-PMA_USER">
<code class="sig-name descname">PMA_USER</code><a class="headerlink" href="#envvar-PMA_USER" title="Permalink to this definition">¶</a></dt>
<dd>User name to use for <a class="reference internal" href="#auth-config">Config authentication mode</a>.
</dd></dl>

<dl class="std envvar">
<dt id="envvar-PMA_PASSWORD">
<code class="sig-name descname">PMA_PASSWORD</code><a class="headerlink" href="#envvar-PMA_PASSWORD" title="Permalink to this definition">¶</a></dt>
<dd>Password to use for <a class="reference internal" href="#auth-config">Config authentication mode</a>.
</dd></dl>

<dl class="std envvar">
<dt id="envvar-PMA_PORT">
<code class="sig-name descname">PMA_PORT</code><a class="headerlink" href="#envvar-PMA_PORT" title="Permalink to this definition">¶</a></dt>
<dd>Port of the database server to use.
</dd></dl>

<dl class="std envvar">
<dt id="envvar-PMA_PORTS">
<code class="sig-name descname">PMA_PORTS</code><a class="headerlink" href="#envvar-PMA_PORTS" title="Permalink to this definition">¶</a></dt>
<dd>Comma-separated ports of the database server to use.
<div class="admonition note">
Note
Used only if <a class="reference internal" href="#envvar-PMA_PORT"><code class="xref std std-envvar docutils literal notranslate">PMA_PORT</code></a> is empty.
</div>
</dd></dl>

<dl class="std envvar">
<dt id="envvar-PMA_ABSOLUTE_URI">
<code class="sig-name descname">PMA_ABSOLUTE_URI</code><a class="headerlink" href="#envvar-PMA_ABSOLUTE_URI" title="Permalink to this definition">¶</a></dt>
<dd>The fully-qualified path (<code class="docutils literal notranslate">https://pma.example.net/</code>) where the reverse
proxy makes phpMyAdmin available.
<div class="admonition seealso">
See also
<a class="reference internal" href="config.html#cfg_PmaAbsoluteUri"><code class="xref config config-option docutils literal notranslate">$cfg['PmaAbsoluteUri']</code></a>
</div>
</dd></dl>

<dl class="std envvar">
<dt id="envvar-HIDE_PHP_VERSION">
<code class="sig-name descname">HIDE_PHP_VERSION</code><a class="headerlink" href="#envvar-HIDE_PHP_VERSION" title="Permalink to this definition">¶</a></dt>
<dd>If defined, this option will hide the PHP version (<cite>expose_php = Off</cite>).
Set to any value (such as <cite>HIDE_PHP_VERSION=true</cite>).
</dd></dl>

<dl class="std envvar">
<dt id="envvar-UPLOAD_LIMIT">
<code class="sig-name descname">UPLOAD_LIMIT</code><a class="headerlink" href="#envvar-UPLOAD_LIMIT" title="Permalink to this definition">¶</a></dt>
<dd>If set, this option will override the default value for apache and php-fpm (this will change <code class="docutils literal notranslate">upload_max_filesize</code> and <code class="docutils literal notranslate">post_max_size</code> values).
<div class="admonition note">
Note
Format as <cite>[0-9+](K,M,G)</cite> default value is <cite>2048K</cite>
</div>
</dd></dl>

<dl class="std envvar">
<dt id="envvar-PMA_CONFIG_BASE64">
<code class="sig-name descname">PMA_CONFIG_BASE64</code><a class="headerlink" href="#envvar-PMA_CONFIG_BASE64" title="Permalink to this definition">¶</a></dt>
<dd>If set, this option will override the default <cite>config.inc.php</cite> with the base64 decoded contents of the variable.
</dd></dl>

<dl class="std envvar">
<dt id="envvar-PMA_USER_CONFIG_BASE64">
<code class="sig-name descname">PMA_USER_CONFIG_BASE64</code><a class="headerlink" href="#envvar-PMA_USER_CONFIG_BASE64" title="Permalink to this definition">¶</a></dt>
<dd>If set, this option will override the default <cite>config.user.inc.php</cite> with the base64 decoded contents of the variable.
</dd></dl>

By default, <a class="reference internal" href="#cookie">Cookie authentication mode</a> is used, but if <a class="reference internal" href="#envvar-PMA_USER"><code class="xref std std-envvar docutils literal notranslate">PMA_USER</code></a> and
<a class="reference internal" href="#envvar-PMA_PASSWORD"><code class="xref std std-envvar docutils literal notranslate">PMA_PASSWORD</code></a> are set, it is switched to <a class="reference internal" href="#auth-config">Config authentication mode</a>.
<div class="admonition note">
Note
The credentials you need to log in are stored in the MySQL server, in case
of Docker image, there are various ways to set it (for example
<code class="samp docutils literal notranslate">MYSQL_ROOT_PASSWORD</code> when starting the MySQL container). Please check
documentation for <a class="reference external" href="https://hub.docker.com/_/mariadb">MariaDB container</a>
or <a class="reference external" href="https://hub.docker.com/_/mysql">MySQL container</a>.
</div>
</div>
<div class="section" id="customizing-configuration">
<h3>Customizing configuration<a class="headerlink" href="#customizing-configuration" title="Permalink to this headline">¶</a></h3>
Additionally configuration can be tweaked by <code class="file docutils literal notranslate">/etc/phpmyadmin/config.user.inc.php</code>. If
this file exists, it will be loaded after configuration is generated from above
environment variables, so you can override any configuration variable. This
configuration can be added as a volume when invoking docker using
<cite>-v /some/local/directory/config.user.inc.php:/etc/phpmyadmin/config.user.inc.php</cite> parameters.
Note that the supplied configuration file is applied after <a class="reference internal" href="#docker-vars">Docker environment variables</a>,
but you can override any of the values.
For example to change the default behavior of CSV export you can use the following
configuration file:
<div class="highlight-php notranslate"><div class="highlight"><pre>&lt;?php
$cfg[&#39;Export&#39;][&#39;csv_columns&#39;] = true;
</pre></div>
</div>
You can also use it to define server configuration instead of using the
environment variables listed in <a class="reference internal" href="#docker-vars">Docker environment variables</a>:
<div class="highlight-php notranslate"><div class="highlight"><pre>&lt;?php
/* Override Servers array */
$cfg[&#39;Servers&#39;] = [
 1 =&gt; [
 &#39;auth_type&#39; =&gt; &#39;cookie&#39;,
 &#39;host&#39; =&gt; &#39;mydb1&#39;,
 &#39;port&#39; =&gt; 3306,
 &#39;verbose&#39; =&gt; &#39;Verbose name 1&#39;,
 ],
 2 =&gt; [
 &#39;auth_type&#39; =&gt; &#39;cookie&#39;,
 &#39;host&#39; =&gt; &#39;mydb2&#39;,
 &#39;port&#39; =&gt; 3306,
 &#39;verbose&#39; =&gt; &#39;Verbose name 2&#39;,
 ],
];
</pre></div>
</div>
<div class="admonition seealso">
See also
See <a class="reference internal" href="config.html#config">Configuration</a> for detailed description of configuration options.
</div>
</div>
<div class="section" id="docker-volumes">
<h3>Docker Volumes<a class="headerlink" href="#docker-volumes" title="Permalink to this headline">¶</a></h3>
You can use the following volumes to customize image behavior:
<code class="file docutils literal notranslate">/etc/phpmyadmin/config.user.inc.php</code>
<blockquote>
<div>Can be used for additional settings, see the previous chapter for more details.
</div></blockquote>
<code class="file docutils literal notranslate">/sessions/</code>
<blockquote>
<div>Directory where PHP sessions are stored. You might want to share this
for example when using <a class="reference internal" href="#auth-signon">Signon authentication mode</a>.
</div></blockquote>
<code class="file docutils literal notranslate">/www/themes/</code>
<blockquote>
<div>Directory where phpMyAdmin looks for themes. By default only those shipped
with phpMyAdmin are included, but you can include additional phpMyAdmin
themes (see <a class="reference internal" href="themes.html#themes">Custom Themes</a>) by using Docker volumes.
</div></blockquote>
</div>
<div class="section" id="docker-examples">
<h3>Docker Examples<a class="headerlink" href="#docker-examples" title="Permalink to this headline">¶</a></h3>
To connect phpMyAdmin to a given server use:
<div class="highlight-sh notranslate"><div class="highlight"><pre>docker run --name myadmin -d -e PMA_HOST=dbhost -p 8080:80 phpmyadmin/phpmyadmin
</pre></div>
</div>
To connect phpMyAdmin to more servers use:
<div class="highlight-sh notranslate"><div class="highlight"><pre>docker run --name myadmin -d -e PMA_HOSTS=dbhost1,dbhost2,dbhost3 -p 8080:80 phpmyadmin/phpmyadmin
</pre></div>
</div>
To use arbitrary server option:
<div class="highlight-sh notranslate"><div class="highlight"><pre>docker run --name myadmin -d --link mysql_db_server:db -p 8080:80 -e PMA_ARBITRARY=1 phpmyadmin/phpmyadmin
</pre></div>
</div>
You can also link the database container using Docker:
<div class="highlight-sh notranslate"><div class="highlight"><pre>docker run --name phpmyadmin -d --link mysql_db_server:db -p 8080:80 phpmyadmin/phpmyadmin
</pre></div>
</div>
Running with additional configuration:
<div class="highlight-sh notranslate"><div class="highlight"><pre>docker run --name phpmyadmin -d --link mysql_db_server:db -p 8080:80 -v /some/local/directory/config.user.inc.php:/etc/phpmyadmin/config.user.inc.php phpmyadmin/phpmyadmin
</pre></div>
</div>
Running with additional themes:
<div class="highlight-sh notranslate"><div class="highlight"><pre>docker run --name phpmyadmin -d --link mysql_db_server:db -p 8080:80 -v /custom/phpmyadmin/theme/:/www/themes/theme/ phpmyadmin/phpmyadmin
</pre></div>
</div>
</div>
<div class="section" id="using-docker-compose">
<h3>Using docker-compose<a class="headerlink" href="#using-docker-compose" title="Permalink to this headline">¶</a></h3>
Alternatively, you can also use docker-compose with the docker-compose.yml from
&lt;<a class="reference external" href="https://github.com/phpmyadmin/docker">https://github.com/phpmyadmin/docker</a>&gt;. This will run phpMyAdmin with an
arbitrary server - allowing you to specify MySQL/MariaDB server on the login page.
<div class="highlight-sh notranslate"><div class="highlight"><pre>docker-compose up -d
</pre></div>
</div>
</div>
<div class="section" id="customizing-configuration-file-using-docker-compose">
<h3>Customizing configuration file using docker-compose<a class="headerlink" href="#customizing-configuration-file-using-docker-compose" title="Permalink to this headline">¶</a></h3>
You can use an external file to customize phpMyAdmin configuration and pass it
using the volumes directive:
<div class="highlight-yaml notranslate"><div class="highlight"><pre>phpmyadmin:
 image: phpmyadmin/phpmyadmin
 container_name: phpmyadmin
 environment:
 - PMA_ARBITRARY=1
 restart: always
 ports:
 - 8080:80
 volumes:
 - /sessions
 - ~/docker/phpmyadmin/config.user.inc.php:/etc/phpmyadmin/config.user.inc.php
 - /custom/phpmyadmin/theme/:/www/themes/theme/
</pre></div>
</div>
<div class="admonition seealso">
See also
<a class="reference internal" href="#docker-custom">Customizing configuration</a>
</div>
</div>
<div class="section" id="running-behind-haproxy-in-a-subdirectory">
<h3>Running behind haproxy in a subdirectory<a class="headerlink" href="#running-behind-haproxy-in-a-subdirectory" title="Permalink to this headline">¶</a></h3>
When you want to expose phpMyAdmin running in a Docker container in a
subdirectory, you need to rewrite the request path in the server proxying the
requests.
For example, using haproxy it can be done as:
<div class="highlight-text notranslate"><div class="highlight"><pre>frontend http
 bind *:80
 option forwardfor
 option http-server-close

### NETWORK restriction
    acl LOCALNET  src 10.0.0.0/8 192.168.0.0/16 172.16.0.0/12

# /phpmyadmin
    acl phpmyadmin  path_dir /phpmyadmin
    use_backend phpmyadmin if phpmyadmin LOCALNET

backend phpmyadmin
    mode http

reqirep  ^(GET|POST|HEAD)\ /phpmyadmin/(.*)     \1\ /\2

# phpMyAdmin container IP
 server localhost 172.30.21.21:80
</pre></div>
</div>
When using traefik, something like following should work:
<div class="highlight-text notranslate"><div class="highlight"><pre>defaultEntryPoints = [&quot;http&quot;]
[entryPoints]
 [entryPoints.http]
 address = &quot;:80&quot;
 [entryPoints.http.redirect]
 regex = &quot;(http:\\/\\/[^\\/]+\\/([^\\?\\.]+)[^\\/])$&quot;
 replacement = &quot;$1/&quot;

[backends]
  [backends.myadmin]
    [backends.myadmin.servers.myadmin]
    url=&quot;http://internal.address.to.pma&quot;

[frontends]
 [frontends.myadmin]
 backend = &quot;myadmin&quot;
 passHostHeader = true
 [frontends.myadmin.routes.default]
 rule=&quot;PathPrefixStrip:/phpmyadmin/;AddPrefix:/&quot;
</pre></div>
</div>
You then should specify <a class="reference internal" href="#envvar-PMA_ABSOLUTE_URI"><code class="xref std std-envvar docutils literal notranslate">PMA_ABSOLUTE_URI</code></a> in the docker-compose
configuration:
<div class="highlight-yaml notranslate"><div class="highlight"><pre>version: &#39;2&#39;

services:
 phpmyadmin:
 restart: always
 image: phpmyadmin/phpmyadmin
 container_name: phpmyadmin
 hostname: phpmyadmin
 domainname: example.com
 ports:
 - 8000:80
 environment:
 - PMA_HOSTS=172.26.36.7,172.26.36.8,172.26.36.9,172.26.36.10
 - PMA_VERBOSES=production-db1,production-db2,dev-db1,dev-db2
 - PMA_USER=root
 - PMA_PASSWORD=
 - PMA_ABSOLUTE_URI=http://example.com/phpmyadmin/
</pre></div>
</div>
</div>
</div>
<div class="section" id="quick-install">
<h2>Quick Install<a class="headerlink" href="#quick-install" title="Permalink to this headline">¶</a></h2>
<ol class="arabic simple">
<li>Choose an appropriate distribution kit from the phpmyadmin.net
Downloads page. Some kits contain only the English messages, others
contain all languages. We’ll assume you chose a kit whose name
looks like <code class="docutils literal notranslate">phpMyAdmin-x.x.x -all-languages.tar.gz</code>.</li>
<li>Ensure you have downloaded a genuine archive, see <a class="reference internal" href="#verify">Verifying phpMyAdmin releases</a>.</li>
<li>Untar or unzip the distribution (be sure to unzip the subdirectories):
<code class="docutils literal notranslate">tar -xzvf phpMyAdmin_x.x.x-all-languages.tar.gz</code> in your
webserver’s document root. If you don’t have direct access to your
document root, put the files in a directory on your local machine,
and, after step 4, transfer the directory on your web server using,
for example, FTP.</li>
<li>Ensure that all the scripts have the appropriate owner (if PHP is
running in safe mode, having some scripts with an owner different from
the owner of other scripts will be a problem). See <a class="reference internal" href="faq.html#faq4-2">4.2 What’s the preferred way of making phpMyAdmin secure against evil access?</a> and
<a class="reference internal" href="faq.html#faq1-26">1.26 I just installed phpMyAdmin in my document root of IIS but I get the error “No input file specified” when trying to run phpMyAdmin.</a> for suggestions.</li>
<li>Now you must configure your installation. There are two methods that
can be used. Traditionally, users have hand-edited a copy of
<code class="file docutils literal notranslate">config.inc.php</code>, but now a wizard-style setup script is provided
for those who prefer a graphical installation. Creating a
<code class="file docutils literal notranslate">config.inc.php</code> is still a quick way to get started and needed for
some advanced features.</li>
</ol>
<div class="section" id="manually-creating-the-file">
<h3>Manually creating the file<a class="headerlink" href="#manually-creating-the-file" title="Permalink to this headline">¶</a></h3>
To manually create the file, simply use your text editor to create the
file <code class="file docutils literal notranslate">config.inc.php</code> (you can copy <code class="file docutils literal notranslate">config.sample.inc.php</code> to get
a minimal configuration file) in the main (top-level) phpMyAdmin
directory (the one that contains <code class="file docutils literal notranslate">index.php</code>). phpMyAdmin first
loads <code class="file docutils literal notranslate">libraries/config.default.php</code> and then overrides those values
with anything found in <code class="file docutils literal notranslate">config.inc.php</code>. If the default value is
okay for a particular setting, there is no need to include it in
<code class="file docutils literal notranslate">config.inc.php</code>. You’ll probably need only a few directives to get going; a
simple configuration may look like this:
<div class="highlight-xml+php notranslate"><div class="highlight"><pre>&lt;?php
// use here a value of your choice at least 32 chars long
$cfg[&#39;blowfish_secret&#39;] = &#39;1{dd0`&lt;Q),5XP_:R9UK%%8\&quot;EEcyH#{o&#39;;

$i=0;
$i++;
$cfg[&#39;Servers&#39;][$i][&#39;user&#39;] = &#39;root&#39;;
$cfg[&#39;Servers&#39;][$i][&#39;password&#39;] = &#39;changeme&#39;; // use here your password
$cfg[&#39;Servers&#39;][$i][&#39;auth_type&#39;] = &#39;config&#39;;
</pre></div>
</div>
<div class="admonition warning">
Warning
Storing passwords in the configuration is insecure as anybody can then
manipulate your database.
</div>
For a full explanation of possible configuration values, see the
<a class="reference internal" href="config.html#config">Configuration</a> of this document.
</div>
<div class="section" id="using-the-setup-script">
<h3>Using the Setup script<a class="headerlink" href="#using-the-setup-script" title="Permalink to this headline">¶</a></h3>
Instead of manually editing <code class="file docutils literal notranslate">config.inc.php</code>, you can use phpMyAdmin’s
setup feature. The file can be generated using the setup and you can download it
for upload to the server.
Next, open your browser and visit the location where you installed phpMyAdmin,
with the <code class="docutils literal notranslate">/setup</code> suffix. The changes are not saved to the server, you need to
use the Download button to save them to your computer and then upload
to the server.
Now the file is ready to be used. You can choose to review or edit the
file with your favorite editor, if you prefer to set some advanced
options that the setup script does not provide.
<ol class="arabic simple">
<li>If you are using the <code class="docutils literal notranslate">auth_type</code> “config”, it is suggested that you
protect the phpMyAdmin installation directory because using config
does not require a user to enter a password to access the phpMyAdmin
installation. Use of an alternate authentication method is
recommended, for example with HTTP–AUTH in a <a class="reference internal" href="glossary.html#term-.htaccess">.htaccess</a> file or switch to using
<code class="docutils literal notranslate">auth_type</code> cookie or http. See the <a class="reference internal" href="faq.html#faqmultiuser">ISPs, multi-user installations</a>
for additional information, especially <a class="reference internal" href="faq.html#faq4-4">4.4 phpMyAdmin always gives “Access denied” when using HTTP authentication.</a>.</li>
<li>Open the main phpMyAdmin directory in your browser.
phpMyAdmin should now display a welcome screen and your databases, or
a login dialog if using <a class="reference internal" href="glossary.html#term-HTTP">HTTP</a> or
cookie authentication mode.</li>
</ol>
<div class="section" id="setup-script-on-debian-ubuntu-and-derivatives">
<h4>Setup script on Debian, Ubuntu and derivatives<a class="headerlink" href="#setup-script-on-debian-ubuntu-and-derivatives" title="Permalink to this headline">¶</a></h4>
Debian and Ubuntu have changed the way in which the setup script is enabled and disabled, in a way
that single command has to be executed for either of these.
To allow editing configuration invoke:
<div class="highlight-sh notranslate"><div class="highlight"><pre>/usr/sbin/pma-configure
</pre></div>
</div>
To block editing configuration invoke:
<div class="highlight-sh notranslate"><div class="highlight"><pre>/usr/sbin/pma-secure
</pre></div>
</div>
</div>
<div class="section" id="setup-script-on-opensuse">
<h4>Setup script on openSUSE<a class="headerlink" href="#setup-script-on-opensuse" title="Permalink to this headline">¶</a></h4>
Some openSUSE releases do not include setup script in the package. In case you
want to generate configuration on these you can either download original
package from &lt;<a class="reference external" href="https://www.phpmyadmin.net/">https://www.phpmyadmin.net/</a>&gt; or use setup script on our demo
server: &lt;<a class="reference external" href="https://demo.phpmyadmin.net/master/setup/">https://demo.phpmyadmin.net/master/setup/</a>&gt;.
</div>
</div>
</div>
<div class="section" id="verifying-phpmyadmin-releases">
<h2>Verifying phpMyAdmin releases<a class="headerlink" href="#verifying-phpmyadmin-releases" title="Permalink to this headline">¶</a></h2>
Since July 2015 all phpMyAdmin releases are cryptographically signed by the
releasing developer, who through January 2016 was Marc Delisle. His key id is
0xFEFC65D181AF644A, his PGP fingerprint is:
<div class="highlight-console notranslate"><div class="highlight"><pre>436F F188 4B1A 0C3F DCBF 0D79 FEFC 65D1 81AF 644A
</pre></div>
</div>
and you can get more identification information from &lt;<a class="reference external" href="https://keybase.io/lem9">https://keybase.io/lem9</a>&gt;.
Beginning in January 2016, the release manager is Isaac Bennetch. His key id is
0xCE752F178259BD92, and his PGP fingerprint is:
<div class="highlight-console notranslate"><div class="highlight"><pre>3D06 A59E CE73 0EB7 1B51 1C17 CE75 2F17 8259 BD92
</pre></div>
</div>
and you can get more identification information from &lt;<a class="reference external" href="https://keybase.io/ibennetch">https://keybase.io/ibennetch</a>&gt;.
Some additional downloads (for example themes) might be signed by Michal Čihař. His key id is
0x9C27B31342B7511D, and his PGP fingerprint is:
<div class="highlight-console notranslate"><div class="highlight"><pre>63CB 1DF1 EF12 CF2A C0EE 5A32 9C27 B313 42B7 511D
</pre></div>
</div>
and you can get more identification information from &lt;<a class="reference external" href="https://keybase.io/nijel">https://keybase.io/nijel</a>&gt;.
You should verify that the signature matches the archive you have downloaded.
This way you can be sure that you are using the same code that was released.
You should also verify the date of the signature to make sure that you
downloaded the latest version.
Each archive is accompanied by <code class="docutils literal notranslate">.asc</code> files which contain the PGP signature
for it. Once you have both of them in the same folder, you can verify the signature:
<div class="highlight-console notranslate"><div class="highlight"><pre>$ gpg --verify phpMyAdmin-4.5.4.1-all-languages.zip.asc
gpg: Signature made Fri 29 Jan 2016 08:59:37 AM EST using RSA key ID 8259BD92
gpg: Can&#39;t check signature: public key not found
</pre></div>
</div>
As you can see gpg complains that it does not know the public key. At this
point, you should do one of the following steps:
<ul class="simple">
<li>Download the keyring from <a class="reference external" href="https://files.phpmyadmin.net/phpmyadmin.keyring">our download server</a>, then import it with:</li>
</ul>
<div class="highlight-console notranslate"><div class="highlight"><pre>$ gpg --import phpmyadmin.keyring
</pre></div>
</div>
<ul class="simple">
<li>Download and import the key from one of the key servers:</li>
</ul>
<div class="highlight-console notranslate"><div class="highlight"><pre>$ gpg --keyserver hkp://pgp.mit.edu --recv-keys 3D06A59ECE730EB71B511C17CE752F178259BD92
gpg: requesting key 8259BD92 from hkp server pgp.mit.edu
gpg: key 8259BD92: public key &quot;Isaac Bennetch &lt;bennetch@gmail.com&gt;&quot; imported
gpg: no ultimately trusted keys found
gpg: Total number processed: 1
gpg: imported: 1 (RSA: 1)
</pre></div>
</div>
This will improve the situation a bit - at this point, you can verify that the
signature from the given key is correct but you still can not trust the name used
in the key:
<div class="highlight-console notranslate"><div class="highlight"><pre>$ gpg --verify phpMyAdmin-4.5.4.1-all-languages.zip.asc
gpg: Signature made Fri 29 Jan 2016 08:59:37 AM EST using RSA key ID 8259BD92
gpg: Good signature from &quot;Isaac Bennetch &lt;bennetch@gmail.com&gt;&quot;
gpg: aka &quot;Isaac Bennetch &lt;isaac@bennetch.org&gt;&quot;
gpg: WARNING: This key is not certified with a trusted signature!
gpg: There is no indication that the signature belongs to the owner.
Primary key fingerprint: 3D06 A59E CE73 0EB7 1B51 1C17 CE75 2F17 8259 BD92
</pre></div>
</div>
The problem here is that anybody could issue the key with this name. You need to
ensure that the key is actually owned by the mentioned person. The GNU Privacy
Handbook covers this topic in the chapter <a class="reference external" href="https://www.gnupg.org/gph/en/manual.html#AEN335">Validating other keys on your public
keyring</a>. The most reliable method is to meet the developer in person and
exchange key fingerprints, however, you can also rely on the web of trust. This way
you can trust the key transitively though signatures of others, who have met
the developer in person.
Once the key is trusted, the warning will not occur:
<div class="highlight-console notranslate"><div class="highlight"><pre>$ gpg --verify phpMyAdmin-4.5.4.1-all-languages.zip.asc
gpg: Signature made Fri 29 Jan 2016 08:59:37 AM EST using RSA key ID 8259BD92
gpg: Good signature from &quot;Isaac Bennetch &lt;bennetch@gmail.com&gt;&quot; [full]
</pre></div>
</div>
Should the signature be invalid (the archive has been changed), you would get a
clear error regardless of the fact that the key is trusted or not:
<div class="highlight-console notranslate"><div class="highlight"><pre>$ gpg --verify phpMyAdmin-4.5.4.1-all-languages.zip.asc
gpg: Signature made Fri 29 Jan 2016 08:59:37 AM EST using RSA key ID 8259BD92
gpg: BAD signature from &quot;Isaac Bennetch &lt;bennetch@gmail.com&gt;&quot; [unknown]
</pre></div>
</div>
</div>
<div class="section" id="phpmyadmin-configuration-storage">
<h2>phpMyAdmin configuration storage<a class="headerlink" href="#phpmyadmin-configuration-storage" title="Permalink to this headline">¶</a></h2>
<div class="versionchanged">
Changed in version 3.4.0: Prior to phpMyAdmin 3.4.0 this was called Linked Tables Infrastructure, but
the name was changed due to the extended scope of the storage.
</div>
For a whole set of additional features (<a class="reference internal" href="bookmarks.html#bookmarks">Bookmarks</a>, comments, <a class="reference internal" href="glossary.html#term-SQL">SQL</a>-history,
tracking mechanism, <a class="reference internal" href="glossary.html#term-PDF">PDF</a>-generation, <a class="reference internal" href="transformations.html#transformations">Transformations</a>, <a class="reference internal" href="relations.html#relations">Relations</a>
etc.) you need to create a set of special tables. Those tables can be located
in your own database, or in a central database for a multi-user installation
(this database would then be accessed by the controluser, so no other user
should have rights to it).
<div class="section" id="zero-configuration">
<h3>Zero configuration<a class="headerlink" href="#zero-configuration" title="Permalink to this headline">¶</a></h3>
In many cases, this database structure can be automatically created and
configured. This is called “Zero Configuration” mode and can be particularly
useful in shared hosting situations. “Zeroconf” mode is on by default, to
disable set <a class="reference internal" href="config.html#cfg_ZeroConf"><code class="xref config config-option docutils literal notranslate">$cfg['ZeroConf']</code></a> to false.
The following three scenarios are covered by the Zero Configuration mode:
<ul class="simple">
<li>When entering a database where the configuration storage tables are not
present, phpMyAdmin offers to create them from the Operations tab.</li>
<li>When entering a database where the tables do already exist, the software
automatically detects this and begins using them. This is the most common
situation; after the tables are initially created automatically they are
continually used without disturbing the user; this is also most useful on
shared hosting where the user is not able to edit <code class="file docutils literal notranslate">config.inc.php</code> and
usually the user only has access to one database.</li>
<li>When having access to multiple databases, if the user first enters the
database containing the configuration storage tables then switches to
another database,
phpMyAdmin continues to use the tables from the first database; the user is
not prompted to create more tables in the new database.</li>
</ul>
</div>
<div class="section" id="manual-configuration">
<h3>Manual configuration<a class="headerlink" href="#manual-configuration" title="Permalink to this headline">¶</a></h3>
Please look at your <code class="docutils literal notranslate">./sql/</code> directory, where you should find a
file called create_tables.sql. (If you are using a Windows server,
pay special attention to <a class="reference internal" href="faq.html#faq1-23">1.23 I’m running MySQL on a Win32 machine. Each time I create a new table the table and column names are changed to lowercase!</a>).
If you already had this infrastructure and:
<ul class="simple">
<li>upgraded to MySQL 4.1.2 or newer, please use
<code class="file docutils literal notranslate">sql/upgrade_tables_mysql_4_1_2+.sql</code>.</li>
<li>upgraded to phpMyAdmin 4.3.0 or newer from 2.5.0 or newer (&lt;= 4.2.x),
please use <code class="file docutils literal notranslate">sql/upgrade_column_info_4_3_0+.sql</code>.</li>
<li>upgraded to phpMyAdmin 4.7.0 or newer from 4.3.0 or newer,
please use <code class="file docutils literal notranslate">sql/upgrade_tables_4_7_0+.sql</code>.</li>
</ul>
and then create new tables by importing <code class="file docutils literal notranslate">sql/create_tables.sql</code>.
You can use your phpMyAdmin to create the tables for you. Please be
aware that you may need special (administrator) privileges to create
the database and tables, and that the script may need some tuning,
depending on the database name.
After having imported the <code class="file docutils literal notranslate">sql/create_tables.sql</code> file, you
should specify the table names in your <code class="file docutils literal notranslate">config.inc.php</code> file. The
directives used for that can be found in the <a class="reference internal" href="config.html#config">Configuration</a>.
You will also need to have a controluser
(<a class="reference internal" href="config.html#cfg_Servers_controluser"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['controluser']</code></a> and
<a class="reference internal" href="config.html#cfg_Servers_controlpass"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['controlpass']</code></a> settings)
with the proper rights to those tables. For example you can create it
using following statement:
And for any MariaDB version:
<div class="highlight-mysql notranslate"><div class="highlight"><pre>CREATE USER &#39;pma&#39;@&#39;localhost&#39; IDENTIFIED VIA mysql_native_password USING &#39;pmapass&#39;;
GRANT SELECT, INSERT, UPDATE, DELETE ON `&lt;pma_db&gt;`.* TO &#39;pma&#39;@&#39;localhost&#39;;
</pre></div>
</div>
For MySQL 8.0 and newer:
<div class="highlight-mysql notranslate"><div class="highlight"><pre>CREATE USER &#39;pma&#39;@&#39;localhost&#39; IDENTIFIED WITH caching_sha2_password BY &#39;pmapass&#39;;
GRANT SELECT, INSERT, UPDATE, DELETE ON &lt;pma_db&gt;.* TO &#39;pma&#39;@&#39;localhost&#39;;
</pre></div>
</div>
For MySQL older than 8.0:
<div class="highlight-mysql notranslate"><div class="highlight"><pre>CREATE USER &#39;pma&#39;@&#39;localhost&#39; IDENTIFIED WITH mysql_native_password AS &#39;pmapass&#39;;
GRANT SELECT, INSERT, UPDATE, DELETE ON &lt;pma_db&gt;.* TO &#39;pma&#39;@&#39;localhost&#39;;
</pre></div>
</div>
Note that MySQL installations with PHP older than 7.4 and MySQL newer than 8.0 may require
using the mysql_native_password authentication as a workaround, see
<a class="reference internal" href="faq.html#faq1-45">1.45 I get an error message about unknown authentication method caching_sha2_password when trying to log in</a> for details.
</div>
</div>
<div class="section" id="upgrading-from-an-older-version">
<h2>Upgrading from an older version<a class="headerlink" href="#upgrading-from-an-older-version" title="Permalink to this headline">¶</a></h2>
<div class="admonition warning">
Warning
Never extract the new version over an existing installation of
phpMyAdmin, always first remove the old files keeping just the
configuration.
This way, you will not leave any old or outdated files in the directory,
which can have severe security implications or can cause various breakages.
</div>
Simply copy <code class="file docutils literal notranslate">config.inc.php</code> from your previous installation into
the newly unpacked one. Configuration files from old versions may
require some tweaking as some options have been changed or removed.
For compatibility with PHP 5.3 and later, remove a
<code class="docutils literal notranslate">set_magic_quotes_runtime(0);</code> statement that you might find near
the end of your configuration file.
You should not copy <code class="file docutils literal notranslate">libraries/config.default.php</code> over
<code class="file docutils literal notranslate">config.inc.php</code> because the default configuration file is version-
specific.
The complete upgrade can be performed in a few simple steps:
<ol class="arabic simple">
<li>Download the latest phpMyAdmin version from &lt;<a class="reference external" href="https://www.phpmyadmin.net/downloads/">https://www.phpmyadmin.net/downloads/</a>&gt;.</li>
<li>Rename existing phpMyAdmin folder (for example to <code class="docutils literal notranslate">phpmyadmin-old</code>).</li>
<li>Unpack freshly downloaded phpMyAdmin to the desired location (for example <code class="docutils literal notranslate">phpmyadmin</code>).</li>
<li>Copy <code class="file docutils literal notranslate">config.inc.php`</code> from old location (<code class="docutils literal notranslate">phpmyadmin-old</code>) to the new one (<code class="docutils literal notranslate">phpmyadmin</code>).</li>
<li>Test that everything works properly.</li>
<li>Remove backup of a previous version (<code class="docutils literal notranslate">phpmyadmin-old</code>).</li>
</ol>
If you have upgraded your MySQL server from a version previous to 4.1.2 to
version 5.x or newer and if you use the phpMyAdmin configuration storage, you
should run the <a class="reference internal" href="glossary.html#term-SQL">SQL</a> script found in
<code class="file docutils literal notranslate">sql/upgrade_tables_mysql_4_1_2+.sql</code>.
If you have upgraded your phpMyAdmin to 4.3.0 or newer from 2.5.0 or
newer (&lt;= 4.2.x) and if you use the phpMyAdmin configuration storage, you
should run the <a class="reference internal" href="glossary.html#term-SQL">SQL</a> script found in
<code class="file docutils literal notranslate">sql/upgrade_column_info_4_3_0+.sql</code>.
Do not forget to clear the browser cache and to empty the old session by
logging out and logging in again.
</div>
<div class="section" id="using-authentication-modes">
<h2>Using authentication modes<a class="headerlink" href="#using-authentication-modes" title="Permalink to this headline">¶</a></h2>
<a class="reference internal" href="glossary.html#term-HTTP">HTTP</a> and cookie authentication modes are recommended in a multi-user
environment where you want to give users access to their own database and
don’t want them to play around with others. Nevertheless, be aware that MS
Internet Explorer seems to be really buggy about cookies, at least till version
6. Even in a single-user environment, you might prefer to use <a class="reference internal" href="glossary.html#term-HTTP">HTTP</a>
or cookie mode so that your user/password pair are not in clear in the
configuration file.
<a class="reference internal" href="glossary.html#term-HTTP">HTTP</a> and cookie authentication
modes are more secure: the MySQL login information does not need to be
set in the phpMyAdmin configuration file (except possibly for the
<a class="reference internal" href="config.html#cfg_Servers_controluser"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['controluser']</code></a>).
However, keep in mind that the password travels in plain text unless
you are using the HTTPS protocol. In cookie mode, the password is
stored, encrypted with the AES algorithm, in a temporary cookie.
Then each of the true users should be granted a set of privileges
on a set of particular databases. Normally you shouldn’t give global
privileges to an ordinary user unless you understand the impact of those
privileges (for example, you are creating a superuser).
For example, to grant the user real_user with all privileges on
the database user_base:
<div class="highlight-mysql notranslate"><div class="highlight"><pre>GRANT ALL PRIVILEGES ON user_base.* TO &#39;real_user&#39;@localhost IDENTIFIED BY &#39;real_password&#39;;
</pre></div>
</div>
What the user may now do is controlled entirely by the MySQL user management
system. With HTTP or cookie authentication mode, you don’t need to fill the
user/password fields inside the <a class="reference internal" href="config.html#cfg_Servers"><code class="xref config config-option docutils literal notranslate">$cfg['Servers']</code></a>.
<div class="admonition seealso">
See also
<a class="reference internal" href="faq.html#faq1-32">1.32 Can I use HTTP authentication with IIS?</a>,
<a class="reference internal" href="faq.html#faq1-35">1.35 Can I use HTTP authentication with Apache CGI?</a>,
<a class="reference internal" href="faq.html#faq4-1">4.1 I’m an ISP. Can I setup one central copy of phpMyAdmin or do I need to install it for each customer?</a>,
<a class="reference internal" href="faq.html#faq4-2">4.2 What’s the preferred way of making phpMyAdmin secure against evil access?</a>,
<a class="reference internal" href="faq.html#faq4-3">4.3 I get errors about not being able to include a file in /lang or in /libraries.</a>
</div>
<div class="section" id="http-authentication-mode">
<h3>HTTP authentication mode<a class="headerlink" href="#http-authentication-mode" title="Permalink to this headline">¶</a></h3>
<ul>
<li>Uses <a class="reference internal" href="glossary.html#term-HTTP">HTTP</a> Basic authentication
method and allows you to log in as any valid MySQL user.</li>
<li>Is supported with most PHP configurations. For <a class="reference internal" href="glossary.html#term-IIS">IIS</a> (<a class="reference internal" href="glossary.html#term-ISAPI">ISAPI</a>)
support using <a class="reference internal" href="glossary.html#term-CGI">CGI</a> PHP see <a class="reference internal" href="faq.html#faq1-32">1.32 Can I use HTTP authentication with IIS?</a>, for using with Apache
<a class="reference internal" href="glossary.html#term-CGI">CGI</a> see <a class="reference internal" href="faq.html#faq1-35">1.35 Can I use HTTP authentication with Apache CGI?</a>.</li>
<li>When PHP is running under Apache’s <a class="reference internal" href="glossary.html#term-mod_proxy_fcgi">mod_proxy_fcgi</a> (e.g. with PHP-FPM),
<code class="docutils literal notranslate">Authorization</code> headers are not passed to the underlying FCGI application,
such that your credentials will not reach the application. In this case, you can
add the following configuration directive:
<div class="highlight-apache notranslate"><div class="highlight"><pre>SetEnvIf Authorization &quot;(.*)&quot; HTTP_AUTHORIZATION=$1
</pre></div>
</div>
</li>
<li>See also <a class="reference internal" href="faq.html#faq4-4">4.4 phpMyAdmin always gives “Access denied” when using HTTP authentication.</a> about not using the <a class="reference internal" href="glossary.html#term-.htaccess">.htaccess</a> mechanism along with
‘<a class="reference internal" href="glossary.html#term-HTTP">HTTP</a>’ authentication mode.</li>
</ul>
<div class="admonition note">
Note
There is no way to do proper logout in HTTP authentication, most browsers
will remember credentials until there is no different successful
authentication. Because of this, this method has a limitation that you can not
login with the same user after logout.
</div>
</div>
<div class="section" id="cookie-authentication-mode">
<h3>Cookie authentication mode<a class="headerlink" href="#cookie-authentication-mode" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Username and password are stored in cookies during the session and password
is deleted when it ends.</li>
<li>With this mode, the user can truly log out of phpMyAdmin and log
back in with the same username (this is not possible with <a class="reference internal" href="#auth-http">HTTP authentication mode</a>).</li>
<li>If you want to allow users to enter any hostname to connect (rather than only
servers that are configured in <code class="file docutils literal notranslate">config.inc.php</code>),
see the <a class="reference internal" href="config.html#cfg_AllowArbitraryServer"><code class="xref config config-option docutils literal notranslate">$cfg['AllowArbitraryServer']</code></a> directive.</li>
<li>As mentioned in the <a class="reference internal" href="require.html#require">Requirements</a> section, having the <code class="docutils literal notranslate">openssl</code> extension
will speed up access considerably, but is not required.</li>
</ul>
</div>
<div class="section" id="signon-authentication-mode">
<h3>Signon authentication mode<a class="headerlink" href="#signon-authentication-mode" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>This mode is a convenient way of using credentials from another
application to authenticate to phpMyAdmin to implement a single signon
solution.</li>
<li>The other application has to store login information into session
data (see <a class="reference internal" href="config.html#cfg_Servers_SignonSession"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['SignonSession']</code></a> and
<a class="reference internal" href="config.html#cfg_Servers_SignonCookieParams"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['SignonCookieParams']</code></a>) or you
need to implement script to return the credentials (see
<a class="reference internal" href="config.html#cfg_Servers_SignonScript"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['SignonScript']</code></a>).</li>
<li>When no credentials are available, the user is being redirected to
<a class="reference internal" href="config.html#cfg_Servers_SignonURL"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['SignonURL']</code></a>, where you should handle
the login process.</li>
</ul>
The very basic example of saving credentials in a session is available as
<code class="file docutils literal notranslate">examples/signon.php</code>:
<div class="highlight-php notranslate"><div class="highlight"><pre>&lt;?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
 * Single signon for phpMyAdmin
 *
 * This is just example how to use session based single signon with
 * phpMyAdmin, it is not intended to be perfect code and look, only
 * shows how you can integrate this functionality in your application.
 *
 * @package PhpMyAdmin
 * @subpackage Example
 */
declare(strict_types=1);

/* Use cookies for session */
ini_set(&#39;session.use_cookies&#39;, &#39;true&#39;);
/* Change this to true if using phpMyAdmin over https */
$secure_cookie = false;
/* Need to have cookie visible from parent directory */
session_set_cookie_params(0, &#39;/&#39;, &#39;&#39;, $secure_cookie, true);
/* Create signon session */
$session_name = &#39;SignonSession&#39;;
session_name($session_name);
// Uncomment and change the following line to match your $cfg[&#39;SessionSavePath&#39;]
//session_save_path(&#39;/foobar&#39;);
@session_start();

/* Was data posted? */
if (isset($_POST[&#39;user&#39;])) {
 /* Store there credentials */
 $_SESSION[&#39;PMA_single_signon_user&#39;] = $_POST[&#39;user&#39;];
 $_SESSION[&#39;PMA_single_signon_password&#39;] = $_POST[&#39;password&#39;];
 $_SESSION[&#39;PMA_single_signon_host&#39;] = $_POST[&#39;host&#39;];
 $_SESSION[&#39;PMA_single_signon_port&#39;] = $_POST[&#39;port&#39;];
 /* Update another field of server configuration */
 $_SESSION[&#39;PMA_single_signon_cfgupdate&#39;] = [&#39;verbose&#39; =&gt; &#39;Signon test&#39;];
 $_SESSION[&#39;PMA_single_signon_HMAC_secret&#39;] = hash(&#39;sha1&#39;, uniqid(strval(rand()), true));
 $id = session_id();
 /* Close that session */
 @session_write_close();
 /* Redirect to phpMyAdmin (should use absolute URL here!) */
 header(&#39;Location: ../index.php&#39;);
} else {
 /* Show simple form */
 header(&#39;Content-Type: text/html; charset=utf-8&#39;);
 echo &#39;&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;&#39; , &quot;\n&quot;;
 ?&gt;
 &lt;!DOCTYPE HTML&gt;
 &lt;html lang=&quot;en&quot; dir=&quot;ltr&quot;&gt;
 &lt;head&gt;
 &lt;link rel=&quot;icon&quot; href=&quot;../favicon.ico&quot; type=&quot;image/x-icon&quot;&gt;
 &lt;link rel=&quot;shortcut icon&quot; href=&quot;../favicon.ico&quot; type=&quot;image/x-icon&quot;&gt;
 &lt;meta charset=&quot;utf-8&quot;&gt;
 &lt;title&gt;phpMyAdmin single signon example&lt;/title&gt;
 &lt;/head&gt;
 &lt;body&gt;
 &lt;?php
 if (isset($_SESSION[&#39;PMA_single_signon_error_message&#39;])) {
 echo &#39;&lt;p class=&quot;error&quot;&gt;&#39;;
 echo $_SESSION[&#39;PMA_single_signon_error_message&#39;];
 echo &#39;&lt;/p&gt;&#39;;
 }
 ?&gt;
 &lt;form action=&quot;signon.php&quot; method=&quot;post&quot;&gt;
 Username: &lt;input type=&quot;text&quot; name=&quot;user&quot;&gt;&lt;br&gt;
 Password: &lt;input type=&quot;password&quot; name=&quot;password&quot;&gt;&lt;br&gt;
 Host: (will use the one from config.inc.php by default)
 &lt;input type=&quot;text&quot; name=&quot;host&quot;&gt;&lt;br&gt;
 Port: (will use the one from config.inc.php by default)
 &lt;input type=&quot;text&quot; name=&quot;port&quot;&gt;&lt;br&gt;
 &lt;input type=&quot;submit&quot;&gt;
 &lt;/form&gt;
 &lt;/body&gt;
 &lt;/html&gt;
 &lt;?php
}
?&gt;
</pre></div>
</div>
Alternatively, you can also use this way to integrate with OpenID as shown
in <code class="file docutils literal notranslate">examples/openid.php</code>:
<div class="highlight-php notranslate"><div class="highlight"><pre>&lt;?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
 * Single signon for phpMyAdmin using OpenID
 *
 * This is just example how to use single signon with phpMyAdmin, it is
 * not intended to be perfect code and look, only shows how you can
 * integrate this functionality in your application.
 *
 * It uses OpenID pear package, see https://pear.php.net/package/OpenID
 *
 * User first authenticates using OpenID and based on content of $AUTH_MAP
 * the login information is passed to phpMyAdmin in session data.
 *
 * @package PhpMyAdmin
 * @subpackage Example
 */
declare(strict_types=1);

if (false === @include_once &#39;OpenID/RelyingParty.php&#39;) {
 exit;
}

/* Change this to true if using phpMyAdmin over https */
$secure_cookie = false;

/**
 * Map of authenticated users to MySQL user/password pairs.
 */
$AUTH_MAP = [
 &#39;https://launchpad.net/~username&#39; =&gt; [
 &#39;user&#39; =&gt; &#39;root&#39;,
 &#39;password&#39; =&gt; &#39;&#39;,
 ],
];

/**
 * Simple function to show HTML page with given content.
 *
 * @param string $contents Content to include in page
 *
 * @return void
 */
function Show_page($contents)
{
 header(&#39;Content-Type: text/html; charset=utf-8&#39;);
 echo &#39;&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;&#39; , &quot;\n&quot;;
 ?&gt;
 &lt;!DOCTYPE HTML&gt;
 &lt;html lang=&quot;en&quot; dir=&quot;ltr&quot;&gt;
 &lt;head&gt;
 &lt;link rel=&quot;icon&quot; href=&quot;../favicon.ico&quot; type=&quot;image/x-icon&quot;&gt;
 &lt;link rel=&quot;shortcut icon&quot; href=&quot;../favicon.ico&quot; type=&quot;image/x-icon&quot;&gt;
 &lt;meta charset=&quot;utf-8&quot;&gt;
 &lt;title&gt;phpMyAdmin OpenID signon example&lt;/title&gt;
 &lt;/head&gt;
 &lt;body&gt;
 &lt;?php
 if (isset($_SESSION) &amp;&amp; isset($_SESSION[&#39;PMA_single_signon_error_message&#39;])) {
 echo &#39;&lt;p class=&quot;error&quot;&gt;&#39; , $_SESSION[&#39;PMA_single_signon_message&#39;] , &#39;&lt;/p&gt;&#39;;
 unset($_SESSION[&#39;PMA_single_signon_message&#39;]);
 }
 echo $contents;
 ?&gt;
 &lt;/body&gt;
 &lt;/html&gt;
 &lt;?php
}

/**
 * Display error and exit
 *
 * @param Exception $e Exception object
 *
 * @return void
 */
function Die_error($e)
{
 $contents = &quot;&lt;div class=&#39;relyingparty_results&#39;&gt;\n&quot;;
 $contents .= &quot;&lt;pre&gt;&quot; . htmlspecialchars($e-&gt;getMessage()) . &quot;&lt;/pre&gt;\n&quot;;
 $contents .= &quot;&lt;/div class=&#39;relyingparty_results&#39;&gt;&quot;;
 Show_page($contents);
 exit;
}

/* Need to have cookie visible from parent directory */
session_set_cookie_params(0, &#39;/&#39;, &#39;&#39;, $secure_cookie, true);
/* Create signon session */
$session_name = &#39;SignonSession&#39;;
session_name($session_name);
@session_start();

// Determine realm and return_to
$base = &#39;http&#39;;
if (isset($_SERVER[&#39;HTTPS&#39;]) &amp;&amp; $_SERVER[&#39;HTTPS&#39;] == &#39;on&#39;) {
 $base .= &#39;s&#39;;
}
$base .= &#39;://&#39; . $_SERVER[&#39;SERVER_NAME&#39;] . &#39;:&#39; . $_SERVER[&#39;SERVER_PORT&#39;];

$realm = $base . &#39;/&#39;;
$returnTo = $base . dirname($_SERVER[&#39;PHP_SELF&#39;]);
if ($returnTo[strlen($returnTo) - 1] != &#39;/&#39;) {
 $returnTo .= &#39;/&#39;;
}
$returnTo .= &#39;openid.php&#39;;

/* Display form */
if (! count($_GET) &amp;&amp; ! count($_POST) || isset($_GET[&#39;phpMyAdmin&#39;])) {
 /* Show simple form */
 $content = &#39;&lt;form action=&quot;openid.php&quot; method=&quot;post&quot;&gt;
OpenID: &lt;input type=&quot;text&quot; name=&quot;identifier&quot;&gt;&lt;br&gt;
&lt;input type=&quot;submit&quot; name=&quot;start&quot;&gt;
&lt;/form&gt;
&lt;/body&gt;
&lt;/html&gt;&#39;;
 Show_page($content);
 exit;
}

/* Grab identifier */
if (isset($_POST[&#39;identifier&#39;]) &amp;&amp; is_string($_POST[&#39;identifier&#39;])) {
 $identifier = $_POST[&#39;identifier&#39;];
} elseif (isset($_SESSION[&#39;identifier&#39;]) &amp;&amp; is_string($_SESSION[&#39;identifier&#39;])) {
 $identifier = $_SESSION[&#39;identifier&#39;];
} else {
 $identifier = null;
}

/* Create OpenID object */
try {
 $o = new OpenID_RelyingParty($returnTo, $realm, $identifier);
} catch (Exception $e) {
 Die_error($e);
}

/* Redirect to OpenID provider */
if (isset($_POST[&#39;start&#39;])) {
 try {
 $authRequest = $o-&gt;prepare();
 } catch (Exception $e) {
 Die_error($e);
 }

$url = $authRequest-&gt;getAuthorizeURL();

header(&quot;Location: $url&quot;);
 exit;
} else {
 /* Grab query string */
 if (! count($_POST)) {
 list(, $queryString) = explode(&#39;?&#39;, $_SERVER[&#39;REQUEST_URI&#39;]);
 } else {
 // I hate php sometimes
 $queryString = file_get_contents(&#39;php://input&#39;);
 }

/* Check reply */
 try {
 $message = new OpenID_Message($queryString, OpenID_Message::FORMAT_HTTP);
 } catch (Exception $e) {
 Die_error($e);
 }

$id = $message-&gt;get(&#39;openid.claimed_id&#39;);

if (! empty($id) &amp;&amp; isset($AUTH_MAP[$id])) {
 $_SESSION[&#39;PMA_single_signon_user&#39;] = $AUTH_MAP[$id][&#39;user&#39;];
 $_SESSION[&#39;PMA_single_signon_password&#39;] = $AUTH_MAP[$id][&#39;password&#39;];
 $_SESSION[&#39;PMA_single_signon_HMAC_secret&#39;] = hash(&#39;sha1&#39;, uniqid(strval(rand()), true));
 session_write_close();
 /* Redirect to phpMyAdmin (should use absolute URL here!) */
 header(&#39;Location: ../index.php&#39;);
 } else {
 Show_page(&#39;&lt;p&gt;User not allowed!&lt;/p&gt;&#39;);
 exit;
 }
}
</pre></div>
</div>
If you intend to pass the credentials using some other means than, you have to
implement wrapper in PHP to get that data and set it to
<a class="reference internal" href="config.html#cfg_Servers_SignonScript"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['SignonScript']</code></a>. There is a very minimal example
in <code class="file docutils literal notranslate">examples/signon-script.php</code>:
<div class="highlight-php notranslate"><div class="highlight"><pre>&lt;?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
 * Single signon for phpMyAdmin
 *
 * This is just example how to use script based single signon with
 * phpMyAdmin, it is not intended to be perfect code and look, only
 * shows how you can integrate this functionality in your application.
 *
 * @package PhpMyAdmin
 * @subpackage Example
 */
declare(strict_types=1);

/**
 * This function returns username and password.
 *
 * It can optionally use configured username as parameter.
 *
 * @param string $user User name
 *
 * @return array
 */
function get_login_credentials($user)
{
 /* Optionally we can use passed username */
 if (! empty($user)) {
 return [
 $user,
 &#39;password&#39;,
 ];
 }

/* Here we would retrieve the credentials */
 return [
 &#39;root&#39;,
 &#39;&#39;,
 ];
}
</pre></div>
</div>
<div class="admonition seealso">
See also
<a class="reference internal" href="config.html#cfg_Servers_auth_type"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['auth_type']</code></a>,
<a class="reference internal" href="config.html#cfg_Servers_SignonSession"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['SignonSession']</code></a>,
<a class="reference internal" href="config.html#cfg_Servers_SignonCookieParams"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['SignonCookieParams']</code></a>,
<a class="reference internal" href="config.html#cfg_Servers_SignonScript"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['SignonScript']</code></a>,
<a class="reference internal" href="config.html#cfg_Servers_SignonURL"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['SignonURL']</code></a>,
<a class="reference internal" href="config.html#example-signon">Example for signon authentication</a>
</div>
</div>
<div class="section" id="config-authentication-mode">
<h3>Config authentication mode<a class="headerlink" href="#config-authentication-mode" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>This mode is sometimes the less secure one because it requires you to fill the
<a class="reference internal" href="config.html#cfg_Servers_user"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['user']</code></a> and
<a class="reference internal" href="config.html#cfg_Servers_password"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['password']</code></a>
fields (and as a result, anyone who can read your <code class="file docutils literal notranslate">config.inc.php</code>
can discover your username and password).</li>
<li>In the <a class="reference internal" href="faq.html#faqmultiuser">ISPs, multi-user installations</a> section, there is an entry explaining how
to protect your configuration file.</li>
<li>For additional security in this mode, you may wish to consider the
Host authentication <a class="reference internal" href="config.html#cfg_Servers_AllowDeny_order"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['AllowDeny']['order']</code></a>
and <a class="reference internal" href="config.html#cfg_Servers_AllowDeny_rules"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['AllowDeny']['rules']</code></a> configuration directives.</li>
<li>Unlike cookie and http, does not require a user to log in when first
loading the phpMyAdmin site. This is by design but could allow any
user to access your installation. Use of some restriction method is
suggested, perhaps a <a class="reference internal" href="glossary.html#term-.htaccess">.htaccess</a> file with the HTTP-AUTH directive or disallowing
incoming HTTP requests at one’s router or firewall will suffice (both
of which are beyond the scope of this manual but easily searchable
with Google).</li>
</ul>
</div>
</div>
<div class="section" id="securing-your-phpmyadmin-installation">
<h2>Securing your phpMyAdmin installation<a class="headerlink" href="#securing-your-phpmyadmin-installation" title="Permalink to this headline">¶</a></h2>
The phpMyAdmin team tries hard to make the application secure, however there
are always ways to make your installation more secure:
<ul>
<li>Follow our <a class="reference external" href="https://www.phpmyadmin.net/security/">Security announcements</a> and upgrade
phpMyAdmin whenever new vulnerability is published.</li>
<li>Serve phpMyAdmin on HTTPS only. Preferably, you should use HSTS as well, so that
you’re protected from protocol downgrade attacks.</li>
<li>Ensure your PHP setup follows recommendations for production sites, for example
<a class="reference external" href="https://www.php.net/manual/en/errorfunc.configuration.php#ini.display-errors">display_errors</a>
should be disabled.</li>
<li>Remove the <code class="docutils literal notranslate">test</code> directory from phpMyAdmin, unless you are developing and need a test suite.</li>
<li>Remove the <code class="docutils literal notranslate">setup</code> directory from phpMyAdmin, you will probably not
use it after the initial setup.</li>
<li>Properly choose an authentication method - <a class="reference internal" href="#cookie">Cookie authentication mode</a>
is probably the best choice for shared hosting.</li>
<li>Deny access to auxiliary files in <code class="file docutils literal notranslate">./libraries/</code> or
<code class="file docutils literal notranslate">./templates/</code> subfolders in your webserver configuration.
Such configuration prevents from possible path exposure and cross side
scripting vulnerabilities that might happen to be found in that code. For the
Apache webserver, this is often accomplished with a <a class="reference internal" href="glossary.html#term-.htaccess">.htaccess</a> file in
those directories.</li>
<li>Deny access to temporary files, see <a class="reference internal" href="config.html#cfg_TempDir"><code class="xref config config-option docutils literal notranslate">$cfg['TempDir']</code></a> (if that
is placed inside your web root, see also <a class="reference internal" href="config.html#web-dirs">Web server upload/save/import directories</a>.</li>
<li>It is generally a good idea to protect a public phpMyAdmin installation
against access by robots as they usually can not do anything good there. You
can do this using <code class="docutils literal notranslate">robots.txt</code> file in the root of your webserver or limit
access by web server configuration, see <a class="reference internal" href="faq.html#faq1-42">1.42 How can I prevent robots from accessing phpMyAdmin?</a>.</li>
<li>In case you don’t want all MySQL users to be able to access
phpMyAdmin, you can use <a class="reference internal" href="config.html#cfg_Servers_AllowDeny_rules"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['AllowDeny']['rules']</code></a> to limit them
or <a class="reference internal" href="config.html#cfg_Servers_AllowRoot"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['AllowRoot']</code></a> to deny root user access.</li>
<li>Enable <a class="reference internal" href="two_factor.html#fa">Two-factor authentication</a> for your account.</li>
<li>Consider hiding phpMyAdmin behind an authentication proxy, so that
users need to authenticate prior to providing MySQL credentials
to phpMyAdmin. You can achieve this by configuring your web server to request
HTTP authentication. For example in Apache this can be done with:
<div class="highlight-apache notranslate"><div class="highlight"><pre>AuthType Basic
AuthName &quot;Restricted Access&quot;
AuthUserFile /usr/share/phpmyadmin/passwd
Require valid-user
</pre></div>
</div>
Once you have changed the configuration, you need to create a list of users which
can authenticate. This can be done using the htpasswd utility:
<div class="highlight-sh notranslate"><div class="highlight"><pre>htpasswd -c /usr/share/phpmyadmin/passwd username
</pre></div>
</div>
</li>
<li>If you are afraid of automated attacks, enabling Captcha by
<a class="reference internal" href="config.html#cfg_CaptchaLoginPublicKey"><code class="xref config config-option docutils literal notranslate">$cfg['CaptchaLoginPublicKey']</code></a> and
<a class="reference internal" href="config.html#cfg_CaptchaLoginPrivateKey"><code class="xref config config-option docutils literal notranslate">$cfg['CaptchaLoginPrivateKey']</code></a> might be an option.</li>
<li>Failed login attemps are logged to syslog (if available, see
<a class="reference internal" href="config.html#cfg_AuthLog"><code class="xref config config-option docutils literal notranslate">$cfg['AuthLog']</code></a>). This can allow using a tool such as
fail2ban to block brute-force attempts. Note that the log file used by syslog
is not the same as the Apache error or access log files.</li>
<li>In case you’re running phpMyAdmin together with other PHP applications, it is
generally advised to use separate session storage for phpMyAdmin to avoid
possible session-based attacks against it. You can use
<a class="reference internal" href="config.html#cfg_SessionSavePath"><code class="xref config config-option docutils literal notranslate">$cfg['SessionSavePath']</code></a> to achieve this.</li>
</ul>
</div>
<div class="section" id="using-ssl-for-connection-to-database-server">
<h2>Using SSL for connection to database server<a class="headerlink" href="#using-ssl-for-connection-to-database-server" title="Permalink to this headline">¶</a></h2>
It is recommended to use SSL when connecting to remote database server. There
are several configuration options involved in the SSL setup:
<dl class="simple">
<dt><a class="reference internal" href="config.html#cfg_Servers_ssl"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl']</code></a></dt><dd>Defines whether to use SSL at all. If you enable only this, the connection
will be encrypted, but there is not authentication of the connection - you
can not verify that you are talking to the right server.
</dd>
<dt><a class="reference internal" href="config.html#cfg_Servers_ssl_key"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl_key']</code></a> and <a class="reference internal" href="config.html#cfg_Servers_ssl_cert"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl_cert']</code></a></dt><dd>This is used for authentication of client to the server.
</dd>
<dt><a class="reference internal" href="config.html#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl_ca']</code></a> and <a class="reference internal" href="config.html#cfg_Servers_ssl_ca_path"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl_ca_path']</code></a></dt><dd>The certificate authorities you trust for server certificates.
This is used to ensure that you are talking to a trusted server.
</dd>
<dt><a class="reference internal" href="config.html#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl_verify']</code></a></dt><dd>This configuration disables server certificate verification. Use with
caution.
</dd>
</dl>
<div class="admonition seealso">
See also
<a class="reference internal" href="config.html#example-google-ssl">Google Cloud SQL with SSL</a>,
<a class="reference internal" href="config.html#cfg_Servers_ssl"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl']</code></a>,
<a class="reference internal" href="config.html#cfg_Servers_ssl_key"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl_key']</code></a>,
<a class="reference internal" href="config.html#cfg_Servers_ssl_cert"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl_cert']</code></a>,
<a class="reference internal" href="config.html#cfg_Servers_ssl_ca"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl_ca']</code></a>,
<a class="reference internal" href="config.html#cfg_Servers_ssl_ca_path"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl_ca_path']</code></a>,
<a class="reference internal" href="config.html#cfg_Servers_ssl_ciphers"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl_ciphers']</code></a>,
<a class="reference internal" href="config.html#cfg_Servers_ssl_verify"><code class="xref config config-option docutils literal notranslate">$cfg['Servers'][$i]['ssl_verify']</code></a>
</div>
</div>
<div class="section" id="known-issues">
<h2>Known issues<a class="headerlink" href="#known-issues" title="Permalink to this headline">¶</a></h2>
<div class="section" id="users-with-column-specific-privileges-are-unable-to-browse">
<h3>Users with column-specific privileges are unable to “Browse”<a class="headerlink" href="#users-with-column-specific-privileges-are-unable-to-browse" title="Permalink to this headline">¶</a></h3>
If a user has only column-specific privileges on some (but not all) columns in a table, “Browse”
will fail with an error message.
As a workaround, a bookmarked query with the same name as the table can be created, this will
run when using the “Browse” link instead. <a class="reference external" href="https://github.com/phpmyadmin/phpmyadmin/issues/11922">Issue 11922</a>.
</div>
<div class="section" id="trouble-logging-back-in-after-logging-out-using-http-authentication">
<h3>Trouble logging back in after logging out using ‘http’ authentication<a class="headerlink" href="#trouble-logging-back-in-after-logging-out-using-http-authentication" title="Permalink to this headline">¶</a></h3>
When using the ‘http’ <code class="docutils literal notranslate">auth_type</code>, it can be impossible to log back in (when the logout comes
manually or after a period of inactivity). <a class="reference external" href="https://github.com/phpmyadmin/phpmyadmin/issues/11898">Issue 11898</a>.
</div>
</div>
</div>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="index.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">Installation</a><ul>
<li><a class="reference internal" href="#linux-distributions">Linux distributions</a><ul>
<li><a class="reference internal" href="#debian-and-ubuntu">Debian and Ubuntu</a></li>
<li><a class="reference internal" href="#opensuse">OpenSUSE</a></li>
<li><a class="reference internal" href="#gentoo">Gentoo</a></li>
<li><a class="reference internal" href="#mandriva">Mandriva</a></li>
<li><a class="reference internal" href="#fedora">Fedora</a></li>
<li><a class="reference internal" href="#red-hat-enterprise-linux">Red Hat Enterprise Linux</a></li>
</ul>
</li>
<li><a class="reference internal" href="#installing-on-windows">Installing on Windows</a></li>
<li><a class="reference internal" href="#installing-from-git">Installing from Git</a></li>
<li><a class="reference internal" href="#installing-using-composer">Installing using Composer</a></li>
<li><a class="reference internal" href="#installing-using-docker">Installing using Docker</a><ul>
<li><a class="reference internal" href="#docker-environment-variables">Docker environment variables</a></li>
<li><a class="reference internal" href="#customizing-configuration">Customizing configuration</a></li>
<li><a class="reference internal" href="#docker-volumes">Docker Volumes</a></li>
<li><a class="reference internal" href="#docker-examples">Docker Examples</a></li>
<li><a class="reference internal" href="#using-docker-compose">Using docker-compose</a></li>
<li><a class="reference internal" href="#customizing-configuration-file-using-docker-compose">Customizing configuration file using docker-compose</a></li>
<li><a class="reference internal" href="#running-behind-haproxy-in-a-subdirectory">Running behind haproxy in a subdirectory</a></li>
</ul>
</li>
<li><a class="reference internal" href="#quick-install">Quick Install</a><ul>
<li><a class="reference internal" href="#manually-creating-the-file">Manually creating the file</a></li>
<li><a class="reference internal" href="#using-the-setup-script">Using the Setup script</a><ul>
<li><a class="reference internal" href="#setup-script-on-debian-ubuntu-and-derivatives">Setup script on Debian, Ubuntu and derivatives</a></li>
<li><a class="reference internal" href="#setup-script-on-opensuse">Setup script on openSUSE</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#verifying-phpmyadmin-releases">Verifying phpMyAdmin releases</a></li>
<li><a class="reference internal" href="#phpmyadmin-configuration-storage">phpMyAdmin configuration storage</a><ul>
<li><a class="reference internal" href="#zero-configuration">Zero configuration</a></li>
<li><a class="reference internal" href="#manual-configuration">Manual configuration</a></li>
</ul>
</li>
<li><a class="reference internal" href="#upgrading-from-an-older-version">Upgrading from an older version</a></li>
<li><a class="reference internal" href="#using-authentication-modes">Using authentication modes</a><ul>
<li><a class="reference internal" href="#http-authentication-mode">HTTP authentication mode</a></li>
<li><a class="reference internal" href="#cookie-authentication-mode">Cookie authentication mode</a></li>
<li><a class="reference internal" href="#signon-authentication-mode">Signon authentication mode</a></li>
<li><a class="reference internal" href="#config-authentication-mode">Config authentication mode</a></li>
</ul>
</li>
<li><a class="reference internal" href="#securing-your-phpmyadmin-installation">Securing your phpMyAdmin installation</a></li>
<li><a class="reference internal" href="#using-ssl-for-connection-to-database-server">Using SSL for connection to database server</a></li>
<li><a class="reference internal" href="#known-issues">Known issues</a><ul>
<li><a class="reference internal" href="#users-with-column-specific-privileges-are-unable-to-browse">Users with column-specific privileges are unable to “Browse”</a></li>
<li><a class="reference internal" href="#trouble-logging-back-in-after-logging-out-using-http-authentication">Trouble logging back in after logging out using ‘http’ authentication</a></li>
</ul>
</li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="require.html"
 title="previous chapter">Requirements</a>
 <h4>Next topic</h4>
 <a href="config.html"
 title="next chapter">Configuration</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="_sources/setup.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" />
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div>
 <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"
 >index</a></li>
 <li class="right" >
 <a href="config.html" title="Configuration"
 >next</a> |</li>
 <li class="right" >
 <a href="require.html" title="Requirements"
 >previous</a> |</li>
 <li class="nav-item nav-item-0"><a href="index.html">phpMyAdmin 5.0.4 documentation</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">Installation</a></li> 
 </ul>
 </div>
 <div class="footer" role="contentinfo">
 &#169; <a href="copyright.html">Copyright</a> 2022 - 2020, The phpMyAdmin devel team.
 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.4.3.
 </div>
 </body>
</html>

Back to Directory File Manager