library/phpmyadmin

Quick reference

• Maintained by:
  https://github.com/phpmyadmin/docker

• Where to get help:
  the Docker Community Slack, Server Fault, Unix & Linux, or Stack Overflow

Supported tags and respective Dockerfile links

• https://github.com/phpmyadmin/docker/blob/452a995fe6c90b96473fc17c3d704786c33d42bc/apache/Dockerfile

• https://github.com/phpmyadmin/docker/blob/452a995fe6c90b96473fc17c3d704786c33d42bc/fpm/Dockerfile

• https://github.com/phpmyadmin/docker/blob/452a995fe6c90b96473fc17c3d704786c33d42bc/fpm-alpine/Dockerfile

Quick reference (cont.)

• Where to file issues:
  https://github.com/phpmyadmin/docker/issues?q=

• Supported architectures: (https://github.com/docker-library/official-images#architectures-other-than-amd64)
  https://hub.docker.com/r/amd64/phpmyadmin/, https://hub.docker.com/r/arm32v5/phpmyadmin/, https://hub.docker.com/r/arm32v6/phpmyadmin/, https://hub.docker.com/r/arm32v7/phpmyadmin/, https://hub.docker.com/r/arm64v8/phpmyadmin/, https://hub.docker.com/r/i386/phpmyadmin/, https://hub.docker.com/r/ppc64le/phpmyadmin/, https://hub.docker.com/r/riscv64/phpmyadmin/, https://hub.docker.com/r/s390x/phpmyadmin/

• Published image artifact details:
  https://github.com/docker-library/repo-info/blob/master/repos/phpmyadmin (https://github.com/docker-library/repo-info/commits/master/repos/phpmyadmin)
  (image metadata, transfer size, etc)

• Image updates:
  https://github.com/docker-library/official-images/issues?q=label%3Alibrary%2Fphpmyadmin
  https://github.com/docker-library/official-images/blob/master/library/phpmyadmin (https://github.com/docker-library/official-images/commits/master/library/phpmyadmin)

• Source of this description:
  https://github.com/docker-library/docs/tree/master/phpmyadmin (https://github.com/docker-library/docs/commits/master/phpmyadmin)

What is phpMyAdmin?

phpMyAdmin is a free software tool written in PHP, intended to handle the administration of MySQL over the Web. phpMyAdmin supports a wide range of operations on MySQL and MariaDB. Frequently used operations (managing databases, tables, columns, relations, indexes, users, permissions, etc) can be performed via the user interface, while you still have the ability to directly execute any SQL statement.

Run phpMyAdmin with Alpine, Apache and PHP FPM.

!https://raw.githubusercontent.com/docker-library/docs/1a06458dd2512b5bcda0a849738bb5ca32bf8ec0/phpmyadmin/logo.png

How to use this image

All of the following examples will bring you phpMyAdmin on http://localhost:8080 where you can enjoy your happy MySQL and MariaDB administration.

Credentials

phpMyAdmin connects using your MySQL server credentials. Please check your corresponding database server image for information on the default username and password or how to specify your own custom credentials during installation.

The official MySQL and MariaDB images use the following environment variables to define these:

• MYSQL_ROOT_PASSWORD - This variable is mandatory and specifies the password that will be set for the root superuser account.
• MYSQL_USER, MYSQL_PASSWORD - These variables are optional, used in conjunction to create a new user and to set that user's password.

Supported Docker Hub tags

The following tags are available:

• latest, fpm, and fpm-alpine are always the most recent released version
• Major versions, such as 5, 5-fpm, and 5-fpm-alpine
• Specific minor versions, such as 5.0, 5.0-fpm, and 5-fpm-alpine
• Specific patch versions, such as 5.0.0, 5.0.0-fpm, and 5.0.0-fpm-alpine. Note that, on rare occasion, there may be an intermediary "docker-only" release, such as 4.9.2-1

A complete list of tags is https://hub.docker.com/_/phpmyadmin?tab=tags

Image variants

We provide three variations:

• "apache" includes a full Apache webserver with PHP and includes everything needed to work out of the box. This is the default when only a version number is requested.
• "fpm" only starts a PHP FPM container. Use this variant if you already have a separate webserver. This includes more tools and is therefore a larger image than the "fpm-alpine" variation.
• "fpm-alpine" has a very small footprint. It is based on Alpine Linux and only starts a PHP FPM process. Use this variant if you already have a separate webserver. If you need more tools that are not available on Alpine Linux, use the fpm image instead.

Usage with linked server

First you need to run a MySQL or MariaDB server in Docker, and the phpMyAdmin image needs to be linked to the running database container:

sh
docker run --name phpmyadmin -d --link mysql_db_server:db -p 8080:80 phpmyadmin

Usage with external server

You can specify a MySQL host in the PMA_HOST environment variable. You can also use PMA_PORT to specify the port of the server in case it's not the default one:

sh
docker run --name phpmyadmin -d -e PMA_HOST=dbhost -p 8080:80 phpmyadmin

Usage with arbitrary server

You can use arbitrary servers by adding the environment variable PMA_ARBITRARY=1 to the startup command:

sh
docker run --name phpmyadmin -d -e PMA_ARBITRARY=1 -p 8080:80 phpmyadmin

Usage with docker compose and an arbitrary server

This will run phpMyAdmin with the arbitrary server option - allowing you to specify any MySQL/MariaDB server on the login page.

... via https://github.com/docker/compose

Example compose.yaml for phpmyadmin:

yaml
services:
  db:
    image: mariadb:10.11
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: notSecureChangeMe

  phpmyadmin:
    image: phpmyadmin
    restart: always
    ports:
      - 8080:80
    environment:
      - PMA_ARBITRARY=1

Adding Custom Configuration

You can add your own custom config.inc.php settings (such as Configuration Storage setup) by creating a file named config.user.inc.php with the various user defined settings in it, and then linking it into the container using:

sh
-v /some/local/directory/config.user.inc.php:/etc/phpmyadmin/config.user.inc.php

On the docker run line like this:

sh
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

Be sure to have <?php as your first line of the configuration file or the contents will not be detected as PHP code.

Example:

php
<?php

$cfg['ShowPhpInfo'] = true; // Adds a link to phpinfo() on the home page

See the following links for config file information:

• [***]
• [***]

Adding custom configuration in /etc/phpmyadmin/conf.d

you can also *** storing your custom configuration files in the folder /etc/phpmyadmin/conf.d, which is very suitable for managing multiple phpMyAdmin configuration files for different hosts,Then you can create server-1.php, server-2.php, or any file name you want, and store them in the conf.d directory mounted on the host.

On the docker run line like this:

sh
docker run --name phpmyadmin -d --link mysql_db_server:db -p 8080:80 -v /some/local/directory/conf.d:/etc/phpmyadmin/conf.d:ro phpmyadmin

Usage behind a reverse proxy

Set the variable PMA_ABSOLUTE_URI to the fully-qualified path (https://pma.example.net/) where the reverse proxy makes phpMyAdmin available.

Sessions persistence

In order to keep your sessions active between container updates you will need to mount the /sessions folder.

sh
-v /some/local/directory/sessions:/sessions:rw

Connect to the database over SSL

Set the variable PMA_SSL to 1 to enable SSL usage from phpMyAdmin to the MySQL server. The default value is 0. The variable PMA_SSLS can be used as a comma seperated sequence of 0 and 1 where multiple hosts are mentioned. Values order must follow the PMA_HOSTS and will be computed accordingly.

sh
docker run --name phpmyadmin -d -e PMA_HOSTS=sslhost -e PMA_SSL=1 -p 8080:80 phpmyadmin

sh
docker run --name phpmyadmin -d -e PMA_HOSTS='sslhost,nosslhost' -e PMA_SSLS='1,0' -p 8080:80 phpmyadmin

Environment variables summary

• PMA_ARBITRARY - when set to 1 connection to the arbitrary server will be allowed
• PMA_HOST - define address/host name of the MySQL server
• PMA_VERBOSE - define verbose name of the MySQL server
• PMA_PORT - define port of the MySQL server
• PMA_HOSTS - define comma separated list of address/host names of the MySQL servers
• PMA_VERBOSES - define comma separated list of verbose names of the MySQL servers
• PMA_PORTS - define comma separated list of ports of the MySQL servers
• PMA_SOCKET - define socket file for the MySQL connection
• PMA_SOCKETS - define comma separated list of socket files for the MySQL connections
• PMA_SSL_DIR - define the path used for SSL files generated from environement variables, default value is /etc/phpmyadmin/ssl
• PMA_SSL - when set to 1, defines SSL usage for the MySQL connection
• PMA_SSLS - comma separated list of 0 and 1 defining SSL usage for the corresponding MySQL connections
• PMA_SSL_VERIFY - when set to 1, enables SSL certificate verification for the MySQL connection.
• PMA_SSL_VERIFIES - comma-separated list of 0 and 1 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 certificate file as a string inside the default config.inc.php.
• PMA_SSL_CAS - in the context of mutual TLS security, allows setting multiple CA certificate files as a comma-separated list of strings inside the default config.inc.php.
• PMA_SSL_CERT - in the context of mutual TLS security, allows setting your certificate file as a string inside the default config.inc.php.
• PMA_SSL_CERTS - in the context of mutual TLS security, allows setting multiple certificate files as a comma-separated list of strings inside the default config.inc.php.
• PMA_SSL_KEY - in the context of mutual TLS security, allows setting your private key file as a string inside the default config.inc.php.
• PMA_SSL_KEYS - in the context of mutual TLS security, allows setting multiple private key files as a comma-separated list of strings inside the default config.inc.php.
• PMA_USER and PMA_PASSWORD - define username and password to use only with the config authentication method
• PMA_ABSOLUTE_URI - the full URL to phpMyAdmin. Sometimes needed when used in a reverse-proxy configuration. Don't set this unless needed. See documentation.
• PMA_CONFIG_BASE64 - if set, this option will override the default config.inc.php with the base64 decoded contents of the variable
• PMA_USER_CONFIG_BASE64 - if set, this option will override the default config.user.inc.php with the base64 decoded contents of the variable
• PMA_UPLOADDIR - if defined, this option will set the path where files can be saved to be available to import ([$cfg['UploadDir']]([***]
• PMA_SAVEDIR - if defined, this option will set the path where exported files can be saved ([$cfg['SaveDir']]([***]
• PMA_CONTROLHOST - when set, this points to an alternate database host used for storing the phpMyAdmin Configuration Storage database database
• PMA_CONTROLPORT - if set, will override the default port (3306) for connecting to the control host for storing the phpMyAdmin Configuration Storage database database
• PMA_PMADB - 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 the zero conf (zero configuration) feature. Suggested values: phpmyadmin or pmadb
• PMA_CONTROLUSER - define the username for phpMyAdmin to use for advanced features (the controluser)
• PMA_CONTROLPASS - define the password for phpMyAdmin to use with the controluser
• PMA_QUERYHISTORYDB - when set to true, enables storing SQL history to the phpMyAdmin Configuration Storage database. When false, history is stored in the browser and is cleared when logging out
• PMA_QUERYHISTORYMAX - when set to an integer, controls the number of history items. See documentation. Defaults to 25.
• MAX_EXECUTION_TIME - if set, will override the maximum execution time in seconds (default 600) for phpMyAdmin ([$cfg['ExecTimeLimit']]([***] and PHP max_execution_time (format as [0-9+])
• MEMORY_LIMIT - if set, will override the memory limit (default 512M) for phpMyAdmin ([$cfg['MemoryLimit']]([***] and PHP memory_limit (format as [0-9+](K,M,G) where K is for Kilobytes, M for Megabytes, G for Gigabytes and 1K = 1024 bytes)
• UPLOAD_LIMIT - if set, this option will override the default value for apache and php-fpm (format as [0-9+](K,M,G) default value is 2048K, this will change upload_max_filesize and post_max_size values)
• TZ - if defined, this option will change the default PHP date.timezone from UTC. See documentation for supported values.
• HIDE_PHP_VERSION - if defined, this option will hide the PHP version (expose_php = Off). Set to any value (such as HIDE_PHP_VERSION=true).
• APACHE_PORT - if defined, this option will change the default Apache port from 80 in case you want it to run on a different port like an unprivileged port. Set to any port value (such as APACHE_PORT=8090)

For usage with Docker secrets, appending _FILE to the PMA_PASSWORD environment variable is allowed (it overrides PMA_PASSWORD if it is set):

sh
docker run --name phpmyadmin -d -e PMA_PASSWORD_FILE=/run/secrets/db_password.txt -p 8080:80 phpmyadmin

Variables that can store the file contents using _BASE64

• PMA_SSL_CA
• PMA_SSL_CAS
• PMA_SSL_KEY
• PMA_SSL_KEYS
• PMA_SSL_CERT
• PMA_SSL_CERTS

Also includes: PMA_CONFIG_BASE64 or PMA_USER_CONFIG_BASE64.

For example, the variable would be named PMA_SSL_CA_BASE64 and the value is the base64 encoded contents of the file.

Variables that can be read from a file using _FILE

• MYSQL_ROOT_PASSWORD
• MYSQL_PASSWORD
• PMA_USER
• PMA_PASSWORD
• PMA_HOSTS
• PMA_HOST
• PMA_CONTROLHOST
• PMA_CONTROLUSER
• PMA_CONTROLPASS

For more detailed documentation see [***]

Please report any issues with the Docker container to https://github.com/phpmyadmin/docker/issues

Please report any issues with phpMyAdmin to https://github.com/phpmyadmin/phpmyadmin/issues

Image Variants

The phpmyadmin images come in many flavors, each designed for a specific use case.

phpmyadmin:<version>

This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.

phpmyadmin:<version>-alpine

This image is based on the popular Alpine Linux project, available in https://hub.docker.com/_/alpine. Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.

This variant is useful when final image size being as small as possible is your primary concern. The main caveat to note is that it does use musl libc instead of glibc and friends, so software will often run into issues depending on the depth of their libc requirements/assumptions. See this Hacker News comment thread for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.

To minimize image size, it's uncommon for additional related tools (such as git or bash) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the https://hub.docker.com/_/alpine/ for examples of how to install packages if you are unfamiliar).

License

View https://github.com/phpmyadmin/docker/blob/master/LICENSE for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be auto-detected might be found in https://github.com/docker-library/repo-info/tree/master/repos/phpmyadmin.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.