MCPcopy Index your code
hub / github.com/php/frankenphp

github.com/php/frankenphp @v1.12.4 sqlite

repository ↗ · DeepWiki ↗ · release v1.12.4 ↗
1,057 symbols 3,308 edges 147 files 285 documented · 27%
README

FrankenPHP: Modern App Server for PHP

FrankenPHP

FrankenPHP is a modern application server for PHP built on top of the Caddy web server.

FrankenPHP gives superpowers to your PHP apps thanks to its stunning features: Early Hints, worker mode, real-time capabilities, hot reloading, automatic HTTPS, HTTP/2, and HTTP/3 support...

FrankenPHP works with any PHP app and makes your Laravel and Symfony projects faster than ever thanks to their official integrations with the worker mode.

FrankenPHP can also be used as a standalone Go library to embed PHP in any app using net/http.

Learn more on frankenphp.dev and in this slide deck:

Slides

Getting Started

Install Script

On Linux and macOS, copy this line into your terminal to automatically install an appropriate version for your platform:

curl https://frankenphp.dev/install.sh | sh

On Windows, run this in PowerShell:

irm https://frankenphp.dev/install.ps1 | iex

Standalone Binary

We provide FrankenPHP binaries for Linux, macOS and Windows containing PHP 8.5.

Linux binaries are statically linked, so they can be used on any Linux distribution without installing any dependency. macOS binaries are also self-contained. They contain most popular PHP extensions. Windows archives contain the official PHP binary for Windows.

Download FrankenPHP

rpm Packages

Our maintainers offer rpm packages for all systems using dnf. To install, run:

sudo dnf install https://rpm.henderkes.com/static-php-1-0.noarch.rpm
sudo dnf module enable php-zts:static-8.5 # 8.2-8.5 available
sudo dnf install frankenphp

Installing extensions: sudo dnf install php-zts-<extension>

For extensions not available by default, use PIE:

sudo dnf install pie-zts
sudo pie-zts install asgrim/example-pie-extension

deb Packages

Our maintainers offer deb packages for all systems using apt. To install, run:

VERSION=85 # 82-85 available
sudo curl https://pkg.henderkes.com/api/packages/${VERSION}/debian/repository.key -o /etc/apt/keyrings/static-php${VERSION}.asc
echo "deb [signed-by=/etc/apt/keyrings/static-php${VERSION}.asc] https://pkg.henderkes.com/api/packages/${VERSION}/debian php-zts main" | sudo tee -a /etc/apt/sources.list.d/static-php${VERSION}.list
sudo apt update
sudo apt install frankenphp

Installing extensions: sudo apt install php-zts-<extension>

For extensions not available by default, use PIE:

sudo apt install pie-zts
sudo pie-zts install asgrim/example-pie-extension

apk Packages

Our maintainers offer apk packages for all systems using apk. To install, run:

VERSION=85 # 82-85 available
echo "https://pkg.henderkes.com/api/packages/${VERSION}/alpine/main/php-zts" | sudo tee -a /etc/apk/repositories
KEYFILE=$(curl -sJOw '%{filename_effective}' https://pkg.henderkes.com/api/packages/${VERSION}/alpine/key)
sudo mv ${KEYFILE} /etc/apk/keys/ &&
sudo apk update &&
sudo apk add frankenphp

Installing extensions: sudo apk add php-zts-<extension>

For extensions not available by default, use PIE:

sudo apk add pie-zts
sudo pie-zts install asgrim/example-pie-extension

Homebrew

FrankenPHP is also available as a Homebrew package for macOS and Linux.

brew install dunglas/frankenphp/frankenphp

Installing extensions: Use PIE.

Usage

To serve the content of the current directory, run:

frankenphp php-server

You can also run command-line scripts with:

frankenphp php-cli /path/to/your/script.php

For the deb and rpm packages, you can also start the systemd service:

sudo systemctl start frankenphp

Docker

Alternatively, Docker images are available:

docker run -v .:/app/public \
    -p 80:80 -p 443:443 -p 443:443/udp \
    dunglas/frankenphp

Go to https://localhost, and enjoy!

[!TIP]

Do not attempt to use https://127.0.0.1. Use https://localhost and accept the self-signed certificate. Use the SERVER_NAME environment variable to change the domain to use.

Docs

Examples and Skeletons

Extension points exported contracts — how you extend this code

Workers (Interface)
EXPERIMENTAL: Workers allows you to register a worker. [1 implementers]
workerextension.go
Option (FuncType)
Option instances allow to configure FrankenPHP.
options.go
Metrics (Interface)
(no doc) [2 implementers]
metrics.go
RequestOption (FuncType)
RequestOption instances allow to configure a FrankenPHP Request.
requestoptions.go
Event (Interface)
(no doc)
watcher/watcher-nodejs/lib/watcher.ts
WorkerOption (FuncType)
WorkerOption instances allow configuring FrankenPHP worker.
options.go
CEvent (Interface)
(no doc)
watcher/watcher-nodejs/lib/watcher.ts

Core symbols most depended-on inside this repo

Get
called by 48
internal/state/state.go
Close
called by 36
watcher/watcher-go/watcher.go
Error
called by 33
internal/extgen/errors.go
Set
called by 29
internal/state/state.go
toUnsafeChar
called by 24
cgi.go
WaitFor
called by 22
internal/state/state.go
String
called by 21
internal/state/state.go
Init
called by 20
frankenphp.go

Shape

Function 670
Method 280
Struct 85
Interface 6
TypeAlias 6
Class 5
FuncType 3
Enum 2

Languages

Go97%
Python2%
TypeScript1%

Modules by API surface

frankenphp_test.go114 symbols
metrics.go47 symbols
caddy/caddy_test.go41 symbols
frankenphp.go30 symbols
types.go25 symbols
phpthread.go25 symbols
options.go25 symbols
internal/extgen/gofile_test.go24 symbols
internal/watcher/pattern_test.go20 symbols
watcher/watcher-py/watcher/watcher.py19 symbols
internal/state/state.go17 symbols
internal/extgen/integration_test.go17 symbols

Dependencies from manifests, versioned

cel.dev/exprv0.25.2 · 1×
cloud.google.com/go/auth/oauth2adaptv0.2.8 · 1×
cloud.google.com/go/compute/metadatav0.9.0 · 1×
dario.cat/mergov1.0.2 · 1×
filippo.io/bigmodv0.1.0 · 1×
filippo.io/edwards25519v1.2.0 · 1×
github.com/AndreasBriese/bbloomv0.0.0-2019082515265 · 1×
github.com/DeRuina/timberjackv1.4.5 · 1×
github.com/KimMachineGun/automemlimitv0.7.5 · 1×
github.com/Masterminds/goutilsv1.1.1 · 1×

For agents

$ claude mcp add frankenphp \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact