Merge pull request #2175 from williamdes/update-phpmyadmin

[phpmyadmin] Update documentation

phpmyadmin/content.md

@@ -8,64 +8,88 @@ Run phpMyAdmin with Alpine, Apache and PHP FPM.
 
 # How to use this image
 
-All following examples will bring you phpMyAdmin on `http://localhost:8080` where you can enjoy your happy MySQL administration.
+All of the 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.
+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 use following environment variables to define these:
+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
+## 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
+-	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 [available at Docker Hub](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 MySQL or MariaDB server in Docker, and this image need link a running mysql instance container:
+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:
 
-```console
-$ docker run --name myadmin -d --link mysql_db_server:db -p 8080:80 %%IMAGE%%
+```sh
+docker run --name phpmyadmin -d --link mysql_db_server:db -p 8080:80 %%IMAGE%%
 ```
 
 ## 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:
+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:
 
-```console
-$ docker run --name myadmin -d -e PMA_HOST=dbhost -p 8080:80 %%IMAGE%%
+```sh
+docker run --name phpmyadmin -d -e PMA_HOST=dbhost -p 8080:80 %%IMAGE%%
 ```
 
 ## Usage with arbitrary server
 
-You can use arbitrary servers by adding ENV variable `PMA_ARBITRARY=1` to the startup command:
+You can use arbitrary servers by adding the environment variable `PMA_ARBITRARY=1` to the startup command:
 
-```console
-$ docker run --name myadmin -d -e PMA_ARBITRARY=1 -p 8080:80 %%IMAGE%%
+```sh
+docker run --name phpmyadmin -d -e PMA_ARBITRARY=1 -p 8080:80 %%IMAGE%%
 ```
 
 ## Usage with docker-compose and arbitrary server
 
-This will run phpMyAdmin with arbitrary server - allowing you to specify MySQL/MariaDB server on login page.
+This will run phpMyAdmin with the arbitrary server option - allowing you to specify any MySQL/MariaDB server on the login page.
 
 %%STACK%%
 
 ## 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`.
+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:
 
-```console
-$ 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 %%IMAGE%%
+```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 %%IMAGE%%
+```
+
+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:
@@ -73,7 +97,7 @@ 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
 
-## Usage behind reverse proxys
+## 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.
 
@@ -86,25 +110,43 @@ Set the variable `PMA_ABSOLUTE_URI` to the fully-qualified path (`https://pma.ex
 -	`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
+-	`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](https://docs.phpmyadmin.net/en/latest/config.html#cfg_PmaAbsoluteUri).
+-	`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_CONTROLHOST` - when set, this points to an alternate database host used for storing the [phpMyAdmin Configuration Storage database](https://docs.phpmyadmin.net/en/latest/setup.html#phpmyadmin-configuration-storage) database
+-	`PMA_CONTROLPORT` - if set, will override the default port (3306) for connecting to the control host for storing the [phpMyAdmin Configuration Storage database](https://docs.phpmyadmin.net/en/latest/setup.html#phpmyadmin-configuration-storage) database
+-	`PMA_PMADB` - define the name of the database to be used for the [phpMyAdmin Configuration Storage database](https://docs.phpmyadmin.net/en/latest/setup.html#phpmyadmin-configuration-storage). 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](https://docs.phpmyadmin.net/en/latest/config.html#cfg_Servers_controluser))
+-	`PMA_CONTROLPASS` - define the password for phpMyAdmin to use with the [controluser](https://docs.phpmyadmin.net/en/latest/config.html#cfg_Servers_controlpass)
+-	`PMA_QUERYHISTORYDB` - when set [to true](https://docs.phpmyadmin.net/en/latest/config.html#cfg_QueryHistoryDB), enables storing [SQL history](https://docs.phpmyadmin.net/en/latest/config.html#cfg_Servers_history) to the [phpMyAdmin Configuration Storage database](https://docs.phpmyadmin.net/en/latest/setup.html#phpmyadmin-configuration-storage). When [false](https://docs.phpmyadmin.net/en/latest/config.html#cfg_QueryHistoryDB), 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](https://docs.phpmyadmin.net/en/latest/config.html#cfg_QueryHistoryMax). Defaults to `25`.
+-	`MAX_EXECUTION_TIME` - if set, will override the maximum execution time in seconds (default 600) for phpMyAdmin ([$cfg['ExecTimeLimit']](https://docs.phpmyadmin.net/en/latest/config.html#cfg_ExecTimeLimit)) and PHP [max_execution_time](https://www.php.net/manual/en/info.configuration.php#ini.max-execution-time) (format as `[0-9+]`)
+-	`MEMORY_LIMIT` - if set, will override the memory limit (default 512M) for phpMyAdmin ([$cfg['MemoryLimit']](https://docs.phpmyadmin.net/en/latest/config.html#cfg_MemoryLimit)) and PHP [memory_limit](https://www.php.net/manual/en/ini.core.php#ini.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)
+-	`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):
 
-```console
-$ docker run --name myadmin -d -e PMA_PASSWORD_FILE=/run/secrets/db_password.txt -p 8080:80 phpmyadmin/phpmyadmin
+```sh
+docker run --name phpmyadmin -d -e PMA_PASSWORD_FILE=/run/secrets/db_password.txt -p 8080:80 %%IMAGE%%
 ```
 
 #### Variables that can be read from a file using `_FILE`
 
--	PMA_PASSWORD
--	MYSQL_ROOT_PASSWORD
--	MYSQL_PASSWORD
--	PMA_HOSTS
--	PMA_HOST
+-	`MYSQL_ROOT_PASSWORD`
+-	`MYSQL_PASSWORD`
+-	`PMA_USER`
+-	`PMA_PASSWORD`
+-	`PMA_HOSTS`
+-	`PMA_HOST`
+-	`PMA_CONTROLHOST`
+-	`PMA_CONTROLUSER`
+-	`PMA_CONTROLPASS`
 
 For more detailed documentation see https://docs.phpmyadmin.net/en/latest/setup.html#installing-using-docker
+
+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

phpmyadmin/stack.yml

@@ -2,7 +2,7 @@ version: '3.1'
 
 services:
   db:
-    image: mariadb:10.3
+    image: mariadb:10.6
     restart: always
     environment:
       MYSQL_ROOT_PASSWORD: notSecureChangeMe