diff --git a/README.md b/README.md index 0995172a2..40b342541 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ with [FrankenPHP](https://frankenphp.dev) and [Caddy](https://caddyserver.com/) - Production, development and CI ready - Just 1 service by default -- Blazing-fast performance thanks to [the worker mode of FrankenPHP](https://github.com/dunglas/frankenphp/blob/main/docs/worker.md) (automatically enabled in prod mode) +- Blazing-fast performance thanks to [the worker mode of FrankenPHP](https://frankenphp.dev/docs/worker/) - [Installation of extra Docker Compose services](docs/extra-services.md) with Symfony Flex - Automatic HTTPS (in dev and prod) - HTTP/3 and [Early Hints](https://symfony.com/blog/new-in-symfony-6-3-early-hints) support diff --git a/docs/existing-project.md b/docs/existing-project.md index 472ecb4c4..ebdc7ecfa 100644 --- a/docs/existing-project.md +++ b/docs/existing-project.md @@ -26,8 +26,8 @@ Enable the Docker support of Symfony Flex: composer config --json extra.symfony.docker 'true' ``` -If you want to use the [worker mode of FrankenPHP](https://github.com/php/frankenphp/blob/main/docs/worker.md), -add the FrankenPHP runtime for Symfony: +The [worker mode of FrankenPHP](https://frankenphp.dev/docs/worker/) is enabled by default. +To use it with Symfony ≤ 7.3, install the FrankenPHP runtime: ```console composer require runtime/frankenphp-symfony @@ -35,8 +35,8 @@ composer require runtime/frankenphp-symfony > [!TIP] > -> With Symfony 7.4, the `runtime/frankenphp-symfony` package isn't required anymore, -> as Symfony Runtime natively supports FrankenPHP worker mode. +> You can disable worker mode by removing the `worker` directive from the `frankenphp` +> global option in your `Caddyfile`. Re-execute the recipes to update the Docker-related files according to the packages you use: @@ -65,11 +65,3 @@ docker compose up --wait ``` Browse `https://localhost`, your Docker configuration is ready! - -> [!NOTE] -> -> The worker mode of FrankenPHP is enabled by default in the Caddyfile. -> To disabled it, comment the `worker {}` section of this file. -> -> You may also remove `runtime/frankenphp-symfony` -> if you never plan on using the worker mode. diff --git a/docs/options.md b/docs/options.md index fae653369..4504d6f00 100644 --- a/docs/options.md +++ b/docs/options.md @@ -82,7 +82,8 @@ to inject options block, directive or configuration. | `CADDY_SERVER_EXTRA_DIRECTIVES` | the [`Caddyfile` directives](https://caddyserver.com/docs/caddyfile/concepts#directives) | | | `CADDY_SERVER_LOG_OPTIONS` | the [server log options block](https://caddyserver.com/docs/caddyfile/directives/log), one per line | | | `SERVER_NAME` | the server name or address | `localhost` | -| `FRANKENPHP_CONFIG` | a list of extra [FrankenPHP directives](https://frankenphp.dev/docs/config/#caddyfile-config), one per line | `import worker.Caddyfile` | +| `FRANKENPHP_CONFIG` | a list of extra [FrankenPHP global directives](https://frankenphp.dev/docs/config/#caddyfile-config), one per line | | +| `FRANKENPHP_WORKER_CONFIG` | a list of extra [FrankenPHP worker directives](https://frankenphp.dev/docs/config/#caddyfile-config), one per line | | | `MERCURE_TRANSPORT_URL` | the value passed to the `transport_url` directive | `bolt:///data/mercure.db` | | `MERCURE_PUBLISHER_JWT_KEY` | the JWT key to use for publishers | | | `MERCURE_PUBLISHER_JWT_ALG` | the JWT algorithm to use for publishers | `HS256` | diff --git a/docs/production.md b/docs/production.md index f1cbd824f..6df62a94d 100644 --- a/docs/production.md +++ b/docs/production.md @@ -98,14 +98,6 @@ Your server is up and running, and a HTTPS certificate has been automatically generated for you. Go to `https://your-domain-name.example.com` and enjoy! -> [!NOTE] -> -> The worker mode of FrankenPHP is enabled by default in prod. -> To disable it, add the env var `FRANKENPHP_CONFIG` as empty -> to the `compose.prod.yaml` file. - - - > [!CAUTION] > > Docker can have a cache layer, make sure you have the right build