diff --git a/.tests/get-modules.sh b/.tests/get-modules.sh index 20ee705b..321e7ee7 100755 --- a/.tests/get-modules.sh +++ b/.tests/get-modules.sh @@ -345,7 +345,7 @@ MODS="$( echo "${PHP52_MODS}, ${PHP53_MODS}, ${PHP54_MODS}, ${PHP55_MODS}, ${PHP ### ### Get disabled modules ### -DISABLED=",ioncube,$( grep -E '^PHP_MODULES_DISABLE=' "${SCRIPTPATH}/../env-example" | sed 's/.*=//g' )," +DISABLED=",blackfire,ioncube,$( grep -E '^PHP_MODULES_DISABLE=' "${SCRIPTPATH}/../env-example" | sed 's/.*=//g' )," #echo $DISABLED B="✔" # Enabled base modules (cannot be disabled) E="🗸" # Enabled mods modules (can be disabled) diff --git a/docs/configuration-files/env-file.rst b/docs/configuration-files/env-file.rst index 2c085eb1..408bc88c 100644 --- a/docs/configuration-files/env-file.rst +++ b/docs/configuration-files/env-file.rst @@ -1183,7 +1183,7 @@ Enable any non-standard PHP modules in a comma separated list. +------------------------+--------------------------------------+------------------+ .. note:: - Currently only ``ioncube`` is available to enable. + Currently only ``ioncube`` and ``blackfire`` are available to enable. Example: @@ -1194,6 +1194,33 @@ Example: # Enable ionCube PHP_MODULES_ENABLE=ioncube + # When enabling blackfire or ionCube you must also disable xdebug: + # https://xdebug.org/docs/install#compat + PHP_MODULES_DISABLE=xdebug + +.. code-block:: bash + :caption: .env + :emphasize-lines: 2 + + # Enable blackfire + PHP_MODULES_ENABLE=blackfire + + # When enabling blackfire or ionCube you must also disable xdebug: + # https://xdebug.org/docs/install#compat + PHP_MODULES_DISABLE=xdebug + +.. code-block:: bash + :caption: .env + :emphasize-lines: 2 + + # Enable both, blackfire and ionCube + PHP_MODULES_ENABLE=blackfire,ioncube + + # When enabling blackfire or ionCube you must also disable xdebug: + # https://xdebug.org/docs/install#compat + PHP_MODULES_DISABLE=xdebug + + .. _env_file_php_modules_disable: PHP_MODULES_DISABLE @@ -1201,11 +1228,11 @@ PHP_MODULES_DISABLE Disable any PHP modules in a comma separated list. -+-------------------------+--------------------------------------+-------------------------------------------------------------+ -| Name | Allowed values | Default value | -+=========================+======================================+=============================================================+ -| ``PHP_MODULES_DISABLE`` | comma separated list of module names | ``blackfire,oci8,PDO_OCI,pdo_sqlsrv,sqlsrv,rdkafka,swoole`` | -+-------------------------+--------------------------------------+-------------------------------------------------------------+ ++-------------------------+--------------------------------------+---------------------------------------------------+ +| Name | Allowed values | Default value | ++=========================+======================================+===================================================+ +| ``PHP_MODULES_DISABLE`` | comma separated list of module names | ``oci8,PDO_OCI,pdo_sqlsrv,sqlsrv,rdkafka,swoole`` | ++-------------------------+--------------------------------------+---------------------------------------------------+ Example: diff --git a/env-example b/env-example index 3598f276..8b3e3683 100644 --- a/env-example +++ b/env-example @@ -458,9 +458,11 @@ HOST_PATH_MONGO_DATADIR=./data/mongo ### ### Enable certain PHP modules which are not enabled by default ### -### Currently the only module that can be enabled is 'ioncube' +### Currently the only modules that can be enabled are 'ioncube' and 'blackfire' +### Also ensure to disable xdebug when using any of the above: +### https://xdebug.org/docs/install#compat ### -### PHP_MODULES_ENABLE=ioncube +### PHP_MODULES_ENABLE=ioncube, blackfire ### PHP_MODULES_ENABLE= @@ -472,7 +474,7 @@ PHP_MODULES_ENABLE= ### ### PHP_MODULES_DISABLE=xdebug,imagick,swoole ### -PHP_MODULES_DISABLE=blackfire,oci8,PDO_OCI,pdo_sqlsrv,sqlsrv,rdkafka,swoole +PHP_MODULES_DISABLE=oci8,PDO_OCI,pdo_sqlsrv,sqlsrv,rdkafka,swoole ###