Skip to content

Add vips and ffi extensions and PHP_EXTENSIONS setting #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 2, 2025
Merged

Add vips and ffi extensions and PHP_EXTENSIONS setting #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f94e064
Add PHP_EXTENSIONS setting to enable specific set of extensions
baschny Jul 2, 2025
8893828
Readd removed extensions (apcu, bcmath)
baschny Jul 2, 2025
2e344c1
Add vips extension (image processing)
baschny Jul 2, 2025
c01c13d
Keep special handling of XDEBUG_MOD
baschny Jul 2, 2025
abc5063
Also add ffi for newer vips implementations
baschny Jul 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,12 @@ COPY --from=mlocati/php-extension-installer /usr/bin/install-php-extensions /usr
RUN <<EOT bash
set -ex
PHP_EXTENSIONS=(
"apcu"
"bcmath"
"bz2"
"calendar"
"exif"
"ffi"
"gd"
"gettext"
"imagick"
Expand All @@ -52,6 +55,7 @@ RUN <<EOT bash
"sysvsem"
"sysvshm"
"uuid"
"vips"
"xdebug"
"yaml"
"zip"
Expand Down
38 changes: 23 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ This image includes the following additional extensions:
* bz2
* calendar
* exif
* ffi
* gd
* gettext
* igbinary
Expand All @@ -72,11 +73,17 @@ This image includes the following additional extensions:
* sysvsem
* sysvshm
* uuid
* vips
* xdebug
* yaml
* zip

Additionally, it includes the following utilities for TYPO3 specific workflows:
All extensions are enabled by default. If you want to only disable some of them,
you can use the setting `PHP_DISABLE_EXTENSIONS` in the environment variables.
If you want to override the list of enabled extensions, you can use the
`PHP_EXTENSIONS` environment variable.

Additionally, the image includes the following utilities for TYPO3 specific workflows:

* GraphicsMagick
* curl
Expand Down Expand Up @@ -141,22 +148,23 @@ Application root is `/app`. Application runs as user `application` (uid=1000).

### Settings (through environment variables)

| Setting | Image | Default | Description |
|----------------------------------------|----------|-------------|------------------------------------------------------------------------------------------------------------------------------------------|
| `XDEBUG_MODE` | fpm, ssh | debug | Or set to `develop` (slow) or `none` to turn it off completely. See https://xdebug.org/docs/all_settings#mode |
| Setting | Image | Default | Description |
|--------------------------------------------|----------|-------------|------------------------------------------------------------------------------------------------------------------------------------------|
| `XDEBUG_MODE` | fpm, ssh | debug | Or set to `develop` (slow) or `none` to turn it off completely. See https://xdebug.org/docs/all_settings#mode |
| `DB_HOST`, `DB_USER`, `DB_PASS`, `DB_NAME` | ssh | | These will create a `.my.cnf` for the user. You can use the same variables in your `docker-compose.yml` to configure the MariaDB image. |
| `APPLICATION_UID`, `APPLICATION_GID` | fpm, ssh | 1000, 1000 | UID and GID for the application user. Change to match your local user in case you use bind-mounts (Linux only) |
| `IMPORT_GITLAB_SERVER` | ssh | git.cron.eu | Gitlab instance to import SSH key from |
| `IMPORT_GITLAB_PUB_KEYS` | ssh | | Gitlab user to import SSH keys from |
| `IMPORT_GITHUB_PUB_KEYS` | ssh | | GitHub user to import SSH keys from |
| `IMPORT_PUB_KEYS` | ssh | | Additional SSH public keys to load, comma separated |
| `SSH_CONFIG` | ssh | | The whole content of the `.ssh/config` file |
| `SSH_KNOWN_HOSTS` | ssh | | The whole content of the `.ssh/known_hosts` file |
| `SSH_PRIVATE_KEY` | ssh | | A SSH private key to load in an `ssh-agent`, useful if you run a SSH container with commands | |
| `ENV` | ssh | | The name of the environment to show on the shell prompt |
| `PHP_INI_OVERRIDE` | fpm, ssh | | Allow overriding php.ini settings. Simply the multiline content for a php.ini here. Use "\n" for multiline i.e. in ECS |
| `PHP_FPM_OVERRIDE` | fpm | | Allow overriding php-fpm pool settings. The multiline content for php-fpm.conf here. Use "\n" for multiline i.e. in ECS |
| `PHP_DISABLE_EXTENSIONS` | fpm, ssh | | Comma separated list of PHP extensions to disable. |
| `IMPORT_GITLAB_SERVER` | ssh | git.cron.eu | Gitlab instance to import SSH key from |
| `IMPORT_GITLAB_PUB_KEYS` | ssh | | Gitlab user to import SSH keys from |
| `IMPORT_GITHUB_PUB_KEYS` | ssh | | GitHub user to import SSH keys from |
| `IMPORT_PUB_KEYS` | ssh | | Additional SSH public keys to load, comma separated |
| `SSH_CONFIG` | ssh | | The whole content of the `.ssh/config` file |
| `SSH_KNOWN_HOSTS` | ssh | | The whole content of the `.ssh/known_hosts` file |
| `SSH_PRIVATE_KEY` | ssh | | A SSH private key to load in an `ssh-agent`, useful if you run a SSH container with commands | |
| `ENV` | ssh | | The name of the environment to show on the shell prompt |
| `PHP_INI_OVERRIDE` | fpm, ssh | | Allow overriding php.ini settings. Simply the multiline content for a php.ini here. Use "\n" for multiline i.e. in ECS |
| `PHP_FPM_OVERRIDE` | fpm | | Allow overriding php-fpm pool settings. The multiline content for php-fpm.conf here. Use "\n" for multiline i.e. in ECS |
| `PHP_EXTENSIONS` | fpm, ssh | (all) | Comma separated list of PHP extensions to enable (if this is not set, all are enabled). |
| `PHP_DISABLE_EXTENSIONS` | fpm, ssh | | Comma separated list of PHP extensions to disable (in case you keep all enabled, you can disable individual ones, i.e. igbinary). |

## Example usage

Expand Down
5 changes: 5 additions & 0 deletions example-app/.env.docker
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
# See https://xdebug.org/docs/develop#mode
XDEBUG_MODE=debug

# If you only want a specific subset of extensions enabled. This is the default set of all:
#PHP_EXTENSIONS=apcu,bcmath,bz2,calendar,exif,ffi,gd,gettext,imagick,intl,mysqli,opcache,pcntl,pdo_mysql,redis,shmop,soap,sockets,sysvmsg,sysvsem,sysvshm,uuid,vips,xdebug,yaml,zip
# Baseline, minimal set of extensions that are required for most applications
#PHP_EXTENSIONS=apcu,bcmath,bz2,calendar,exif,gd,gettext,intl,mysqli,opcache,pdo_mysql,zip,yaml

# -----------------------------------------
# For the ssh container
# -----------------------------------------
Expand Down
72 changes: 54 additions & 18 deletions files/entrypoint-extras.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,60 @@
#
# Mainly tweaking php settings based on ENV variables

# Controls which extensions are enabled.

if [ ! -z "${PHP_EXTENSIONS}" ]; then
# If PHP_EXTENSIONS is set: only enable the ones specified

echo "* PHP_EXTENSIONS: $PHP_EXTENSIONS"
echo "* Disabling all extensions and enabling only specified ones."

# First, disable all extensions by renaming them
if ls /usr/local/etc/php/conf.d/docker-php-ext-*.ini 1> /dev/null 2>&1; then
for file in /usr/local/etc/php/conf.d/docker-php-ext-*.ini; do
mv "$file" "$file.disabled"
done
fi

# Now, enable the extensions listed in PHP_EXTENSIONS
for ext in $(echo "$PHP_EXTENSIONS" | sed -e 's/,/ /g'); do
disabled_ext_file="/usr/local/etc/php/conf.d/docker-php-ext-$ext.ini.disabled"
enabled_ext_file="/usr/local/etc/php/conf.d/docker-php-ext-$ext.ini"

if [ -f "$disabled_ext_file" ]; then
echo "* Enabling PHP extension: $ext"
mv "$disabled_ext_file" "$enabled_ext_file"
elif [ -f "$enabled_ext_file" ]; then
# This case should not happen if the above disabling loop worked, but as a fallback.
echo "* PHP extension $ext was already enabled."
else
echo "* WARNING: PHP extension $ext not found, cannot enable."
fi
done
else
# If PHP_EXTENSIONS is not set, all extensions are enabled by default.

# Enable all extensions which might have been disabled at some point first
if ls /usr/local/etc/php/conf.d/*php-ext*.disabled 1> /dev/null 2>&1; then
for file in /usr/local/etc/php/conf.d/*php-ext*.disabled; do
mv "$file" "${file%.disabled}"
done
fi
# Disable extensions based on PHP_DISABLE_EXTENSIONS
if [ ! -z "${PHP_DISABLE_EXTENSIONS}" ]; then
for ext in $(echo $PHP_DISABLE_EXTENSIONS | sed -e 's/,/ /g'); do
if [ -f "/usr/local/etc/php/conf.d/docker-php-ext-$ext.ini" ]; then
echo "* Disabling PHP extension: $ext"
mv /usr/local/etc/php/conf.d/docker-php-ext-$ext.ini /usr/local/etc/php/conf.d/docker-php-ext-$ext.ini.disabled
else
echo "* WARNING: PHP extension $ext not found, cannot disable"
fi
done
fi
fi

# Special handling for XDEBUG through XDEBUG_MODE:

# Really disable XDEBUG if not required
if [ -z "${XDEBUG_MODE}" ] || [ "${XDEBUG_MODE}" = "off" ]; then
# completely not load xdebug if its off
Expand All @@ -14,24 +68,6 @@ else
echo "zend_extension=xdebug.so" > /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
fi

# Enable all extensions which might have been disabled at some point first
if ls /usr/local/etc/php/conf.d/*php-ext*.disabled 1> /dev/null 2>&1; then
for file in /usr/local/etc/php/conf.d/*php-ext*.disabled; do
mv "$file" "${file%.disabled}"
done
fi
# Disable extensions based on PHP_DISABLE_EXTENSIONS
if [ ! -z "${PHP_DISABLE_EXTENSIONS}" ]; then
for ext in $(echo $PHP_DISABLE_EXTENSIONS | sed -e 's/,/ /g'); do
if [ -f "/usr/local/etc/php/conf.d/docker-php-ext-$ext.ini" ]; then
echo "* Disabling PHP extension: $ext"
mv /usr/local/etc/php/conf.d/docker-php-ext-$ext.ini /usr/local/etc/php/conf.d/docker-php-ext-$ext.ini.disabled
else
echo "* WARNING: PHP extension $ext not found, cannot disable"
fi
done
fi

if [ ! -z "${APPLICATION_UID}" ]; then
echo "* Change uid of 'application' user to $APPLICATION_UID"
usermod -u $APPLICATION_UID application
Expand Down