Home Explore Help
Register Sign In
Apq
/
nextcloud-docs
mirror of https://github.com/docker-library/docs.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: 54bbfcba6f
Branches Tags
nextcloud-docs
/
phpmyadmin
/
README.md

README.md 11 KB
History Raw

Quick reference

Supported tags and respective Dockerfile links

Quick reference (cont.)

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.

logo

How to use this image

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

Credentials

phpMyAdmin does use MySQL server credential, please check the corresponding server image for information how it is setup.

The official MySQL and MariaDB use 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-alpine. Note that, on rare occasion, here may be an intermediary "docker-only" release, such as 4.9.2-1

Usage with linked server

First you need to run MySQL or MariaDB server in Docker, and this image need link a running mysql instance container:

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

Usage with external server

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

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

Usage with arbitrary server

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

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

Usage with docker-compose and arbitrary server

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

... via docker stack deploy or docker-compose

Example stack.yml for phpmyadmin:

version: '3.1'

services:
  db:
    image: mariadb:10.3
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: notSecureChangeMe

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

Try in PWD

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 -v /some/local/directory/config.user.inc.php:/etc/phpmyadmin/config.user.inc.php.

On the docker run line like this:

$ docker run --name myadmin -d --link mysql_db_server:db -p 8080:80 -v /some/local/directory/config.user.inc.php:/etc/phpmyadmin/config.user.inc.php phpmyadmin

See the following links for config file information:

Usage behind reverse proxys

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

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_USER and PMA_PASSWORD - define username to use for config authentication method
  • PMA_ABSOLUTE_URI - define user-facing URI
  • HIDE_PHP_VERSION - if defined, will hide the php version (expose_php = Off). Set to any value (such as HIDE_PHP_VERSION=true).
  • UPLOAD_LIMIT - if set, will override the default value for apache and php-fpm (default value is 2048 kb)
  • PMA_CONFIG_BASE64 - if set, will override the default config.inc.php with the base64 decoded contents of the variable
  • PMA_USER_CONFIG_BASE64 - if set, will override the default config.user.inc.php with the base64 decoded contents of the variable

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

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

Variables that can be read from a file using _FILE

  • PMA_PASSWORD
  • MYSQL_ROOT_PASSWORD
  • MYSQL_PASSWORD
  • PMA_HOSTS
  • PMA_HOST

For more detailed documentation see https://docs.phpmyadmin.net/en/latest/setup.html#installing-using-docker

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 the alpine official image. 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 alpine image description for examples of how to install packages if you are unfamiliar).

License

View license information 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 the repo-info repository's phpmyadmin/ directory.

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.