Skip to content

Commit 6cc7fb7

Browse files
committed
docs: static builds and embedded apps are not available on Windows
1 parent 1f216dd commit 6cc7fb7

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

docs/embed.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,12 @@ EMBED=/path/to/your/app ./build-static.sh
103103

104104
The resulting binary is the file named `frankenphp-<os>-<arch>` in the `dist/` directory.
105105

106+
> [!NOTE]
107+
>
108+
> Standalone binaries can currently be created for Linux and macOS only,
109+
> as [static builds are not available for Windows](static.md).
110+
> To create a Linux binary from Windows, use the Docker-based builder or [WSL](https://learn.microsoft.com/windows/wsl/).
111+
106112
## Using the binary
107113

108114
This is it! The `my-app` file (or `dist/frankenphp-<os>-<arch>` on other OSes) contains your self-contained app!

docs/static.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ When possible, we recommend using glibc-based, mostly static builds.
1919

2020
FrankenPHP also supports [embedding the PHP app in the static binary](embed.md).
2121

22+
> [!NOTE]
23+
>
24+
> Static builds are not available for Windows: on this platform, FrankenPHP links against the official PHP binaries,
25+
> which are included in [the provided archives](https://github.com/php/frankenphp/releases).
26+
> To create a static Linux binary from Windows, use the Docker-based builders or [WSL](https://learn.microsoft.com/windows/wsl/).
27+
2228
## Linux
2329

2430
We provide Docker images to build static Linux binaries:

0 commit comments

Comments
 (0)