FrankenPHP a la capacité d'incorporer le code source et les assets des applications PHP dans un binaire statique et autonome.
Grâce à cette fonctionnalité, les applications PHP peuvent être distribuées en tant que binaires autonomes qui incluent l'application elle-même, l'interpréteur PHP et Caddy, un serveur web de qualité production.
Pour en savoir plus sur cette fonctionnalité, consultez la présentation faite par Kévin à la SymfonyCon 2023.
Avant de créer le binaire autonome, assurez-vous que votre application est prête à être intégrée.
Vous devrez probablement :
.git
ou les tests pour réduire la taille de votre binaire finalPar exemple, pour une application Symfony, lancez les commandes suivantes :
# Exporter le projet pour se débarrasser de .git/, etc.
mkdir $TMPDIR/my-prepared-app
git archive HEAD | tar -x -C $TMPDIR/my-prepared-app
cd $TMPDIR/my-prepared-app
# Définir les variables d'environnement appropriées
echo APP_ENV=prod > .env.local
echo APP_DEBUG=0 >> .env.local
# Supprimer les tests
rm -Rf tests/
# Installer les dépendances
composer install --ignore-platform-reqs --no-dev -a
# Optimiser le .env
composer dump-env prod
La manière la plus simple de créer un binaire Linux est d'utiliser le builder basé sur Docker que nous fournissons.
Créez un fichier nommé static-build.Dockerfile
dans le répertoire de votre application préparée :
FROM --platform=linux/amd64 dunglas/frankenphp:static-builder
# Copy your app
WORKDIR /go/src/app/dist/app
COPY . .
# Build the static binary, be sure to select only the PHP extensions you want
WORKDIR /go/src/app/
RUN EMBED=dist/app/ \
PHP_EXTENSIONS=ctype,iconv,pdo_sqlite \
./build-static.sh
[!CAUTION]
Certains fichiers
.dockerignore
(par exemple celui fourni par défaut par Symfony Docker) empêchent la copie du dossiervendor/
et des fichiers.env
. Assurez-vous d'ajuster ou de supprimer le fichier.dockerignore
avant le build.
Construisez:
docker build -t static-app -f static-build.Dockerfile .
Extrayez le binaire :
docker cp $(docker create --name static-app-tmp static-app):/go/src/app/dist/frankenphp-linux-x86_64 my-app ; docker rm static-app-tmp
Le binaire généré sera nommé my-app
dans le répertoire courant.
Si vous ne souhaitez pas utiliser Docker, ou souhaitez construire un binaire macOS, utilisez le script shell que nous fournissons :
git clone https://github.com/dunglas/frankenphp
cd frankenphp
EMBED=/path/to/your/app \
PHP_EXTENSIONS=ctype,iconv,pdo_sqlite \
./build-static.sh
Le binaire obtenu est le fichier nommé frankenphp-<os>-<arch>
dans le répertoire dist/
.
C'est tout ! Le fichier my-app
(ou dist/frankenphp-<os>-<arch>
sur d'autres systèmes d'exploitation) contient votre application autonome !
Pour démarrer l'application web, exécutez :
./my-app php-server
Si votre application contient un script worker, démarrez le worker avec quelque chose comme :
./my-app php-server --worker public/index.php
Pour activer HTTPS (un certificat Let's Encrypt est automatiquement créé), HTTP/2 et HTTP/3, spécifiez le nom de domaine à utiliser :
./my-app php-server --domain localhost
Vous pouvez également exécuter les scripts CLI PHP incorporés dans votre binaire :
./my-app php-cli bin/console
Consultez la documentation sur la compilation statique pour voir comment personnaliser le binaire (extensions, version PHP...).
Sous Linux, le binaire est compressé par défaut à l'aide de UPX.
Sous Mac, pour réduire la taille du fichier avant de l'envoyer, vous pouvez le compresser.
Nous recommandons xz
.