Installation
phpMyAdmin does not apply any special security methods to the MySQLdatabase server. It is still the system administrator’s job to grantpermissions on the MySQL databases properly. phpMyAdmin’sUserspage can be used for this.
Linux distributions
phpMyAdmin is included in most Linux distributions. It is recommended to usedistribution packages when possible - they usually provide integration to yourdistribution and you will automatically get security updates from your distribution.
Debian and Ubuntu
Most Debian and Ubuntu versions include a phpMyAdmin package, but be aware thatthe configuration file is maintained in/etc/phpmyadmin
and may differ insome ways from the official phpMyAdmin documentation. Specifically, it does:
Configuration of a web server (works for Apache and lighttpd).
Creating ofphpMyAdmin configuration storage using dbconfig-common.
Securing setup script, seeSetup script on Debian, Ubuntu and derivatives.
More specific details about installing Debian or Ubuntu packages are availablein our wiki.
See also
More information can be found inREADME.Debian(it is installed as/usr/share/doc/phpmyadmin/README.Debian
with the package).
OpenSUSE
OpenSUSE already comes with phpMyAdmin package, just install packages fromtheopenSUSE Build Service.
Gentoo
Gentoo ships the phpMyAdmin package, both in a near-stock configuration as wellas in awebapp-config
configuration. Useemergedev-db/phpmyadmin
toinstall.
Mandriva
Mandriva ships the phpMyAdmin package in theircontrib
branch and can beinstalled via the usual Control Center.
Fedora
Fedora ships the phpMyAdmin package, but be aware that the configuration fileis maintained in/etc/phpMyAdmin/
and may differ in some ways from theofficial phpMyAdmin documentation.
Red Hat Enterprise Linux
Red Hat Enterprise Linux itself and thus derivatives like CentOS don’tship phpMyAdmin, but the Fedora-driven repositoryExtra Packages for Enterprise Linux (EPEL)is doing so, if it’senabled.But be aware that the configuration file is maintained in/etc/phpMyAdmin/
and may differ in some ways from theofficial phpMyAdmin documentation.
Installing on Windows
The easiest way to get phpMyAdmin on Windows is using third party productswhich include phpMyAdmin together with a database and web server such asXAMPP.
You can find more of such options atWikipedia.
Installing from Git
In order to install from Git, you’ll need a few supporting applications:
Git to download the source, or you can download the most recent source directly fromGithub
Node.js (version 12 or higher)
You can clone current phpMyAdmin source fromhttps://github.com/phpmyadmin/phpmyadmin.git
:
gitclonehttps://github.com/phpmyadmin/phpmyadmin.git
Additionally you need to install dependencies usingComposer:
composerupdate
If you do not intend to develop, you can skip the installation of developer toolsby invoking:
composerupdate--no-dev
Finally, you’ll need to useYarn to install some JavaScript dependencies:
yarninstall--production
Installing using Composer
You can install phpMyAdmin using theComposer tool, since 4.7.0 the releasesare automatically mirrored to the defaultPackagist repository.
Note
The content of the Composer repository is automatically generatedseparately from the releases, so the content doesn’t have to be100% same as when you download the tarball. There should be nofunctional differences though.
To install phpMyAdmin simply run:
composercreate-projectphpmyadmin/phpmyadmin
Alternatively you can use our own composer repository, which containsthe release tarballs and is available at<https://www.phpmyadmin.net/packages.json>:
composercreate-projectphpmyadmin/phpmyadmin--repository-url=https://www.phpmyadmin.net/packages.json--no-dev
Installing using Docker
phpMyAdmin comes with aDocker official image, which you can easily deploy. You candownload it using:
dockerpullphpmyadmin
The phpMyAdmin server will listen on port 80. It supports several ways ofconfiguring the link to the database server, either by Docker’s link featureby linking your database container todb
for phpMyAdmin (by specifying--linkyour_db_host:db
) or by environment variables (in this case it’s upto you to set up networking in Docker to allow the phpMyAdmin container to accessthe database container over the network).
Docker environment variables
You can configure several phpMyAdmin features using environment variables:
- PMA_ARBITRARY
Allows you to enter a database server hostname on login form.
See also
- PMA_HOST
Hostname or IP address of the database server to use.
See also
- PMA_HOSTS
Comma-separated hostnames or IP addresses of the database servers to use.
Note
Used only if
PMA_HOST
is empty.
- PMA_VERBOSE
Verbose name of the database server.
See also
- PMA_VERBOSES
Comma-separated verbose name of the database servers.
Note
Used only if
PMA_VERBOSE
is empty.
- PMA_USER
User name to use forConfig authentication mode.
- PMA_PASSWORD
Password to use forConfig authentication mode.
- PMA_PORT
Port of the database server to use.
- PMA_SOCKET
Socket file for the database connection.
- PMA_SOCKETS
Comma-separated list of socket files for the database connections.
Note
Used only if
PMA_SOCKET
is empty.
- PMA_ABSOLUTE_URI
The fully-qualified path (
https://pma.example.net/
) where the reverseproxy makes phpMyAdmin available.See also
- PMA_QUERYHISTORYDB
When set totrue, enables storing SQL history to
$cfg['Servers'][$i]['pmadb']
.Whenfalse, history is stored in the browser and is cleared when logging out.See also
See also
- PMA_QUERYHISTORYMAX
When set to an integer, controls the number of history items.
See also
- PMA_CONTROLHOST
When set, this points to an alternate database host used for storing the “phpMyAdmin configuration storage” database.
- PMA_CONTROLUSER
Defines the username for phpMyAdmin to use for the “phpMyAdmin configuration storage” database.
- PMA_CONTROLPASS
Defines the password for phpMyAdmin to use for the “phpMyAdmin configuration storage” database.
- PMA_CONTROLPORT
When set, will override the default port (3306) for connecting to the control host.
- PMA_PMADB
When set, define the name of the database to be used for the “phpMyAdmin configuration storage” database.When not set, the advanced features are not enabled by default: they can still potentially be enabled by the user when logging in with theZero configuration feature.
Note
Suggested values:phpmyadmin orpmadb
See also
- HIDE_PHP_VERSION
If defined, this option will hide the PHP version (expose_php = Off).Set to any value (such asHIDE_PHP_VERSION=true).
- UPLOAD_LIMIT
If set, this option will override the default value for apache and php-fpm (this will change
upload_max_filesize
andpost_max_size
values).Note
Format as[0-9+](K,M,G) default value is2048K
- MEMORY_LIMIT
If set, this option will override the phpMyAdmin memory limit
$cfg['MemoryLimit']
and PHP’smemory_limit.Note
Format as[0-9+](K,M,G) whereK is for Kilobytes,M for Megabytes,G for Gigabytes and1K = 1024 bytes. Default value is512M.
- MAX_EXECUTION_TIME
If set, this option will override the maximum execution time in seconds for phpMyAdmin
$cfg['ExecTimeLimit']
and PHP’smax_execution_time.Note
Format as[0-9+]. Default value is600.
- PMA_CONFIG_BASE64
If set, this option will override the defaultconfig.inc.php with the base64 decoded contents of the variable.
- PMA_USER_CONFIG_BASE64
If set, this option will override the defaultconfig.user.inc.php with the base64 decoded contents of the variable.
- PMA_UPLOADDIR
If set, this option will set the path where files can be saved to be available to import (
$cfg['UploadDir']
)
- PMA_SAVEDIR
If set, this option will set the path where exported files can be saved (
$cfg['SaveDir']
)
- APACHE_PORT
If set, this option will change the default Apache port from80 in case you want it to run on a different port like an unprivileged port. Set to any port value (such asAPACHE_PORT=8090).
- PMA_SSL_DIR
Define the path used for SSL files generated from environment variables, default value is/etc/phpmyadmin/ssl.
- PMA_SSL
When set to1, defines SSL usage for the MySQL connection.
See also
- PMA_SSLS
Comma-separated list of0 and1 defining SSL usage for the corresponding MySQL connections.
- PMA_SSL_VERIFY
When set to1, enables SSL certificate verification for the MySQL connection.
- PMA_SSL_VERIFIES
Comma-separated list of0 and1 to enable or disable SSL certificate verification for multiple MySQL connections.
- PMA_SSL_CA
In the context of mutual TLS security, allows setting your CA file as a string inside the defaultconfig.inc.php.
See also
- PMA_SSL_CAS
In the context of mutual TLS security, allows setting multiple CA files as a comma-separated list of strings inside the defaultconfig.inc.php.
- PMA_SSL_CA_BASE64
In the context of mutual TLS security, allows setting your CA file as a base64 string inside the defaultconfig.inc.php.
See also
- PMA_SSL_CAS_BASE64
In the context of mutual TLS security, allows setting multiple CA files as a comma-separated list of base64 strings inside the defaultconfig.inc.php.
- PMA_SSL_CERT
In the context of mutual TLS security, allows setting your CERT file as a string inside the defaultconfig.inc.php.
See also
- PMA_SSL_CERTS
In the context of mutual TLS security, allows setting multiple CERT files as a comma-separated list of strings inside the defaultconfig.inc.php.
- PMA_SSL_CERT_BASE64
In the context of mutual TLS security, allows setting your CERT file as a base64 string inside the defaultconfig.inc.php.
See also
- PMA_SSL_CERTS_BASE64
In the context of mutual TLS security, allows setting multiple CERT files as a comma-separated list of base64 strings inside the defaultconfig.inc.php.
- PMA_SSL_KEY
In the context of mutual TLS security, allows setting your KEY file as a string inside the defaultconfig.inc.php.
- PMA_SSL_KEYS
In the context of mutual TLS security, allows setting multiple KEY files as a comma-separated list of strings inside the defaultconfig.inc.php.
See also
- PMA_SSL_KEY_BASE64
In the context of mutual TLS security, allows setting your KEY file as a base64 string inside the defaultconfig.inc.php.
See also
- PMA_SSL_KEYS_BASE64
In the context of mutual TLS security, allows setting multiple KEY files as a comma-separated list of base64 strings inside the defaultconfig.inc.php.
- TZ
If defined, this option will change the default PHPdate.timezone fromUTC.
By default,Cookie authentication mode is used, but ifPMA_USER
andPMA_PASSWORD
are set, it is switched toConfig authentication mode.
Note
The credentials you need to log in are stored in the MySQL server, in caseof Docker image, there are various ways to set it (for exampleMYSQL_ROOT_PASSWORD
when starting the MySQL container). Please checkdocumentation forMariaDB containerorMySQL container.
Customizing configuration
Additionally configuration can be tweaked by/etc/phpmyadmin/config.user.inc.php
. Ifthis file exists, it will be loaded after configuration is generated from aboveenvironment variables, so you can override any configuration variable. Thisconfiguration can be added as a volume when invoking docker using-v /some/local/directory/config.user.inc.php:/etc/phpmyadmin/config.user.inc.php parameters.
Note that the supplied configuration file is applied afterDocker environment variables,but you can override any of the values.
For example to change the default behavior of CSV export you can use the followingconfiguration file:
<?php$cfg['Export']['csv_columns']=true;
You can also use it to define server configuration instead of using theenvironment variables listed inDocker environment variables:
<?php/* Override Servers array */$cfg['Servers']=[1=>['auth_type'=>'cookie','host'=>'mydb1','port'=>3306,'verbose'=>'Verbose name 1',],2=>['auth_type'=>'cookie','host'=>'mydb2','port'=>3306,'verbose'=>'Verbose name 2',],];
See also
SeeConfiguration for detailed description of configuration options.
Docker Volumes
You can use the following volumes to customize image behavior:
/etc/phpmyadmin/config.user.inc.php
Can be used for additional settings, see the previous chapter for more details.
/sessions/
Directory where PHP sessions are stored. You might want to share thisfor example when usingSignon authentication mode.
/www/themes/
Directory where phpMyAdmin looks for themes. By default only those shippedwith phpMyAdmin are included, but you can include additional phpMyAdminthemes (seeCustom Themes) by using Docker volumes.
Docker Examples
To connect phpMyAdmin to a given server use:
dockerrun--namephpmyadmin-d-ePMA_HOST=dbhost-p8080:80phpmyadmin:latest
To connect phpMyAdmin to more servers use:
dockerrun--namephpmyadmin-d-ePMA_HOSTS=dbhost1,dbhost2,dbhost3-p8080:80phpmyadmin:latest
To use arbitrary server option:
dockerrun--namephpmyadmin-d--linkmysql_db_server:db-p8080:80-ePMA_ARBITRARY=1phpmyadmin:latest
You can also link the database container using Docker:
dockerrun--namephpmyadmin-d--linkmysql_db_server:db-p8080:80phpmyadmin:latest
Running with additional configuration:
dockerrun--namephpmyadmin-d--linkmysql_db_server:db-p8080:80-v/some/local/directory/config.user.inc.php:/etc/phpmyadmin/config.user.inc.phpphpmyadmin:latest
Running with additional themes:
dockerrun--namephpmyadmin-d--linkmysql_db_server:db-p8080:80-v/some/local/directory/custom/phpmyadmin/themeName/:/var/www/html/themes/themeName/phpmyadmin:latest
Using docker-compose
Alternatively, you can also use docker-compose with the docker-compose.yml from<https://github.com/phpmyadmin/docker>. This will run phpMyAdmin with anarbitrary server - allowing you to specify MySQL/MariaDB server on the login page.
dockercomposeup-d
Customizing configuration file using docker-compose
You can use an external file to customize phpMyAdmin configuration and pass itusing the volumes directive:
phpmyadmin:image:phpmyadmin:latestcontainer_name:phpmyadminenvironment:-PMA_ARBITRARY=1restart:alwaysports:-8080:80volumes:-/sessions-~/docker/phpmyadmin/config.user.inc.php:/etc/phpmyadmin/config.user.inc.php-/custom/phpmyadmin/theme/:/www/themes/theme/
See also
Running behind haproxy in a subdirectory
When you want to expose phpMyAdmin running in a Docker container in asubdirectory, you need to rewrite the request path in the server proxying therequests.
For example, using haproxy it can be done as:
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 LOCALNETbackend phpmyadmin mode http reqirep ^(GET|POST|HEAD)\ /phpmyadmin/(.*) \1\ /\2 # phpMyAdmin container IP server localhost 172.30.21.21:80
When using traefik, something like following should work:
defaultEntryPoints = ["http"][entryPoints] [entryPoints.http] address = ":80" [entryPoints.http.redirect] regex = "(http:\\/\\/[^\\/]+\\/([^\\?\\.]+)[^\\/])$" replacement = "$1/"[backends] [backends.myadmin] [backends.myadmin.servers.myadmin] url="http://internal.address.to.pma"[frontends] [frontends.myadmin] backend = "myadmin" passHostHeader = true [frontends.myadmin.routes.default] rule="PathPrefixStrip:/phpmyadmin/;AddPrefix:/"
You then should specifyPMA_ABSOLUTE_URI
in the docker-composeconfiguration:
version:'2'services:phpmyadmin:restart:alwaysimage:phpmyadmin:latestcontainer_name:phpmyadminhostname:phpmyadmindomainname:example.comports:-8000:80environment:-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/
IBM Cloud
One of our users has created a helpful guide for installing phpMyAdmin on theIBM Cloud platform.
Quick Install
Choose an appropriate distribution kit from the phpmyadmin.netDownloads page. Some kits contain only the English messages, otherscontain all languages. We’ll assume you chose a kit whose namelooks like
phpMyAdmin-x.x.x-all-languages.tar.gz
.Ensure you have downloaded a genuine archive, seeVerifying phpMyAdmin releases.
Untar or unzip the distribution (be sure to unzip the subdirectories):
tar-xzvfphpMyAdmin_x.x.x-all-languages.tar.gz
in yourwebserver’s document root. If you don’t have direct access to yourdocument 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.Ensure that all the scripts have the appropriate owner (if PHP isrunning in safe mode, having some scripts with an owner different fromthe owner of other scripts will be a problem). See4.2 What’s the preferred way of making phpMyAdmin secure against evil access? and1.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. for suggestions.
Now you must configure your installation. There are two methods thatcan be used. Traditionally, users have hand-edited a copy of
config.inc.php
, but now a wizard-style setup script is providedfor those who prefer a graphical installation. Creating aconfig.inc.php
is still a quick way to get started and needed forsome advanced features.
Manually creating the file
To manually create the file, simply use your text editor to create thefileconfig.inc.php
(you can copyconfig.sample.inc.php
to geta minimal configuration file) in the main (top-level) phpMyAdmindirectory (the one that containsindex.php
). phpMyAdmin firstloads the default configuration values and then overrides those valueswith anything found inconfig.inc.php
. If the default value isokay for a particular setting, there is no need to include it inconfig.inc.php
. You’ll probably need only a few directives to get going; asimple configuration may look like this:
<?php// The string is a hexadecimal representation of a 32-bytes long string of random bytes.$cfg['blowfish_secret']=sodium_hex2bin('f16ce59f45714194371b48fe362072dc3b019da7861558cd4ad29e4d6fb13851');$i=0;$i++;$cfg['Servers'][$i]['auth_type']='cookie';// if you insist on "root" having no password:// $cfg['Servers'][$i]['AllowNoPassword'] = true;
Or, if you prefer to not be prompted every time you log in:
<?php$i=0;$i++;$cfg['Servers'][$i]['user']='root';$cfg['Servers'][$i]['password']='changeme';// use here your password$cfg['Servers'][$i]['auth_type']='config';
Warning
Storing passwords in the configuration is insecure as anybody can thenmanipulate your database.
For a full explanation of possible configuration values, see theConfiguration of this document.
Using the Setup script
Instead of manually editingconfig.inc.php
, you can use phpMyAdmin’ssetup feature. The file can be generated using the setup and you can download itfor upload to the server.
Next, open your browser and visit the location where you installed phpMyAdmin,with the/setup
suffix. The changes are not saved to the server, you need touse theDownload button to save them to your computer and then uploadto the server.
Now the file is ready to be used. You can choose to review or edit thefile with your favorite editor, if you prefer to set some advancedoptions that the setup script does not provide.
If you are using the
auth_type
“config”, it is suggested that youprotect the phpMyAdmin installation directory because using configdoes not require a user to enter a password to access the phpMyAdmininstallation. Use of an alternate authentication method isrecommended, for example with HTTP–AUTH in a.htaccess file or switch to usingauth_type
cookie or http. See theISPs, multi-user installationsfor additional information, especially4.4 phpMyAdmin always gives “Access denied” when using HTTP authentication..Open the main phpMyAdmin directory in your browser.phpMyAdmin should now display a welcome screen and your databases, ora login dialog if usingHTTP orcookie authentication mode.
Setup script on Debian, Ubuntu and derivatives
Debian and Ubuntu have changed the way in which the setup script is enabled and disabled, in a waythat single command has to be executed for either of these.
To allow editing configuration invoke:
/usr/sbin/pma-configure
To block editing configuration invoke:
/usr/sbin/pma-secure
Setup script on openSUSE
Some openSUSE releases do not include setup script in the package. In case youwant to generate configuration on these you can either download originalpackage from <https://www.phpmyadmin.net/> or use setup script on our demoserver: <https://demo.phpmyadmin.net/master/setup/>.
Verifying phpMyAdmin releases
Since July 2015 all phpMyAdmin releases are cryptographically signed by thereleasing developer, who through January 2016 was Marc Delisle. His key id is0xFEFC65D181AF644A, his PGP fingerprint is:
436F F188 4B1A 0C3F DCBF 0D79 FEFC 65D1 81AF 644A
and you can get more identification information from <https://keybase.io/lem9>.
Beginning in January 2016, the release manager is Isaac Bennetch. His key id is0xCE752F178259BD92, and his PGP fingerprint is:
3D06 A59E CE73 0EB7 1B51 1C17 CE75 2F17 8259 BD92
and you can get more identification information from <https://keybase.io/ibennetch>.
Some additional downloads (for example themes) might be signed by Michal Čihař. His key id is0x9C27B31342B7511D, and his PGP fingerprint is:
63CB 1DF1 EF12 CF2A C0EE 5A32 9C27 B313 42B7 511D
and you can get more identification information from <https://keybase.io/nijel>.
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 youdownloaded the latest version.
Each archive is accompanied by.asc
files which contain the PGP signaturefor it. Once you have both of them in the same folder, you can verify the signature:
$gpg--verifyphpMyAdmin-4.5.4.1-all-languages.zip.ascgpg: Signature made Fri 29 Jan 2016 08:59:37 AM EST using RSA key ID 8259BD92gpg: Can't check signature: public key not found
As you can see gpg complains that it does not know the public key. At thispoint, you should do one of the following steps:
Download the keyring fromour download server, then import it with:
$gpg--importphpmyadmin.keyring
Download and import the key from one of the key servers:
$gpg--keyserverhkp://pgp.mit.edu--recv-keys3D06A59ECE730EB71B511C17CE752F178259BD92gpg: requesting key 8259BD92 from hkp server pgp.mit.edugpg: key 8259BD92: public key "Isaac Bennetch <bennetch@gmail.com>" importedgpg: no ultimately trusted keys foundgpg: Total number processed: 1gpg: imported: 1 (RSA: 1)
This will improve the situation a bit - at this point, you can verify that thesignature from the given key is correct but you still can not trust the name usedin the key:
$gpg--verifyphpMyAdmin-4.5.4.1-all-languages.zip.ascgpg: Signature made Fri 29 Jan 2016 08:59:37 AM EST using RSA key ID 8259BD92gpg: Good signature from "Isaac Bennetch <bennetch@gmail.com>"gpg: aka "Isaac Bennetch <isaac@bennetch.org>"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
The problem here is that anybody could issue the key with this name. You need toensure that the key is actually owned by the mentioned person. The GNU PrivacyHandbook covers this topic in the chapterValidating other keys on your publickeyring. The most reliable method is to meet the developer in person andexchange key fingerprints, however, you can also rely on the web of trust. This wayyou can trust the key transitively though signatures of others, who have metthe developer in person.
Once the key is trusted, the warning will not occur:
$gpg--verifyphpMyAdmin-4.5.4.1-all-languages.zip.ascgpg: Signature made Fri 29 Jan 2016 08:59:37 AM EST using RSA key ID 8259BD92gpg: Good signature from "Isaac Bennetch <bennetch@gmail.com>" [full]
Should the signature be invalid (the archive has been changed), you would get aclear error regardless of the fact that the key is trusted or not:
$gpg--verifyphpMyAdmin-4.5.4.1-all-languages.zip.ascgpg: Signature made Fri 29 Jan 2016 08:59:37 AM EST using RSA key ID 8259BD92gpg: BAD signature from "Isaac Bennetch <bennetch@gmail.com>" [unknown]
phpMyAdmin configuration storage
Changed in version 3.4.0:Prior to phpMyAdmin 3.4.0 this was called Linked Tables Infrastructure, butthe name was changed due to the extended scope of the storage.
For a whole set of additional features (Bookmarks, comments,SQL-history,tracking mechanism,PDF-generation,Transformations,Relationsetc.) you need to create a set of special tables. Those tables can be locatedin 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 usershould have rights to it).
Zero configuration
In many cases, this database structure can be automatically created andconfigured. This is called “Zero Configuration” mode and can be particularlyuseful in shared hosting situations. “Zeroconf” mode is on by default, todisable set$cfg['ZeroConf']
to false.
The following three scenarios are covered by the Zero Configuration mode:
When entering a database where the configuration storage tables are notpresent, phpMyAdmin offers to create them from the Operations tab.
When entering a database where the tables do already exist, the softwareautomatically detects this and begins using them. This is the most commonsituation; after the tables are initially created automatically they arecontinually used without disturbing the user; this is also most useful onshared hosting where the user is not able to edit
config.inc.php
andusually the user only has access to one database.When having access to multiple databases, if the user first enters thedatabase containing the configuration storage tables then switches toanother database,phpMyAdmin continues to use the tables from the first database; the user isnot prompted to create more tables in the new database.
Manual configuration
Please look at your./sql/
directory, where you should find afile calledcreate_tables.sql. (If you are using a Windows server,pay special attention to1.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!).
If you already had this infrastructure and:
upgraded to MySQL 4.1.2 or newer, please use
sql/upgrade_tables_mysql_4_1_2+.sql
.upgraded to phpMyAdmin 4.3.0 or newer from 2.5.0 or newer (<= 4.2.x),please use
sql/upgrade_column_info_4_3_0+.sql
.upgraded to phpMyAdmin 4.7.0 or newer from 4.3.0 or newer,please use
sql/upgrade_tables_4_7_0+.sql
.
and then create new tables by importingsql/create_tables.sql
.
You can use your phpMyAdmin to create the tables for you. Please beaware that you may need special (administrator) privileges to createthe database and tables, and that the script may need some tuning,depending on the database name.
After having imported thesql/create_tables.sql
file, youshould specify the table names in yourconfig.inc.php
file. Thedirectives used for that can be found in theConfiguration.
You will also need to have a controluser($cfg['Servers'][$i]['controluser']
and$cfg['Servers'][$i]['controlpass']
settings)with the proper rights to those tables. For example you can create itusing following statement:
And for any MariaDB version:
CREATEUSER'pma'@'localhost'IDENTIFIEDVIAmysql_native_passwordUSING'pmapass';GRANTSELECT,INSERT,UPDATE,DELETEON`<pma_db>`.*TO'pma'@'localhost';
For MySQL 8.0 and newer:
CREATEUSER'pma'@'localhost'IDENTIFIEDWITHcaching_sha2_passwordBY'pmapass';GRANTSELECT,INSERT,UPDATE,DELETEON<pma_db>.*TO'pma'@'localhost';
For MySQL older than 8.0:
CREATEUSER'pma'@'localhost'IDENTIFIEDWITHmysql_native_passwordAS'pmapass';GRANTSELECT,INSERT,UPDATE,DELETEON<pma_db>.*TO'pma'@'localhost';
Note that MySQL installations with PHP older than 7.4 and MySQL newer than 8.0 may requireusing the mysql_native_password authentication as a workaround, see1.45 I get an error message about unknown authentication method caching_sha2_password when trying to log in for details.
Upgrading from an older version
Warning
Never extract the new version over an existing installation ofphpMyAdmin, always first remove the old files keeping just theconfiguration.
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.
Simply copyconfig.inc.php
from your previous installation intothe newly unpacked one. Configuration files from old versions mayrequire some tweaking as some options have been changed or removed.For compatibility with PHP 5.3 and later, remove aset_magic_quotes_runtime(0);
statement that you might find nearthe end of your configuration file.
The complete upgrade can be performed in a few simple steps:
Download the latest phpMyAdmin version from <https://www.phpmyadmin.net/downloads/>.
Rename existing phpMyAdmin folder (for example to
phpmyadmin-old
).Unpack freshly downloaded phpMyAdmin to the desired location (for example
phpmyadmin
).Copy
config.inc.php`
from old location (phpmyadmin-old
) to the new one (phpmyadmin
).Test that everything works properly.
Remove backup of a previous version (
phpmyadmin-old
).
If you have upgraded your MySQL server from a version previous to 4.1.2 toversion 5.x or newer and if you use the phpMyAdmin configuration storage, youshould run theSQL script found insql/upgrade_tables_mysql_4_1_2+.sql
.
If you have upgraded your phpMyAdmin to 4.3.0 or newer from 2.5.0 ornewer (<= 4.2.x) and if you use the phpMyAdmin configuration storage, youshould run theSQL script found insql/upgrade_column_info_4_3_0+.sql
.
Do not forget to clear the browser cache and to empty the old session bylogging out and logging in again.
Using authentication modes
HTTP and cookie authentication modes are recommended in amulti-userenvironment where you want to give users access to their own database anddon’t want them to play around with others. Nevertheless, be aware that MSInternet Explorer seems to be really buggy about cookies, at least till version6. Even in asingle-user environment, you might prefer to useHTTPor cookie mode so that your user/password pair are not in clear in theconfiguration file.
HTTP and cookie authenticationmodes are more secure: the MySQL login information does not need to beset in the phpMyAdmin configuration file (except possibly for the$cfg['Servers'][$i]['controluser']
).However, keep in mind that the password travels in plain text unlessyou are using the HTTPS protocol. In cookie mode, the password isstored, encrypted with the AES algorithm, in a temporary cookie.
Then each of thetrue users should be granted a set of privilegeson a set of particular databases. Normally you shouldn’t give globalprivileges to an ordinary user unless you understand the impact of thoseprivileges (for example, you are creating a superuser).For example, to grant the userreal_user with all privileges onthe databaseuser_base:
GRANTALLPRIVILEGESONuser_base.*TO'real_user'@localhostIDENTIFIEDBY'real_password';
What the user may now do is controlled entirely by the MySQL user managementsystem. With HTTP or cookie authentication mode, you don’t need to fill theuser/password fields inside the$cfg['Servers']
.
See also
1.32 Can I use HTTP authentication with IIS?,1.35 Can I use HTTP authentication with Apache CGI?,4.1 I’m an ISP. Can I setup one central copy of phpMyAdmin or do I need to install it for each customer?,4.2 What’s the preferred way of making phpMyAdmin secure against evil access?,4.3 I get errors about not being able to include a file in /lang or in /libraries.
HTTP authentication mode
UsesHTTP Basic authenticationmethod and allows you to log in as any valid MySQL user.
Is supported with most PHP configurations. ForIIS (ISAPI)support usingCGI PHP see1.32 Can I use HTTP authentication with IIS?, for using with ApacheCGI see1.35 Can I use HTTP authentication with Apache CGI?.
When PHP is running under Apache’smod_proxy_fcgi (e.g. with PHP-FPM),
Authorization
headers are not passed to the underlying FCGI application,such that your credentials will not reach the application. In this case, you canadd the following configuration directive:SetEnvIfAuthorization"(.*)"HTTP_AUTHORIZATION=$1
See also4.4 phpMyAdmin always gives “Access denied” when using HTTP authentication. about not using the.htaccess mechanism along with‘HTTP’ authentication mode.
Note
There is no way to do proper logout in HTTP authentication, most browserswill remember credentials until there is no different successfulauthentication. Because of this, this method has a limitation that you can notlogin with the same user after logout.
Cookie authentication mode
Username and password are stored in cookies during the session and passwordis deleted when it ends.
With this mode, the user can truly log out of phpMyAdmin and logback in with the same username (this is not possible withHTTP authentication mode).
If you want to allow users to enter any hostname to connect (rather than onlyservers that are configured in
config.inc.php
),see the$cfg['AllowArbitraryServer']
directive.As mentioned in theRequirements section, having the
openssl
extensionwill speed up access considerably, but is not required.
Signon authentication mode
This mode is a convenient way of using credentials from anotherapplication to authenticate to phpMyAdmin to implement a single signonsolution.
The other application has to store login information into sessiondata (see
$cfg['Servers'][$i]['SignonSession']
and$cfg['Servers'][$i]['SignonCookieParams']
) or youneed to implement script to return the credentials (see$cfg['Servers'][$i]['SignonScript']
).When no credentials are available, the user is being redirected to
$cfg['Servers'][$i]['SignonURL']
, where you should handlethe login process.
The very basic example of saving credentials in a session is available asexamples/signon.php
:
<?php/** * 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. */declare(strict_types=1);/* Use cookies for session */ini_set('session.use_cookies','true');/* 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,'/','',$secure_cookie,true);/* Create signon session */$session_name='SignonSession';session_name($session_name);// Uncomment and change the following line to match your $cfg['SessionSavePath']//session_save_path('/foobar');@session_start();/* Was data posted? */if(isset($_POST['user'])){/* Store there credentials */$_SESSION['PMA_single_signon_user']=$_POST['user'];$_SESSION['PMA_single_signon_password']=$_POST['password'];$_SESSION['PMA_single_signon_host']=$_POST['host'];$_SESSION['PMA_single_signon_port']=$_POST['port'];/* Update another field of server configuration */$_SESSION['PMA_single_signon_cfgupdate']=['verbose'=>'Signon test'];$_SESSION['PMA_single_signon_HMAC_secret']=hash('sha1',uniqid(strval(random_int(0,mt_getrandmax())),true));$id=session_id();/* Close that session */@session_write_close();/* Redirect to phpMyAdmin (should use absolute URL here!) */header('Location: ../index.php');}else{/* Show simple form */header('Content-Type: text/html; charset=utf-8');echo'<?xml version="1.0" encoding="utf-8"?>'."\n";echo'<!DOCTYPE HTML><html lang="en" dir="ltr"><head><link rel="icon" href="../favicon.ico" type="image/x-icon"><link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"><meta charset="utf-8"><title>phpMyAdmin single signon example</title></head><body>';if(isset($_SESSION['PMA_single_signon_error_message'])){echo'<p class="error">';echo$_SESSION['PMA_single_signon_error_message'];echo'</p>';}echo'<form action="signon.php" method="post">Username: <input type="text" name="user" autocomplete="username" spellcheck="false"><br>Password: <input type="password" name="password" autocomplete="current-password" spellcheck="false"><br>Host: (will use the one from config.inc.php by default)<input type="text" name="host"><br>Port: (will use the one from config.inc.php by default)<input type="text" name="port"><br><input type="submit"></form></body></html>';}
Alternatively, you can also use this way to integrate with OpenID as showninexamples/openid.php
:
<?php/** * 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. */declare(strict_types=1);if(false===@include_once'OpenID/RelyingParty.php'){exit;}/* Change this to true if using phpMyAdmin over https */$secure_cookie=false;/** * Map of authenticated users to MySQL user/password pairs. */$AUTH_MAP=['https://launchpad.net/~username'=>['user'=>'root','password'=>'',],];// phpcs:disable PSR1.Files.SideEffects,Squiz.Functions.GlobalFunction/** * Simple function to show HTML page with given content. * * @param string $contents Content to include in page */functionShow_page($contents):void{header('Content-Type: text/html; charset=utf-8');echo'<?xml version="1.0" encoding="utf-8"?>'."\n";echo'<!DOCTYPE HTML><html lang="en" dir="ltr"><head><link rel="icon" href="../favicon.ico" type="image/x-icon"><link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"><meta charset="utf-8"><title>phpMyAdmin OpenID signon example</title></head><body>';if(isset($_SESSION['PMA_single_signon_error_message'])){echo'<p class="error">'.$_SESSION['PMA_single_signon_message'].'</p>';unset($_SESSION['PMA_single_signon_message']);}echo$contents;echo'</body></html>';}/** * Display error and exit * * @param Exception $e Exception object */functionDie_error($e):void{$contents="<div class='relyingparty_results'>\n";$contents.='<pre>'.htmlspecialchars($e->getMessage())."</pre>\n";$contents.="</div class='relyingparty_results'>";Show_page($contents);exit;}// phpcs:enable/* Need to have cookie visible from parent directory */session_set_cookie_params(0,'/','',$secure_cookie,true);/* Create signon session */$session_name='SignonSession';session_name($session_name);@session_start();// Determine realm and return_to$base='http';if(isset($_SERVER['HTTPS'])&&$_SERVER['HTTPS']==='on'){$base.='s';}$base.='://'.$_SERVER['SERVER_NAME'].':'.$_SERVER['SERVER_PORT'];$realm=$base.'/';$returnTo=$base.dirname($_SERVER['PHP_SELF']);if($returnTo[strlen($returnTo)-1]!=='/'){$returnTo.='/';}$returnTo.='openid.php';/* Display form */if((!count($_GET)&&!count($_POST))||isset($_GET['phpMyAdmin'])){/* Show simple form */$content='<form action="openid.php" method="post">OpenID: <input type="text" name="identifier"><br><input type="submit" name="start"></form>';Show_page($content);exit;}/* Grab identifier */$identifier=null;if(isset($_POST['identifier'])&&is_string($_POST['identifier'])){$identifier=$_POST['identifier'];}elseif(isset($_SESSION['identifier'])&&is_string($_SESSION['identifier'])){$identifier=$_SESSION['identifier'];}/* Create OpenID object */try{$o=newOpenID_RelyingParty($returnTo,$realm,$identifier);}catch(Throwable$e){Die_error($e);}/* Redirect to OpenID provider */if(isset($_POST['start'])){try{$authRequest=$o->prepare();}catch(Throwable$e){Die_error($e);}$url=$authRequest->getAuthorizeURL();header('Location: '.$url);exit;}/* Grab query string */if(!count($_POST)){[,$queryString]=explode('?',$_SERVER['REQUEST_URI']);}else{// Fetch the raw query body$queryString=file_get_contents('php://input');}/* Check reply */try{$message=newOpenID_Message($queryString,OpenID_Message::FORMAT_HTTP);}catch(Throwable$e){Die_error($e);}$id=$message->get('openid.claimed_id');if(empty($id)||!isset($AUTH_MAP[$id])){Show_page('<p>User not allowed!</p>');exit;}$_SESSION['PMA_single_signon_user']=$AUTH_MAP[$id]['user'];$_SESSION['PMA_single_signon_password']=$AUTH_MAP[$id]['password'];$_SESSION['PMA_single_signon_HMAC_secret']=hash('sha1',uniqid(strval(random_int(0,mt_getrandmax())),true));session_write_close();/* Redirect to phpMyAdmin (should use absolute URL here!) */header('Location: ../index.php');
If you intend to pass the credentials using some other means than, you have toimplement wrapper in PHP to get that data and set it to$cfg['Servers'][$i]['SignonScript']
. There is a very minimal exampleinexamples/signon-script.php
:
<?php/** * 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. */declare(strict_types=1);// phpcs:disable Squiz.Functions.GlobalFunction/** * This function returns username and password. * * It can optionally use configured username as parameter. * * @param string $user User name * * @return array */functionget_login_credentials($user){/* Optionally we can use passed username */if(!empty($user)){return[$user,'password',];}/* Here we would retrieve the credentials */return['root','',];}
Config authentication mode
This mode is sometimes the less secure one because it requires you to fill the
$cfg['Servers'][$i]['user']
and$cfg['Servers'][$i]['password']
fields (and as a result, anyone who can read yourconfig.inc.php
can discover your username and password).In theISPs, multi-user installations section, there is an entry explaining howto protect your configuration file.
For additional security in this mode, you may wish to consider theHost authentication
$cfg['Servers'][$i]['AllowDeny']['order']
and$cfg['Servers'][$i]['AllowDeny']['rules']
configuration directives.Unlike cookie and http, does not require a user to log in when firstloading the phpMyAdmin site. This is by design but could allow anyuser to access your installation. Use of some restriction method issuggested, perhaps a.htaccess file with the HTTP-AUTH directive or disallowingincoming HTTP requests at one’s router or firewall will suffice (bothof which are beyond the scope of this manual but easily searchablewith Google).
Securing your phpMyAdmin installation
The phpMyAdmin team tries hard to make the application secure, however thereare always ways to make your installation more secure:
Follow ourSecurity announcements and upgradephpMyAdmin whenever new vulnerability is published.
Serve phpMyAdmin on HTTPS only. Preferably, you should use HSTS as well, so thatyou’re protected from protocol downgrade attacks.
Ensure your PHP setup follows recommendations for production sites, for exampledisplay_errorsshould be disabled.
Remove the
test
directory from phpMyAdmin, unless you are developing and need a test suite.Remove the
setup
directory from phpMyAdmin, you will probably notuse it after the initial setup.Properly choose an authentication method -Cookie authentication modeis probably the best choice for shared hosting.
Deny access to auxiliary files in
./libraries/
or./templates/
subfolders in your webserver configuration.Such configuration prevents from possible path exposure and cross sidescripting vulnerabilities that might happen to be found in that code. For theApache webserver, this is often accomplished with a.htaccess file inthose directories.Deny access to temporary files, see
$cfg['TempDir']
(if thatis placed inside your web root, see alsoWeb server upload/save/import directories.It is generally a good idea to protect a public phpMyAdmin installationagainst access by robots as they usually can not do anything good there. Youcan do this using
robots.txt
file in the root of your webserver or limitaccess by web server configuration, see1.42 How can I prevent robots from accessing phpMyAdmin?.In case you don’t want all MySQL users to be able to accessphpMyAdmin, you can use
$cfg['Servers'][$i]['AllowDeny']['rules']
to limit themor$cfg['Servers'][$i]['AllowRoot']
to deny root user access.EnableTwo-factor authentication for your account.
Consider hiding phpMyAdmin behind an authentication proxy, so thatusers need to authenticate prior to providing MySQL credentialsto phpMyAdmin. You can achieve this by configuring your web server to requestHTTP authentication. For example in Apache this can be done with:
AuthTypeBasicAuthName"Restricted Access"AuthUserFile/usr/share/phpmyadmin/passwdRequirevalid-user
Once you have changed the configuration, you need to create a list of users whichcan authenticate. This can be done using thehtpasswd utility:
htpasswd-c/usr/share/phpmyadmin/passwdusername
If you are afraid of automated attacks, enabling Captcha by
$cfg['CaptchaLoginPublicKey']
and$cfg['CaptchaLoginPrivateKey']
might be an option.Failed login attempts are logged to syslog (if available, see
$cfg['AuthLog']
). This can allow using a tool such asfail2ban to block brute-force attempts. Note that the log file used by syslogis not the same as the Apache error or access log files.In case you’re running phpMyAdmin together with other PHP applications, it isgenerally advised to use separate session storage for phpMyAdmin to avoidpossible session-based attacks against it. You can use
$cfg['SessionSavePath']
to achieve this.
Using SSL for connection to database server
It is recommended to use SSL when connecting to remote database server. Thereare several configuration options involved in the SSL setup:
$cfg['Servers'][$i]['ssl']
Defines whether to use SSL at all. If you enable only this, the connectionwill be encrypted, but there is not authentication of the connection - youcan not verify that you are talking to the right server.
$cfg['Servers'][$i]['ssl_key']
and$cfg['Servers'][$i]['ssl_cert']
This is used for authentication of client to the server.
$cfg['Servers'][$i]['ssl_ca']
and$cfg['Servers'][$i]['ssl_ca_path']
The certificate authorities you trust for server certificates.This is used to ensure that you are talking to a trusted server.
$cfg['Servers'][$i]['ssl_verify']
This configuration disables server certificate verification. Use withcaution.
When the database server is using a local connection or private network and SSL can not be configuredyou can use$cfg['MysqlSslWarningSafeHosts']
to explicitly list the hostnames that are considered secure.
Known issues
Users with column-specific privileges are unable to “Browse”
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 willrun when using the “Browse” link instead.Issue 11922.
Trouble logging back in after logging out using ‘http’ authentication
When using the ‘http’auth_type
, it can be impossible to log back in (when the logout comesmanually or after a period of inactivity).Issue 11898.