Skip to content

docs: clarify how to build without Brotli #2793

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
andreybolonin wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −0
Open

docs: clarify how to build without Brotli #2793

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
8 changes: 8 additions & 0 deletions docs/compile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,11 @@ xcaddy build \

```

To build without Brotli, add `nobrotli` to `XCADDY_GO_BUILD_FLAGS` and remove
`--with github.com/dunglas/caddy-cbrotli` from the command above.
The build tag disables FrankenPHP's Brotli support, but does not remove explicitly included Caddy modules.
Keeping the `caddy-cbrotli` module still requires the Brotli library, even with `nobrotli`.

> [!TIP]
>
> If you're using musl libc (the default on Alpine Linux) and Symfony,
Expand All @@ -140,3 +145,6 @@ curl -L https://github.com/php/frankenphp/archive/refs/heads/main.tar.gz | tar x
cd frankenphp-main/caddy/frankenphp
CGO_CFLAGS=$(php-config --includes) CGO_LDFLAGS="$(php-config --ldflags) $(php-config --libs)" go build -tags=nobadger,nomysql,nopgx,deprecated_topic,deprecated_claim
```

To build without Brotli, add `nobrotli` to the `-tags` list above.
This also excludes the Brotli Caddy module imported by the bundled command, so the Brotli library is not required.
Loading