phpMyAdmin

phpMyAdmin is a free and open source administration tool for MySQL and MariaDB. As a portable web application written primarily in PHP, it has become one of the most popular MySQL/MariaDB administration tools, especially for web hosting services.

wikipedia.org/wiki/PhpMyAdmin

How to use this Makejail

All of the following examples will bring you phpMyAdmin on http://phpmyadmin/ 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.

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:

$ appjail oci run -Pd \
    -o overwrite=force \
    -o virtualnet=":<random> default" \
    -o nat \
    -e PMA_HOST=dbhost \
    ghcr.io/appjail-makejails/phpmyadmin phpmyadmin

Usage with arbitrary server

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

$ appjail oci run -Pd \
    -o overwrite=force \
    -o virtualnet=":<random> default" \
    -o nat \
    -e PMA_ARBITRARY=1 \
    ghcr.io/appjail-makejails/phpmyadmin phpmyadmin

Usage with appjail-director 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 appjail-director

Example appjail-director.yml for phpmyadmin:

options:
  - virtualnet: ':<random> default'
  - nat:

services:
  db:
    name: mariadb
    makejail: gh+AppJail-makejails/mariadb
    oci:
      environment:
        - MYSQL_ROOT_PASSWORD: notSecureChangeMe
    options:
      - container: 'boot args:--pull'

  phpmyadmin:
    name: phpmyadmin
    makejail: gh+AppJail-makejails/phpmyadmin
    oci:
      environment:
        - PMA_ARBITRARY: 1
    options:
      - container: 'boot args:--pull'

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:

-o fstab="/some/local/directory/config.user.inc.php usr/local/www/phpMyAdmin/config.user.inc.php nullfs ro"

On the appjail oci run line like this:

$ appjail oci run -Pd \
    -o overwrite=force \
    -o virtualnet=":<random> default" \
    -o nat \
    -o fstab="/some/local/directory/config.user.inc.php usr/local/www/phpMyAdmin/config.user.inc.php nullfs ro" \
    ghcr.io/appjail-makejails/phpmyadmin 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

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

See the following links for config file information:

• https://docs.phpmyadmin.net/en/latest/config.html#config
• https://docs.phpmyadmin.net/en/latest/setup.html

Adding custom configuration in /usr/local/www/phpMyAdmin/conf.d

You can also consider storing your custom configuration files in the folder /usr/local/www/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 appjail oci run line like this:

$ appjail oci run -Pd \
    -o overwrite=force \
    -o virtualnet=":<random> default" \
    -o nat \
    -o fstab="/some/local/directory/conf.d /usr/local/www/phpMyAdmin/conf.d nullfs ro" \
    ghcr.io/appjail-makejails/phpmyadmin 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.

-o fstab="/some/local/directory/sessions /sessions"

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.

$ appjail oci run -Pd \
    -o overwrite=force \
    -o virtualnet=":<random> default" \
    -o nat \
    -e PMA_HOSTS=sslhost \
    -e PMA_SSL=1 \
    ghcr.io/appjail-makejails/phpmyadmin phpmyadmin

$ appjail oci run -Pd \
    -o overwrite=force \
    -o virtualnet=":<random> default" \
    -o nat \
    -e PMA_HOSTS='sslhost,nosslhost' \
    -e PMA_SSL=1 \
    ghcr.io/appjail-makejails/phpmyadmin phpmyadmin

Arguments (stage: build)

• phpmyadmin_from (default: ghcr.io/appjail-makejails/phpmyadmin): Location of OCI image. See also OCI Configuration.
• phpmyadmin_tag (default: latest): OCI image tag. See also OCI Configuration.

Environment (OCI image)

• APACHE_PORT (optional): 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).
• HIDE_PHP_VERSION (optional): if defined, this option will hide the PHP version (expose_php = Off). Set to any value (such as HIDE_PHP_VERSION=true).
• MAX_EXECUTION_TIME (default: 600): if set, will override the maximum execution time in seconds for phpMyAdmin ($cfg['ExecTimeLimit']) and PHP max_execution_time (format as [0-9+]).
• MEMORY_LIMIT (default: 512M): if set, will override the memory limit 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).
• PMA_ABSOLUTE_URI (optional): the full URL to phpMyAdmin. Sometimes needed when used in a reverse-proxy configuration. Don't set this unless needed. See documentation.
• PMA_ARBITRARY (optional): when set to 1 connection to the arbitrary server will be allowed.
• PMA_CONFIG_BASE64 (optional): if set, this option will override the default config.inc.php with the base64 decoded contents of the variable.
• PMA_CONTROLHOST (optional): when set, this points to an alternate database host used for storing the phpMyAdmin Configuration Storage database database.
• PMA_CONTROLPASS (optional): define the password for phpMyAdmin to use with the controluser.
• PMA_CONTROLPORT (optional): if set, will override the default port for connecting to the control host for storing the phpMyAdmin Configuration Storage database database.
• PMA_CONTROLUSER (optional): define the username for phpMyAdmin to use for advanced features (the controluser).
• PMA_HOST (optional): define address/host name of the MySQL server.
• PMA_HOSTS (optional): define comma separated list of address/host names of the MySQL servers.
• PMA_PASSWORD (optional): define password to use only with the config authentication method.
• PMA_PMADB (optional): 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_PORT (optional): define port of the MySQL server.
• PMA_PORTS (optional): define comma separated list of ports of the MySQL servers.
• PMA_QUERYHISTORYDB (optional): 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 (optional): when set to an integer, controls the number of history items. See documentation.
• PMA_SAVEDIR (optional): if defined, this option will set the path where exported files can be saved ($cfg['SaveDir']).
• PMA_SOCKET (optional): define socket file for the MySQL connection.
• PMA_SOCKETS (optional): define comma separated list of socket files for the MySQL connections.
• PMA_SSL (optional): when set to 1, defines SSL usage for the MySQL connection.
• PMA_SSL_CA (optional): 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 (optional): 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 (optional): in the context of mutual TLS security, allows setting your certificate file as a string inside the default config.inc.php.
• PMA_SSL_CERTS (optional): 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_DIR (default: /usr/local/www/phpMyAdmin/ssl): define the path used for SSL files generated from environement variables.
• PMA_SSL_KEY (optional): 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 (optional): 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_SSL_VERIFIES (optional): comma-separated list of 0 and 1 to enable or disable SSL certificate verification for multiple MySQL connections.
• PMA_SSL_VERIFY (optional): when set to 1, enables SSL certificate verification for the MySQL connection.
• PMA_SSLS (optional): comma separated list of 0 and 1 defining SSL usage for the corresponding MySQL connections.
• PMA_UPLOADDIR (optional): if defined, this option will set the path where files can be saved to be available to import ($cfg['UploadDir']).
• PMA_USER (optional): define username to use only with the config authentication method.
• PMA_USER_CONFIG_BASE64 (optional): if set, this option will override the default config.user.inc.php with the base64 decoded contents of the variable.
• PMA_VERBOSE (optional): define verbose name of the MySQL server.
• PMA_VERBOSES (optional): define comma separated list of verbose names of the MySQL servers.
• TZ (default: UTC): if defined, this option will change the default PHP date.timezone. See documentation for supported values.
• UPLOAD_LIMIT (default: 2048K): if set, this option will override the default value for apache and php-fpm (format as [0-9+](K,M,G), this will change upload_max_filesize and post_max_size values).

OCI Configuration

build:
  variants:
    - tag: 15.1-apache
      containerfile: Containerfile.apache
      aliases: ["latest"]
      default: true
      args:
        FREEBSD_RELEASE: "15.1"
        APACHEVER: "24"
        PHPVER: "82"
        NO_PKGCLEAN: "1"
      cache_dirs: ["pkgcache0:/var/cache/pkg"]
    - tag: 15.1-fpm
      containerfile: Containerfile.fpm
      args:
        FREEBSD_RELEASE: "15.1"
        PHPVER: "82"
        NO_PKGCLEAN: "1"
      cache_dirs: ["pkgcache0:/var/cache/pkg"]

Notes

1. 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.

2. 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

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

4. The ideas present in the Docker image of phpMyAdmin are taken into account for users who are familiar with it.