diff --git a/phpmyadmin/content.md b/phpmyadmin/content.md index a179df3dc..00769ed1b 100644 --- a/phpmyadmin/content.md +++ b/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 `