docs: xcaddy build flags (#385)

dunglas · Dec 14, 2023 · 1da3dbc · 1da3dbc
1 parent fd6e28d
commit 1da3dbc
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/docs/compile.md b/docs/compile.md
@@ -83,10 +83,22 @@ CGO_CFLAGS=$(php-config --includes) CGO_LDFLAGS="$(php-config --ldflags) $(php-c
 Alternatively, use [xcaddy](https://github.com/caddyserver/xcaddy) to compile FrankenPHP with [custom Caddy modules](https://caddyserver.com/docs/modules/):
 
 ```console
-CGO_ENABLED=1 xcaddy build \
+CGO_ENABLED=1 \
+XCADDY_GO_BUILD_FLAGS="-ldflags '-w -s'" \
+xcaddy build \
     --output frankenphp \
     --with github.com/dunglas/frankenphp/caddy \
     --with github.com/dunglas/mercure/caddy \
     --with github.com/dunglas/vulcain/caddy
     # Add extra Caddy modules here
 ```
+
+> [!TIP]
+>
+> If you're using musl libc (the default on Alpine Linux) and Symfony,
+> you may need to increase the default stack size.
+> Otherwise, you may get errors like `PHP Fatal error: Maximum call stack size of 83360 bytes reached during compilation. Try splitting expression`
+>
+> To do so, change the `XCADDY_GO_BUILD_FLAGS` environment variable to something like
+> `XCADDY_GO_BUILD_FLAGS=$'-ldflags "-w -s -extldflags \'-Wl,-z,stack-size=0x80000\'"'`
+> (change the value of the stack size according to your app needs).
diff --git a/docs/docker.md b/docs/docker.md
@@ -51,7 +51,7 @@ FROM dunglas/frankenphp:latest-builder AS builder
 COPY --from=caddy:builder /usr/bin/xcaddy /usr/bin/xcaddy
 
 # CGO must be enabled to build FrankenPHP
-ENV CGO_ENABLED=1 XCADDY_SETCAP=1
+ENV CGO_ENABLED=1 XCADDY_SETCAP=1 XCADDY_GO_BUILD_FLAGS="-ldflags '-w -s'"
 RUN xcaddy build \
     --output /usr/local/bin/frankenphp \
     --with github.com/dunglas/frankenphp=./ \
@@ -70,6 +70,11 @@ COPY --from=builder /usr/local/bin/frankenphp /usr/local/bin/frankenphp
 The `builder` image provided by FrankenPHP contains a compiled version of libphp.
 [Builders images](https://hub.docker.com/r/dunglas/frankenphp/tags?name=builder) are provided for all versions of FrankenPHP and PHP, both for Alpine and Debian.
 
+> [!TIP]
+>
+> If you're using Alpine Linux and Symfony,
+> you may need to [increase the default stack size](compile.md#using-xcaddy).
+
 ## Enabling the Worker Mode by Default
 
 Set the `FRANKENPHP_CONFIG` environment variable to start FrankenPHP with a worker script: