backbrain/frankenphp-symfony

FrankenPHP runtime for Symfony

v1.0.0 2024-04-05 12:45 UTC

Requires

• php: >=8.1
• symfony/dependency-injection: ^5.4 || ^6.0 || ^7.0
• symfony/http-kernel: ^5.4 || ^6.0 || ^7.0
• symfony/runtime: ^5.4 || ^6.0 || ^7.0

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• Kévin Dunglas

README

A runtime for FrankenPHP.

If you are new to the Symfony Runtime component, read more in the main readme.

Installation

composer require backbrain/frankenphp-symfony

Usage

Define the environment variable APP_RUNTIME for your application.

Dotenv Component is executed after Runtime Component, so APP_RUNTIME must be available in your container.

The FRANKENPHP_ environment variables are used to configure the runtime. If omitted, the default values are used.

docker run \
    -e FRANKENPHP_CONFIG="worker ./public/index.php" \
    -e APP_RUNTIME=Runtime\\FrankenPhpSymfony\\Runtime \
    -e FRANKENPHP_LOOP_MAX=500 \
    -e FRANKENPHP_KERNEL_REBOOT=never \
    -v $PWD:/app \
    -p 80:80 -p 443:443 \
    dunglas/frankenphp

// public/index.php

use App\Kernel;

require_once dirname(__DIR__).'/vendor/autoload_runtime.php';

return function (array $context) {
    return new Kernel($context['APP_ENV'], (bool) $context['APP_DEBUG']);
};

Options

• frankenphp_loop_max: the number of requests after which the worker must restart, to prevent weird memory leaks (default to 500, set to -1 to never restart)
• frankenphp_kernel_reboot: whether the kernel should be rebooted after a request (default to never, set to always to reboot on each request)