Skip to content

Commit 1b2cd64

Browse files
committed
docs: improve documentation of FrankenPHP worker mode
1 parent dab1308 commit 1b2cd64

File tree

4 files changed

+7
-20
lines changed

4 files changed

+7
-20
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ with [FrankenPHP](https://frankenphp.dev) and [Caddy](https://caddyserver.com/)
1717

1818
- Production, development and CI ready
1919
- Just 1 service by default
20-
- 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)
20+
- Blazing-fast performance thanks to [the worker mode of FrankenPHP](https://frankenphp.dev/docs/worker/)
2121
- [Installation of extra Docker Compose services](docs/extra-services.md) with Symfony Flex
2222
- Automatic HTTPS (in dev and prod)
2323
- HTTP/3 and [Early Hints](https://symfony.com/blog/new-in-symfony-6-3-early-hints) support

docs/existing-project.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ Enable the Docker support of Symfony Flex:
2626
composer config --json extra.symfony.docker 'true'
2727
```
2828

29-
If you want to use the [worker mode of FrankenPHP](https://github.com/php/frankenphp/blob/main/docs/worker.md),
30-
add the FrankenPHP runtime for Symfony:
29+
The [worker mode of FrankenPHP](https://frankenphp.dev/docs/worker/) is enabled by default.
30+
To use it with Symfony ≤ 7.3, install the FrankenPHP runtime:
3131

3232
```console
3333
composer require runtime/frankenphp-symfony
3434
```
3535

3636
> [!TIP]
3737
>
38-
> With Symfony 7.4, the `runtime/frankenphp-symfony` package isn't required anymore,
39-
> as Symfony Runtime natively supports FrankenPHP worker mode.
38+
> You can disable worker mode by removing the `worker` directive from the `frankenphp`
39+
> global option in your `Caddyfile`.
4040
4141
Re-execute the recipes to update the Docker-related files according to
4242
the packages you use:
@@ -65,11 +65,3 @@ docker compose up --wait
6565
```
6666

6767
Browse `https://localhost`, your Docker configuration is ready!
68-
69-
> [!NOTE]
70-
>
71-
> The worker mode of FrankenPHP is enabled by default in the Caddyfile.
72-
> To disabled it, comment the `worker {}` section of this file.
73-
>
74-
> You may also remove `runtime/frankenphp-symfony`
75-
> if you never plan on using the worker mode.

docs/options.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,8 @@ to inject options block, directive or configuration.
8282
| `CADDY_SERVER_EXTRA_DIRECTIVES` | the [`Caddyfile` directives](https://caddyserver.com/docs/caddyfile/concepts#directives) | |
8383
| `CADDY_SERVER_LOG_OPTIONS` | the [server log options block](https://caddyserver.com/docs/caddyfile/directives/log), one per line | |
8484
| `SERVER_NAME` | the server name or address | `localhost` |
85-
| `FRANKENPHP_CONFIG` | a list of extra [FrankenPHP directives](https://frankenphp.dev/docs/config/#caddyfile-config), one per line | `import worker.Caddyfile` |
85+
| `FRANKENPHP_CONFIG` | a list of extra [FrankenPHP global directives](https://frankenphp.dev/docs/config/#caddyfile-config), one per line | |
86+
| `FRANKENPHP_WORKER_CONFIG` | a list of extra [FrankenPHP worker directives](https://frankenphp.dev/docs/config/#caddyfile-config), one per line | |
8687
| `MERCURE_TRANSPORT_URL` | the value passed to the `transport_url` directive | `bolt:///data/mercure.db` |
8788
| `MERCURE_PUBLISHER_JWT_KEY` | the JWT key to use for publishers | |
8889
| `MERCURE_PUBLISHER_JWT_ALG` | the JWT algorithm to use for publishers | `HS256` |

docs/production.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,6 @@ Your server is up and running, and a HTTPS certificate has been automatically
9898
generated for you.
9999
Go to `https://your-domain-name.example.com` and enjoy!
100100

101-
> [!NOTE]
102-
>
103-
> The worker mode of FrankenPHP is enabled by default in prod.
104-
> To disable it, add the env var `FRANKENPHP_CONFIG` as empty
105-
> to the `compose.prod.yaml` file.
106-
107101
<!-- -->
108102

109103
> [!CAUTION]

0 commit comments

Comments
 (0)