Skip to content

docs: static builds and embedded apps are not available on Windows #2501

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

Draft
m-this wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Draft

docs: static builds and embedded apps are not available on Windows #2501

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
6 changes: 6 additions & 0 deletions docs/embed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,12 @@ EMBED=/path/to/your/app ./build-static.sh

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

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

## Using the binary

This is it! The `my-app` file (or `dist/frankenphp-<os>-<arch>` on other OSes) contains your self-contained app!
Expand Down
6 changes: 6 additions & 0 deletions docs/static.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ When possible, we recommend using glibc-based, mostly static builds.

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

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

## Linux

We provide Docker images to build static Linux binaries:
Expand Down