KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

docker-php-extension-installer

★ 4,957 Open GitHub ↗

Easily install PHP extensions in Docker containers

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Downloaded GitHub Releases](https://img.shields.io/github/downloads/mlocati/docker-php-extension-installer/total?label=Downloaded%20releases)](https://github.com/mlocati/docker-php-extension-installer/releases)
[![Docker Hub pulls](https://img.shields.io/docker/pulls/mlocati/php-extension-installer?label=Docker%20Hub%20pulls)](https://hub.docker.com/r/mlocati/php-extension-installer)
[![GitHub Registry pulls](https://raw.githubusercontent.com/mlocati/docker-php-extension-installer/refs/heads/assets/resources/ghcr-badge.svg)](https://github.com/mlocati/docker-php-extension-installer/pkgs/container/php-extension-installer)
[![Test recent](https://github.com/mlocati/docker-php-extension-installer/actions/workflows/test-recent-extensions.yml/badge.svg)](https://github.com/mlocati/docker-php-extension-installer/actions/workflows/test-recent-extensions.yml)

# 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/).

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.

Supported docker images are:

- Debian-based docker images: since jessie (Debian 8) (minimum PHP version: 5.5)
- Alpine-based docker images: since Alpine 3.9 (minimum PHP version: 7.1)

See also the notes in the [Special requirements](#special-requirements) section.

## Usage

You have many ways to use this script within your `Dockerfile`s.

Here's a list of sample `Dockerfile`s that install the GD and xdebug PHP extensions:

### Downloading the script on the fly with `ADD`

```Dockerfile
FROM php:7.2-cli

ADD --chmod=0755 https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/

RUN install-php-extensions gd xdebug
```

### Downloading the script on the fly with `curl`

```Dockerfile
FROM php:7.2-cli

RUN curl -sSLf \
        -o /usr/local/bin/install-php-extensions \
        https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions && \
    chmod +x /usr/local/bin/install-php-extensions && \
    install-php-extensions gd xdebug
```

### Direct execution with `curl`

```Dockerfile
FROM php:8.2-cli

RUN ( curl -sSLf https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions -o - || echo 'return 1' ) | sh -s \
      gd xdebug
```

### Copying the script from a Docker image

- using GitHub Container Registry
  
  ```Dockerfile
  FROM php:8.4-cli
  
  COPY --from=ghcr.io/mlocati/php-extension-installer /usr/bin/install-php-extensions /usr/local/bin/
  
  RUN install-php-extensions gd xdebug
  ```
- using Docker Hub
  
  ```Dockerfile
  FROM php:8.4-cli
  
  COPY --from=mlocati/php-extension-installer /usr/bin/install-php-extensions /usr/local/bin/
  
  RUN install-php-extensions gd xdebug
  ```

**Warning**: by using this method you may use an outdated version of the Docker image.
You may want to run `docker pull ghcr.io/mlocati/php-extension-installer` or `docker pull mlocati/php-extension-installer` in order to use an up-to-date version.

### Using the script of a Docker image

- using GitHub Container Registry
  
  ```Dockerfile
  RUN  --mount=type=bind,from=ghcr.io/mlocati/php-extension-installer:latest,source=/usr/bin/install-php-extensions,target=/usr/local/bin/install-php-extensions \
      install-php-extensions gd xdebug
  ```
- using Docker Hub
  
  ```Dockerfile
  RUN  --mount=type=bind,from=mlocati/php-extension-installer:latest,source=/usr/bin/install-php-extensions,target=/usr/local/bin/install-php-extensions \
      install-php-extensions gd xdebug
  ```

**Warning**: by using this method you may use an outdated version of the Docker image image.
You may want to run `docker pull ghcr.io/mlocati/php-extension-installer` or `docker pull mlocati/php-extension-installer` in order to use an up-to-date version.

## Installing specific versions of an extension

Simply append `-<version>` to the module name.
For example:

```sh
install-php-extensions xdebug-2.9.7
```

The script also supports resolving *compatible* versions by prefixing the version with a caret (`^`).
For example:

```sh
# Install the most recent xdebug 2.x version (for example 2.9.8)
install-php-extensions xdebug-^2
# Install the most recent xdebug 2.8.x version (for example 2.8.1)
install-php-extensions xdebug-^2.8
```

Please remark that with the syntax above you'll get the very latest compatible version, which may be unstable. In order to install the most recent *stable* version, you can append `@stable`:

```sh
# Install the most recent STABLE xdebug 3.x version (for example 3.2.2)
install-php-extensions xdebug-^3@stable
```

(valid suffixes are: `@snapshot`, `@devel`, `@alpha`, `@beta`, and `@stable`)

Pre-release versions extensions available on `PECL` can be setup by suffixing the extension's name with its state i.e. `alpha`, `beta`, `rc`, `preview`, `devel` or `snapshot`.
For example:

```sh
install-php-extensions xdebug-beta
```

TIP: When the latest version available on `PECL` is not stable, and you want to keep the last stable version, 
force it by suffixing the extension's name with the `stable` state.
For example:

```sh
install-php-extensions mongodb-stable
```

## Installing an extension from its source code

You can also install PHP extensions from source code (provided that it comes with a `package.xml` or a `package2.xml` file).

Accepted formats are:

- A short version for repositories hosted on GitHub.  
  For example, for the [php-memcached-dev/php-memcached](https://github.com/php-memcached-dev/php-memcached) GitHub repository,
  you can simply write:
  ```sh
  # Install from a specific commit (full commit SHA-1)
  install-php-extensions php-memcached-dev/php-memcached@8f106564e6bb005ca6100b12ccc89000daafa9d8
  # Install from a specific commit (short commit SHA-1)
  install-php-extensions php-memcached-dev/php-memcached@8f106564e6bb
  # Install from tag v3.2.0RC2
  install-php-extensions php-memcached-dev/php-memcached@v3.2.0RC2
  install-php-extensions php-memcached-dev/php-memcached@refs/tags/v3.2.0RC2
  # Install from branch master
  install-php-extensions php-memcached-dev/php-memcached@master
  install-php-extensions php-memcached-dev/php-memcached@refs/heads/master
  ```
- An URL providing an archive containing the source code.  
  Examples:
  ```sh
  # tgz archive for commit 8f106564e6bb005ca6100b12ccc89000daafa9d8
  install-php-extensions https://codeload.github.com/php-memcached-dev/php-memcached/tar.gz/8f106564e6bb005ca6100b12ccc89000daafa9d8
  # tgz archive for tag v3.1.5
  install-php-extensions https://codeload.github.com/php-memcached-dev/php-memcached/tar.gz/refs/tags/v3.1.5
  # tgz archive for branch master
  install-php-extensions https://codeload.github.com/php-memcached-dev/php-memcached/tar.gz/refs/heads/master
  ```
- The absolute path of a local directory.  
  Examples:
  ```sh
  # Download the source code
  curl -o /tmp/source.tgz https://codeload.github.com/php-memcached-dev/php-memcached/tar.gz/refs/tags/v3.1.5
  tar xzf /tmp/source.tgz -C /tmp
  install-php-extensions /tmp/php-memcached-3.1.5

## Bundled extensions or not?

There are some extensions that are bundled in the PHP source code (for example, `gd` and `zip`).

Some of these extensions are also available on PECL and/or a source code repository.

By default, `install-php-extensions` installs the bundled version.

If instead you want to use a remote version:

- for using PECL: just append the stability to the package name. For example:
  ```
  install-php-extensions zip-stable
  ```
- for installing from source code: use the syntax [specified above](#installing-an-extension-from-its-source-code). For example:
  ```
  install-php-extensions php/pecl-database-oci8@7aa1061
  ```

`install-php-extensions` supports installing remote versions instead of bundled ones for these extensions:

- pdo_oci
- oci8
- zip

## 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
```

## Issue with Let's Encrypt certificates

The root CA certificate of Let's Encrypt changes ([more details here](https://letsencrypt.org/docs/dst-root-ca-x3-expiration-september-2021/)).  
That breaks old linux distributions, namely:

- Debian Jessie (8)
- Debian Stretch (9)
- Alpine Linux 3.7
- Alpine Linux 3.8

This script can fix this issue: simply pass `@fix_letsencrypt` as an argument:

```sh
install-php-extensions @fix_letsencrypt
```

## Supported PHP extensions

*Number of supported extensions: 162*

PS: the pre-installed PHP extensions are excluded from this list.
You can list them with the following command (change `php:8.5-cli` to reflect the PHP version you are interested in):

```
$ docker run --rm php:8.5-cli php -m
[PHP Modules]
Core
ctype
curl
date
dom
fileinfo
filter
hash
iconv
json
lexbor
libxml
mbstring
mysqlnd
openssl
pcre
PDO
pdo_sqlite
Phar
posix
random
readline
Reflection
session
SimpleXML
sodium
SPL
sqlite3
standard
tokenizer
uri
xml
xmlreader
xmlwriter
Zend OPcache
zlib

[Zend Modules]
Zend OPcache
```

## Configuration

You can configure the behavior of the script, as well as fine-tune some extensions in order fit your needs, by using environment variables.

Here's an example:

```sh
IPE_LZF_BETTERCOMPRESSION=1 install-php-extensions lzf
```

Here's the list of all the supported environment variables:

| Extension | Environment variable | Description |
|---|---|---|
| | `IPE_DEBUG=1` | By setting this environment variable, the script will print all the commands it executes (it will be very verbose, useful only for debug purposes) |
| | `IPE_INSECURE=1` | By setting this environment variable, HTTPS certificate validation is disabled for network operations performed by the program |
| | `IPE_SAVE_PERMDEPS_TO=path` `IPE_SAVE_VOLDEPS_TO=path` | By setting this environment variable, the script will store in the path specified the list of APT/APK packages required by the installed PHP extensions (`IPE_SAVE_PERMDEPS_TO`) and/or the packages required to build the PHP extensions (`IPE_SAVE_VOLDEPS_TO`). Please remark that `install-php-extension` may configure the system in other ways ([example](https://github.com/mlocati/docker-php-extension-installer/blob/2.9.28/install-php-extensions#L2234-L2286)) |
| | `IPE_PROCESSOR_COUNT` | By default all available processors. Set this environment variable to override the number of processors detected by the script (used for parallel compilation) |
| | `IPE_DONT_ENABLE=1` | By default the script will install and enable the extensions. If you want to only install them (without enabling them) you can set this environment variable. To enable the extensions at a later time you can execute the command `docker-php-ext-enable-<extension>` (for example: `docker-php-ext-enable-xdebug`). **Beware**: installing some PHP extensions requires that other PHP extensions are already enabled, so use this feature wisely. |
| | `IPE_SKIP_CHECK=1` | By default the script will check if the extensions can be enabled: if you want to skip this check, you can use this flag. **Beware**: extensions may be enabled even if they break PHP: use this function wisely. |
| | `IPE_NOSTRIP=1` | By setting this environment variable, compiled PHP extensions will retain their debug symbols (useful for debugging of crashes like segmentation faults) |
| | `IPE_KEEP_SYSPKG_CACHE=1` | By default the script will clear the apt/apk/pear cache in order to save disk space. You can disable it by setting this environment variable |
| lzf | `IPE_LZF_BETTERCOMPRESSION=1` | By default `install-php-extensions` compiles the `lzf` extension to prefer speed over size; you can use this environment variable to compile it preferring size over speed |
| event | `IPE_EVENT_NAMESPACE=`... | By default, the `event` classes are defined in the root namespace. You can use this environment variable to specify a custom namespace |
| gd | `IPE_GD_WITHOUTAVIF=1` | Since PHP 8.1, gd supports the AVIF format. Enabling it requires compiling libaom/libdav1d/libyuv/libavif on Debian up to 11 and Alpine up to 3.14, which is time-consuming. You can disable AVIF support by setting this environment variable on those operating system versions |
| oci8 & pdo_oci | `IPE_INSTANTCLIENT_BASIC=1` | The oci8 and pdo_oci PHP extensions require [Oracle Instant Client](https://www.oracle.com/database/technologies/instant-client.html). In order to save disk space, we install the Basic Lite version: if you want to install the Basic (non-lite) version simply set this environment variable |
| http, intl, mongodb | `IPE_ICU_EN_ONLY=1` | Some extensions require the ICU library, use this flag to install a smaller, but English-only, ICU library on Alpine 3.16 and later |
| pspell | `IPE_ASPELL_LANGUAGES='...'` | Configure the languages to be made available (for example: `IPE_ASPELL_LANGUAGES='en fr'`). If omitted, we'll assume `en` |
| | `IPE_DEB_ARCHIVE` & `IPE_DEB_ARCHIVE_SECURITY` | The APT packages of very old Debian versions (eg Jessie) may have been archived: you can use these environment variables to specify custom URLs of these APT archives |
| newrelic | `IPE_NEWRELIC_DAEMON=1` | Install the NewRelic daemon |
| newrelic | `IPE_NEWRELIC_KEEPLOG=1` | Keep the log files of NewRelic setup (`/tmp/nrinstall-….tar`) |
| newrelic | `NR_INSTALL_KEY` | Your New Relic license key |
| ddtrace | `IPE_DD_APPSEC=1` | Also enable the Datadog [Application Security Monitoring](https://docs.datadoghq.com/security/application_security/) module (`ddappsec`). Requires PHP 7.0+ and the 1.x tracer line |
| ddtrace | `IPE_DD_PROFILING=1` | Also enable the Datadog [Continuous Profiler](https://docs.datadoghq.com/profiler/) module (`datadog-profiling`). Requires PHP 7.1+, Alpine 3.13+ (or any Debian) and the 1.x tracer line |
| swoole | `IPE_SWOOLE_WITHOUT_IOURING=1` | The io_uring kernel functionality is considered unsafe by security experts (see [here](https://security.googleblog.com/2023/06/learnings-from-kctf-vrps-42-linux.html) and [here](https://i.blackhat.com/BH-US-23/Presentations/US-23-Lin-bad_io_uring.pdf)). By default Swoole 6 and later is configured with io_uring support, use this environment variable to skip configuring io_uring |
| saxon | `IPE_SAXON_EDITION=EE` | The Saxon edition to be used: `EE` for Enterprise Edition (default), `PE` for Professional Edition, `HE` for Home Edition |

## Special requirements

Some extensions have special requirements:

| Extension | Requirements |
|---|---|
| <a name="special-requirements-for-cassandra"></a>cassandra | &bull; Not available in `jessie` docker images &bull; Not available in `stretch` docker images &bull; Not available in `buster` docker images &bull; Not available in `bullseye` docker images &bull; Not available in `bookworm` docker images &bull; Not available in `trixie` docker images |
| <a name="special-requirements-for-ddtrace"></a>ddtrace | Not available in `jessie` docker images |
| <a name="special-requirements-for-ecma_intl"></a>ecma_intl | &bull; Not available in `buster` docker images &bull; Not available in `bullseye` docker images &bull; Not available in `trixie` docker images &bull; Not available in `alpine3.22` docker images &bull; Not available in `alpine3.23` docker images &bull; Not available in `alpine3.24` docker images |
| <a name="special-requirements-for-geos"></a>geos | &bull; Not available in `alpine3.9` docker images &bull; Not available in `alpine3.10` docker images |
| <a name="special-requirements-for-judy"></a>judy | &bull; Not available in `alpine3.13` docker images &bull; Not available in `alpine3.14` docker images &bull; Not available in `alpine3.15` docker images |
| <a name="special-requirements-for-lz4"></a>lz4 | Not available in `jessie` docker images |
| <a name="special-requirements-for-memprof"></a>memprof | &bull; Not available in `alpine3.9` docker images &bull; Not available in `alpine3.10` docker images &bull; Not available in `alpine3.11` docker images &bull; Not available in `alpine3.12` docker images &bull; Not available in `alpine3.13` docker images &bull; Not available in `alpine3.14` docker images &bull; Not available in `alpine3.15` docker images |
| <a name="special-requirements-for-parallel"></a>parallel | Requires images with PHP compiled with thread-safety enabled (`zts`) |
| <a name="special-requirements-for-parle"></a>parle | Not available in `jessie` docker images |
| <a name="special-requirements-for-pdo_snowflake"></a>pdo_snowflake | Not available in `alpine` docker images |
| <a name="special-requirements-for-phpy"></a>phpy | Not available in `buster` docker images |
| <a name="special-requirements-for-pthreads"></a>pthreads | Requires images with PHP compiled with thread-safety enabled (`zts`) |
| <a name="special-requirements-for-saxon"></a>saxon | &bull; Not available in `alpine3.7` docker images &bull; Not available in `alpine3.8` docker images &bull; Not available in `alpine3.9` docker images &bull; Not available in `alpine3.10` docker images &bull; Not available in `alpine3.11` docker images &bull; Not available in `7.2-alpine` docker images &bull; Not available in `7.3-alpine` docker images &bull; Not available in `7.4-alpine` docker images |
| <a name="special-requirements-for-seasclick"></a>seasclick | &bull; Not available in `alpine3.23` docker images &bull; Not available in `alpine3.24` docker images |
| <a name="special-requirements-for-simdjson"></a>simdjson | &bull; Not available in `jessie` docker images &bull; Not available in `stretch` docker images |
| <a name="special-requirements-for-sodium"></a>sodium | Not available in `jessie` docker images |
| <a name="special-requirements-for-sqlsrv"></a>sqlsrv | &bull; Not available in `7.1-alpine3.9` docker images &bull; Not available in `7.1-alpine3.10` docker images |
| <a name="special-requirements-for-statgrab"></a>statgrab | &bull; Not available in `alpine3.12` docker images &bull; Not available in `alpine3.13` docker images &bull; Not available in `alpine3.14` docker images &bull; Not available in `alpine3.15` docker images &bull; Not available in `alpine3.16` docker images |
| <a name="special-requirements-for-v8js"></a>v8js | &bull; Not available in `buster` docker images &bull; Not available in `bullseye` docker images &bull; Not available in `alpine3.12` docker images &bull; Not available in `alpine3.13` docker images &bull; Not available in `alpine3.14` docker images &bull; Not available in `alpine3.15` docker images &bull; Not available in `alpine3.16` docker images &bull; Not available in `alpine3.17` docker images &bull; Not available in `alpine3.18` docker images |
| <a name="special-requirements-for-vips"></a>vips | &bull; Not available in `alpine3.9` docker images &bull; Not available in `jessie` docker images |
| <a name="special-requirements-for-wikidiff2"></a>wikidiff2 | &bull; Not available in `jessie` docker images &bull; Not available in `stretch` docker images |
| <a name="special-requirements-for-xpass"></a>xpass | Not available in `buster` docker images |

### How do I know which Linux distribution I am using?

You can run this command:

```sh
cat /etc/os-release
```

For example:
- for Debian 11 (Bullseye) you'll see:
  ```sh
  PRETTY_NAME="Debian GNU/Linux 11 (bullseye)"
  ```
- for Alpine Linux 3.14 you'll see:
  ```sh
  PRETTY_NAME="Alpine Linux v3.14"
  ```

## 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).  
In case of failure, a message is sent to a [Telegram Channel](https://t.me/docker_php_extension_installer).  
Feel free to subscribe to it to receive failure notifications.

## How to contribute

See the [`CONTIBUTING.md`](https://github.com/mlocati/docker-php-extension-installer/blob/master/CONTIBUTING.md) file.

## For the maintainers

See the [`MAINTAINERS.md`](https://github.com/mlocati/docker-php-extension-installer/blob/master/MAINTAINERS.md) file.

## 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:

docker-php-extension-installer

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README