Skip to content

Commit 4482d47

Browse files
committed
Improve documentation
Add some missing information, fix typos, restructure, and improve readability Signed-off-by: Isaac Bennetch <bennetch@gmail.com>
1 parent 3d8c2ba commit 4482d47

File tree

1 file changed

+41
-26
lines changed

1 file changed

+41
-26
lines changed

README.md

Lines changed: 41 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Official phpMyAdmin Docker image
22

3+
Note that since phpMyAdmin has been accepted in to the [official DockerHub repository](https://hub.docker.com/_/phpmyadmin), you can use
4+
either that or this older [phpMyAdmin repository](https://hub.docker.com/r/phpmyadmin/phpmyadmin/) for your Docker installation. This
5+
is maintained as a courtesy to users who have not migrated.
6+
37
Run phpMyAdmin with Alpine, Apache and PHP FPM.
48

59
[![GitHub CI build status badge](https://github.com/phpmyadmin/docker/workflows/GitHub%20CI/badge.svg)](https://github.com/phpmyadmin/docker/actions?query=workflow%3A%22GitHub+CI%22)
@@ -19,17 +23,15 @@ Run phpMyAdmin with Alpine, Apache and PHP FPM.
1923
[![Docker Version](https://images.microbadger.com/badges/version/phpmyadmin.svg)](https://microbadger.com/images/phpmyadmin "Get your own version badge on microbadger.com")
2024

2125

22-
All following examples will bring you phpMyAdmin on `http://localhost:8080`
26+
All of the following examples will bring you phpMyAdmin on `http://localhost:8080`
2327
where you can enjoy your happy MySQL administration.
2428

2529
## Credentials
2630

27-
phpMyAdmin connects using your MySQL server credentials. Please check the corresponding
28-
database server image for information on what the default username and password are.
29-
To modify username and password during installation you can check the corresponding
30-
database server image on Docker Hub.
31+
phpMyAdmin connects using your MySQL server credentials. Please check your corresponding
32+
database server image for information on the default username and password or how to specify your own custom credentials during installation.
3133

32-
The official MySQL and MariaDB use the following environment variables to define these:
34+
The official MySQL and MariaDB images use the following environment variables to define these:
3335

3436
* `MYSQL_ROOT_PASSWORD` - This variable is mandatory and specifies the password that will be set for the `root` superuser account.
3537
* `MYSQL_USER`, `MYSQL_PASSWORD` - These variables are optional, used in conjunction to create a new user and to set that user's password.
@@ -41,20 +43,20 @@ The following tags are available:
4143
* `latest`, `fpm`, and `fpm-alpine` are always the most recent released version
4244
* Major versions, such as `5`, `5-fpm`, and `5-fpm-alpine`
4345
* Specific minor versions, such as `5.0`, `5.0-fpm`, and `5-fpm-alpine`
44-
* Specific patch versions, such as `5.0.0`, `5.0.0-fpm`, and `5.0.0-alpine`
46+
* Specific patch versions, such as `5.0.0`, `5.0.0-fpm`, and `5.0.0-alpine`. Note that, on rare occasion, there may be an intermediary "docker-only" release, such as 4.9.2-1
4547

46-
A complete list of tags is [available at Docker Hub](https://hub.docker.com/_/phpmyadmin?tab=tags)
48+
A complete list of tags is [available at Docker Hub](https://hub.docker.com/r/phpmyadmin/phpmyadmin/tags)
4749

4850
## Image variants
4951

5052
We provide three variations:
5153

5254
* "apache" includes a full Apache webserver with PHP and includes everything needed to work out of the box.
5355
This is the default when only a version number is requested.
54-
* "fpm" only starts a PHP FPM container. Use this variant if you already have a seperate webserver.
56+
* "fpm" only starts a PHP FPM container. Use this variant if you already have a separate webserver.
5557
This includes more tools and is therefore a larger image than the "fpm-alpine" variation.
5658
* "fpm-alpine" has a very small footprint. It is based on Alpine Linux and only starts a PHP FPM process.
57-
Use this variant if you already have a seperate webserver. If you need more tools that are not available on Alpine Linux, use the fpm image instead.
59+
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.
5860

5961
## Usage with linked server
6062

@@ -68,29 +70,42 @@ docker run --name myadmin -d --link mysql_db_server:db -p 8080:80 phpmyadmin
6870
## Usage with external server
6971

7072
You can specify a MySQL host in the `PMA_HOST` environment variable. You can also
71-
use `PMA_PORT` to specify port of the server in case it's not the default one:
73+
use `PMA_PORT` to specify the port of the server in case it's not the default one:
7274

7375
```sh
7476
docker run --name myadmin -d -e PMA_HOST=dbhost -p 8080:80 phpmyadmin
7577
```
7678

7779
## Usage with arbitrary server
7880

79-
You can use arbitrary servers by adding ENV variable `PMA_ARBITRARY=1` to the startup command:
81+
You can use arbitrary servers by adding the environment variable `PMA_ARBITRARY=1` to the startup command:
8082

8183
```sh
8284
docker run --name myadmin -d -e PMA_ARBITRARY=1 -p 8080:80 phpmyadmin
8385
```
8486

8587
## Usage with docker-compose and arbitrary server
8688

87-
This will run phpMyAdmin with arbitrary server - allowing you to specify MySQL/MariaDB
88-
server on login page.
89-
90-
Using the docker-compose.yml from https://github.com/phpmyadmin/docker
89+
This will run phpMyAdmin with the arbitrary server option - allowing you to specify any MySQL/MariaDB
90+
server on the login page.
9191

9292
```sh
93-
docker-compose up -d
93+
version: '3.1'
94+
95+
services:
96+
db:
97+
image: mariadb:10.3
98+
restart: always
99+
environment:
100+
MYSQL_ROOT_PASSWORD: notSecureChangeMe
101+
102+
phpmyadmin:
103+
image: phpmyadmin
104+
restart: always
105+
ports:
106+
- 8080:80
107+
environment:
108+
- PMA_ARBITRARY=1
94109
```
95110

96111
## Run the E2E tests with docker-compose
@@ -106,24 +121,25 @@ docker-compose -f docker-compose.testing.yml up phpmyadmin
106121
## Adding Custom Configuration
107122

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

112127
```sh
113128
-v /some/local/directory/config.user.inc.php:/etc/phpmyadmin/config.user.inc.php
114129
```
115130

116-
On the "docker run" line like this:
131+
On the `docker run` line like this:
117132

118133
```sh
119134
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
120135
```
121136

122-
See the following links for config file information.
123-
https://docs.phpmyadmin.net/en/latest/config.html#config
124-
https://docs.phpmyadmin.net/en/latest/setup.html
137+
See the following links for config file information:
138+
139+
* https://docs.phpmyadmin.net/en/latest/config.html#config
140+
* https://docs.phpmyadmin.net/en/latest/setup.html
125141

126-
## Usage behind reverse proxys
142+
## Usage behind a reverse proxy
127143

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

@@ -136,11 +152,10 @@ Set the variable ``PMA_ABSOLUTE_URI`` to the fully-qualified path (``https://pma
136152
* ``PMA_HOSTS`` - define comma separated list of address/host names of the MySQL servers
137153
* ``PMA_VERBOSES`` - define comma separated list of verbose names of the MySQL servers
138154
* ``PMA_PORTS`` - define comma separated list of ports of the MySQL servers
139-
* ``PMA_USER`` and ``PMA_PASSWORD`` - define username to use for config authentication method
140-
* ``PMA_ABSOLUTE_URI`` - define user-facing URI
155+
* ``PMA_USER`` and ``PMA_PASSWORD`` - define username and password to use only with the `config` authentication method
156+
* ``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).
141157
* ``PMA_CONFIG_BASE64`` - if set, this option will override the default `config.inc.php` with the base64 decoded contents of the variable
142158
* ``PMA_USER_CONFIG_BASE64`` - if set, this option will override the default `config.user.inc.php` with the base64 decoded contents of the variable
143-
* ``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).
144159
* ``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
145160
* ``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
146161
* ``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`

0 commit comments

Comments
 (0)