2020-02-21 13:22:59 +01:00
[](https://github.com/mlocati/docker-php-extension-installer/actions?query=workflow%3A%22Test+recent%22)
2018-04-12 09:25:43 +02:00
2018-04-11 17:39:10 +02:00
# Easy installation of PHP extensions in official PHP Docker images
This repository contains a script that can be used to easily install a PHP extension inside the [official PHP Docker images ](https://hub.docker.com/_/php/ ).
2020-01-08 10:09:44 +01:00
The script will install all the required APT/APK packages; at the end of the script execution, the no-more needed packages will be removed so that the image will be much smaller.
2020-03-03 12:07:51 +01:00
Supported docker images are all the Alpine/Debian versions, except for PHP 5.5 where we only support Debian 8 (jessie) (that is, `php:5.5` , `php:5.5-apache` , `php:5.5-cli` , `php:5.5-fpm` , `php:5.5-zts` ).
See also the notes in the [Special requirements ](#special-requirements ) section.
2018-04-11 17:39:10 +02:00
## Usage
2020-01-08 10:09:44 +01:00
You have two ways to use this script within your `Dockerfile` s: you can download the script on the fly, or you can grab it from the [`mlocati/php-extension-installer` Docker Hub image ](https://hub.docker.com/r/mlocati/php-extension-installer ).
With the first method you are sure you'll always get the very latest version of the script, with the second method the process is faster since you'll use a local image.
2018-04-11 17:39:10 +02:00
2020-01-08 10:09:44 +01:00
For example, here are two `Dockerfile` s that install the GD and xdebug PHP extensions:
### Downloading the script on the fly
```Dockerfile
2018-04-11 17:39:10 +02:00
FROM php:7.2-cli
2020-12-10 15:59:21 +01:00
ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/
2018-04-11 17:39:10 +02:00
2020-11-05 11:43:10 +01:00
RUN chmod +x /usr/local/bin/install-php-extensions & & sync & & \
2018-04-11 17:45:25 +02:00
install-php-extensions gd xdebug
2018-04-11 17:39:10 +02:00
```
2020-01-08 10:09:44 +01:00
### Copying the script from a Docker image
2019-10-09 17:11:51 +02:00
2020-01-08 10:09:44 +01:00
```Dockerfile
2019-10-09 17:11:51 +02:00
FROM php:7.2-cli
2020-12-10 15:59:21 +01:00
COPY --from=mlocati/php-extension-installer /usr/bin/install-php-extensions /usr/local/bin/
2019-10-09 17:11:51 +02:00
RUN install-php-extensions gd xdebug
```
Let users install a specific PHP module version
Test: amqp,apcu,gmagick,http,pecl_http,igbinary,memcache,mailparse,memcached,mongodb,mosquitto,msgpack,oauth,opencensus,parallel,pcov,pdo_sqlsrv,sqlsrv,propro,protobuf,pthreads,raphf,rdkafka,redis,solr,ssh2,uuid,xdebug,uopz,xhprof,yaml
2020-12-02 18:19:24 +01:00
### Installing a specific version of an extension
Simply append `-<version>` to the module name.
For example:
```sh
install-php-extensions xdebug-2.9.7
```
2020-12-16 11:34:30 +01:00
### Installing composer
You can also install [composer ](https://getcomposer.org/ ), and you also can specify a major version of it, or a full version.
Examples:
```sh
# Install the latest version
install-php-extensions @composer
# Install the latest 1.x version
install-php-extensions @composer -1
# Install a specific version
install-php-extensions @composer -2.0.2
```
2018-04-11 17:39:10 +02:00
## Supported PHP extensions
<!-- START OF EXTENSIONS TABLE -->
<!-- ########################################################### -->
<!-- # # -->
<!-- # DO NOT EDIT THIS TABLE: IT IS GENERATED AUTOMATICALLY # -->
<!-- # # -->
<!-- # EDIT THE data/supported - extensions FILE INSTEAD # -->
<!-- # # -->
<!-- ########################################################### -->
2020-09-19 04:59:16 +02:00
| Extension | PHP 5.5 | PHP 5.6 | PHP 7.0 | PHP 7.1 | PHP 7.2 | PHP 7.3 | PHP 7.4 | PHP 8.0 |
|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
| amqp | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| apcu | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-10-18 18:16:54 +02:00
| apcu_bc | | | ✓ | ✓ | ✓ | ✓ | ✓ | |
2020-09-19 04:59:16 +02:00
| bcmath | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| bz2 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| calendar | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| cmark | | | ✓ | ✓ | ✓ | ✓ | ✓ | |
| dba | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| decimal | | | ✓ | ✓ | ✓ | ✓ | ✓ | |
| enchant[*](#special-requirements-for-enchant) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-12-10 12:16:02 +01:00
| ev | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
2020-09-19 04:59:16 +02:00
| exif | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| ffi | | | | | | | ✓ | ✓ |
| gd | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| gettext | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| gmagick | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| gmp | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-12-14 17:58:42 +01:00
| gnupg | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
2020-12-03 17:43:11 +01:00
| grpc | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-09-19 04:59:16 +02:00
| http | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| igbinary | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| imagick | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| imap | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| interbase | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | |
| intl | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-12-10 15:44:10 +01:00
| ioncube_loader | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
2020-09-19 04:59:16 +02:00
| ldap | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| mailparse | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-12-10 18:09:48 +01:00
| maxminddb | | | | | ✓ | ✓ | ✓ | ✓ |
2020-12-09 09:39:56 +01:00
| mcrypt | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-09-19 04:59:16 +02:00
| memcache | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| memcached | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| mongo | ✓ | ✓ | | | | | | |
2020-12-07 13:59:13 +01:00
| mongodb | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-11-28 14:53:31 +01:00
| mosquitto | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
2020-12-09 09:39:56 +01:00
| msgpack | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-09-19 04:59:16 +02:00
| mssql | ✓ | ✓ | | | | | | |
| mysql | ✓ | ✓ | | | | | | |
| mysqli | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-12-09 09:39:56 +01:00
| oauth | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-12-11 15:24:59 +01:00
| oci8 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-12-09 11:07:11 +01:00
| odbc | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-09-19 04:59:16 +02:00
| opcache | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| opencensus | | | ✓ | ✓ | ✓ | ✓ | ✓ | |
| parallel[*](#special-requirements-for-parallel) | | | | ✓ | ✓ | ✓ | ✓ | |
| pcntl | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| pcov | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-12-09 09:48:55 +01:00
| pdo_dblib | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-09-19 04:59:16 +02:00
| pdo_firebird | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| pdo_mysql | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| pdo_odbc | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| pdo_pgsql | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| pdo_sqlsrv | | | ✓ | ✓ | ✓ | ✓ | ✓ | |
| pgsql | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| propro | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| protobuf | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| pspell | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| pthreads[*](#special-requirements-for-pthreads) | ✓ | ✓ | ✓ | | | | | |
| raphf | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| rdkafka | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| recode | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | |
2020-09-21 15:13:57 +02:00
| redis | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-09-19 04:59:16 +02:00
| shmop | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| snmp | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| snuffleupagus | | | ✓ | ✓ | ✓ | ✓ | ✓ | |
| soap | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| sockets | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| solr | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| sqlsrv | | | ✓ | ✓ | ✓ | ✓ | ✓ | |
| ssh2 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| sybase_ct | ✓ | ✓ | | | | | | |
| sysvmsg | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| sysvsem | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| sysvshm | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| tdlib[*](#special-requirements-for-tdlib) | | | ✓ | ✓ | ✓ | ✓ | ✓ | |
| tidy | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| timezonedb | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| uopz | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| uuid | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| wddx | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | |
2020-09-21 14:56:26 +02:00
| xdebug | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-09-19 04:59:16 +02:00
| xhprof | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| xmlrpc | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| xsl | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-12-09 09:39:56 +01:00
| yaml | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
2020-09-19 04:59:16 +02:00
| zip | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| zookeeper | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
2019-12-17 10:26:35 +01:00
2020-12-14 17:58:42 +01:00
*Number of supported extensions: 87*
2018-04-11 17:39:10 +02:00
<!-- END OF EXTENSIONS TABLE -->
2018-04-12 09:50:14 +02:00
PS: the pre-installed PHP extensions are excluded from this list.
You can list them with the following command (change `php:7.2-cli` to reflect the PHP version you are interested in):
2020-02-21 20:39:09 +01:00
```
$ docker run --rm php:7.2-cli php -m
[PHP Modules]
Core
ctype
curl
date
dom
fileinfo
filter
ftp
hash
iconv
json
libxml
mbstring
mysqlnd
openssl
pcre
PDO
pdo_sqlite
Phar
posix
readline
Reflection
session
SimpleXML
sodium
SPL
sqlite3
standard
tokenizer
xml
xmlreader
xmlwriter
zlib
[Zend Modules]
2018-04-12 09:50:14 +02:00
```
2018-04-11 17:39:10 +02:00
## Special requirements
Some extension has special requirements:
<!-- START OF SPECIAL REQUIREMENTS -->
<!-- ########################################################### -->
<!-- # # -->
<!-- # DO NOT EDIT THIS TABLE: IT IS GENERATED AUTOMATICALLY # -->
<!-- # # -->
<!-- # EDIT THE data/special - requirements FILE INSTEAD # -->
<!-- # # -->
<!-- ########################################################### -->
| Extension | Requirements |
2020-03-03 12:08:17 +01:00
|---|---|
2020-09-19 04:59:16 +02:00
| < a name = "special-requirements-for-enchant" ></ a > enchant | • Not available in `7.2-alpine3.12` docker images< br /> • Not available in `7.3-alpine3.12` docker images< br /> • Not available in `7.4-alpine3.12` docker images |
2020-03-03 14:25:40 +01:00
| < a name = "special-requirements-for-parallel" > < / a > parallel | Requires images with PHP compiled with thread-safety enabled (`zts`). |
| < a name = "special-requirements-for-pthreads" > < / a > pthreads | Requires images with PHP compiled with thread-safety enabled (`zts`). |
| < a name = "special-requirements-for-tdlib" ></ a > tdlib | • Not available in `alpine3.7` docker images< br /> • Not available in `jessie` docker images |
2018-04-11 17:39:10 +02:00
<!-- END OF SPECIAL REQUIREMENTS -->
2018-04-12 11:58:21 +02:00
2020-02-21 14:05:53 +01:00
## Tests
When submitting a pull request, a [GitHub Action ](https://github.com/mlocati/docker-php-extension-installer/blob/master/.github/workflows/test-extensions.yml ) is executed to check if affected PHP extensions actually work (see below).
Furthermore, we also check that new versions of extensions in the PECL repository will still work.
This is done on a scheduled basis with another [GitHub Action ](https://github.com/mlocati/docker-php-extension-installer/blob/master/.github/workflows/test-recent-extensions.yml ).
2020-02-22 20:42:50 +01:00
In case of failure, a message is sent to a [Telegram Channel ](https://t.me/docker_php_extension_installer ).
2020-02-21 14:05:53 +01:00
Feel free to subscribe to it to receive failure notifications.
2018-04-12 11:58:21 +02:00
## How to contribute
2019-12-20 18:26:26 +01:00
### Formatting code
Before submitting any pull request, be sure to execute the `lint` script in the `scripts` directory (or `lint.bat` on Windows).
2019-12-17 10:33:20 +01:00
### Adding support to a new PHP extension?
2019-12-11 12:57:53 +01:00
2019-12-17 10:33:20 +01:00
1. change the `install-php-extensions` script
2. update the `data/supported-extensions` file, adding a new line with the handle of the extension and the list of supported PHP versions
3. if the extension requires ZTS images:
add a new line to the `data/special-requirements` file, with the extension handle followed by a space and `zts`
2019-12-17 11:21:01 +01:00
See [this pull request ](https://github.com/mlocati/docker-php-extension-installer/pull/60 ) for an example.
2019-12-17 10:33:20 +01:00
### Changing the supported PHP versions for an already supported PHP extension?
1. change the `install-php-extensions` script
2019-12-18 16:45:20 +01:00
2. update the `data/supported-extensions` file, adding the new PHP version to the existing line corresponding to the updated extension
2019-12-17 11:21:01 +01:00
See [this pull request ](https://github.com/mlocati/docker-php-extension-installer/pull/62 ) for an example.
2019-12-17 10:33:20 +01:00
### Improving code for an already supported extension?
If you change some code that affects one or more extensions, please add a line with `Test: extension1, extension2` to the message of one of the pull request commits.
That way, the test jobs will check the extension even if you don't touch the `data/supported-extensions` file.
Here's an example of a commit message:
```
Improve the GD and ZIP extensions
Test: gd, zip
```
2019-12-18 16:45:20 +01:00
Tests only check the installation of a single PHP extension at a time.
If you want to test installing more PHP extensions at the same time, use a commit message like this:
```
Improve the GD and ZIP extensions
Test: gd+zip
```
2019-12-17 10:33:20 +01:00
If your pull request contains multiple commits, we'll check the "Test:" message of every commit.
If you want to stop parsing next commits, add `-STOP-` in the "Test:" line, for example:
```
Improve the GD and ZIP extensions
Test: gd, zip, -STOP-
```
2019-12-10 08:55:09 +01:00
2019-12-17 11:21:01 +01:00
See [this pull request ](https://github.com/mlocati/docker-php-extension-installer/pull/43 ) for an example.
2019-12-10 08:55:09 +01:00
## Do you want to really say thank you?
You can offer me a [monthly coffee ](https://github.com/sponsors/mlocati ) or a [one-time coffee ](https://paypal.me/mlocati ) :wink:
