Compiler depuis les sources

Ce document explique comment créer un build FrankenPHP qui chargera PHP en tant que bibliothèque dynamique. C’est la méthode recommandée.

Alternativement, il est aussi possible de créer des builds statiques.

FrankenPHP est compatible avec PHP 8.2 et versions ultérieures.

La manière la plus simple d’installer une version de libphp compatible avec FrankenPHP est d’utiliser les paquets ZTS fournis par Homebrew PHP.

Tout d’abord, si ce n’est déjà fait, installez Homebrew.

Ensuite, installez la variante ZTS de PHP, Brotli (facultatif, pour la prise en charge de la compression) et watcher (facultatif, pour la détection des modifications de fichiers) :

brew install shivammathur/php/php-zts brotli watcher
brew link --overwrite --force shivammathur/php/php-zts

Vous pouvez également compiler PHP à partir des sources avec les options requises par FrankenPHP en suivant ces étapes.

Tout d’abord, téléchargez les sources de PHP et extrayez-les :

tar xf php-*
cd php-*/

Ensuite, configurez PHP pour votre système d’exploitation.

Les options de configuration suivantes sont nécessaires pour la compilation, mais vous pouvez également inclure d’autres options selon vos besoins, par exemple pour ajouter des extensions et fonctionnalités supplémentaires.

./configure \
    --enable-embed \
    --enable-zts \
    --disable-zend-signals \
    --enable-zend-max-execution-timers

Utilisez le gestionnaire de paquets Homebrew pour installer les dépendances obligatoires et optionnelles :

brew install libiconv bison brotli re2c pkg-config watcher
echo 'export PATH="/opt/homebrew/opt/bison/bin:$PATH"' >> ~/.zshrc

Puis exécutez le script de configuration :

./configure \
    --enable-embed \
    --enable-zts \
    --disable-zend-signals \
    --disable-opcache-jit \
    --with-iconv=/opt/homebrew/opt/libiconv/

Finalement, compilez et installez PHP :

make -j"$(getconf _NPROCESSORS_ONLN)"
sudo make install

Certaines fonctionnalités de FrankenPHP nécessitent des dépendances optionnelles qui doivent être installées. Ces fonctionnalités peuvent également être désactivées en passant des tags de compilation au compilateur Go.

La méthode recommandée consiste à utiliser xcaddy pour compiler FrankenPHP. xcaddy permet également d’ajouter facilement des modules Caddy personnalisés et des extensions FrankenPHP :

CGO_ENABLED=1 \
XCADDY_GO_BUILD_FLAGS="-ldflags='-w -s' -tags=nobadger,nomysql,nopgx" \
CGO_CFLAGS=$(php-config --includes) \
CGO_LDFLAGS="$(php-config --ldflags) $(php-config --libs)" \
xcaddy build \
    --output frankenphp \
    --with github.com/dunglas/frankenphp/caddy \
    --with github.com/dunglas/caddy-cbrotli \
    --with github.com/dunglas/mercure/caddy \
    --with github.com/dunglas/vulcain/caddy
    # Ajoutez les modules Caddy supplémentaires et les extensions FrankenPHP ici

Tip

Si vous utilisez musl libc (la bibliothèque par défaut sur Alpine Linux) et Symfony, vous pourriez avoir besoin d’augmenter la taille par défaut de la pile. Sinon, vous pourriez rencontrer des erreurs telles que PHP Fatal error: Maximum call stack size of 83360 bytes reached during compilation. Try splitting expression

Pour ce faire, modifiez la variable d’environnement XCADDY_GO_BUILD_FLAGS en quelque chose comme XCADDY_GO_BUILD_FLAGS=$'-ldflags "-w -s -extldflags \'-Wl,-z,stack-size=0x80000\'"' (modifiez la valeur de la taille de la pile selon les besoins de votre application).

Il est également possible de compiler FrankenPHP sans xcaddy en utilisant directement la commande go :

curl -L https://github.com/dunglas/frankenphp/archive/refs/heads/main.tar.gz | tar xz
cd frankenphp-main/caddy/frankenphp
CGO_CFLAGS=$(php-config --includes) CGO_LDFLAGS="$(php-config --ldflags) $(php-config --libs)" go build -tags=nobadger,nomysql,nopgx