docker-php-extension-installer Documentation

Technical Documentation: mlocati/docker-php-extension-installer

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (README.md) Copy Section

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.

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 section.

Usage Copy Chapter

You have many ways to use this script within your Dockerfiles.

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

Downloading the script on the fly with `ADD` Copy Section

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` Copy Section

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` Copy Section

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 Copy Section

• using GitHub Container Registry

  dockerfile Copy

  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 Copy

  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 Copy Section

• using GitHub Container Registry

  dockerfile Copy

  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 Copy

  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 Copy Chapter

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

install-php-extensions xdebug-2.9.7

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

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

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

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:

install-php-extensions mongodb-stable

Installing an extension from its source code Copy Chapter

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 GitHub repository,
  you can simply write:
  sh Copy

  # 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/[email protected]
  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 Copy

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

  # 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? Copy Chapter

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:
  text Copy

  install-php-extensions zip-stable

• for installing from source code: use the syntax specified above. For example:
  text Copy

  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 Copy Chapter

You can also install composer, and you also can specify a major version of it, or a full version.

Examples:

# 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 Copy Chapter

The root CA certificate of Let's Encrypt changes (more details here).
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:

install-php-extensions @fix_letsencrypt

/* Detailed source-code truncated for AI context efficiency. */

$ 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 Copy Chapter

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:

IPE_LZF_BETTERCOMPRESSION=1 install-php-extensions lzf

/* Detailed source-code truncated for AI context efficiency. */

cat /etc/os-release

For example:

• for Debian 11 (Bullseye) you'll see:
  sh Copy

  PRETTY_NAME="Debian GNU/Linux 11 (bullseye)"

• for Alpine Linux 3.14 you'll see:
  sh Copy

  PRETTY_NAME="Alpine Linux v3.14"

Library versions Copy Chapter

Some PHP extensions require libraries that install-php-extensions compiles or downloads when they aren't provided by the system.
You can use a version different from the default one by setting the corresponding environment variable.
For example:

IPE_LIBVERSION_XCRYPT=4.4.36 install-php-extensions xpass

Beware: other versions may not work, so use this feature at your own risk.

Here's the list of these libraries (the default versions are the ones used by the latest release of install-php-extensions):

Tests Copy Chapter

When submitting a pull request, a GitHub Action is executed to check if affected PHP extensions actually work (see below).

Furthermore, we also check that new versions of the PHP extensions and of the libraries they use will still work.
This is done on a scheduled basis with another GitHub Action.
In case of failure, a message is sent to a Telegram Channel.
Feel free to subscribe to it to receive failure notifications.

How to contribute Copy Chapter

See the CONTRIBUTING.md file.

For the maintainers Copy Chapter

See the MAINTAINERS.md file.

Do you want to really say thank you? Copy Chapter

You can offer me a monthly coffee or a one-time coffee :wink:

--- METRICS ---

• Files Extracted: 1
• Estimated Token Budget: ~3875 tokens
• Canonical Reference: https://codewiki.google/github.com/mlocati/docker-php-extension-installer