Skip to content

fix: don't compress the Mercure SSE endpoint in the sample Caddyfile #2692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dunglas wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: don't compress the Mercure SSE endpoint in the sample Caddyfile #2692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion caddy/frankenphp/Caddyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
#}

root {$SERVER_ROOT:public/}
encode zstd br gzip
# Compressed SSE streams cost memory per subscriber and enable BREACH-style attacks.
@compressible not path /.well-known/mercure
encode @compressible zstd br gzip

# Uncomment the following lines to enable Mercure and Vulcain modules
#mercure {
Expand Down
8 changes: 8 additions & 0 deletions docs/mercure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,14 @@ Access tokens must carry the identifier of the `issuer` they were signed by in t
>
> Uncomment the Mercure section in `/etc/frankenphp/Caddyfile` to enable it.

If you enable compression with the `encode` directive, exclude the hub from it:
compressed SSE streams cost memory per subscriber and enable BREACH-style attacks.

```caddyfile
@compressible not path /.well-known/mercure
encode @compressible zstd br gzip
```

### With `php-server`

`frankenphp php-server --mercure` starts the hub without a `Caddyfile`, configured by environment variables:
Expand Down
Loading