frankenphp README

The project's README from github.com/php/frankenphp. As one markdown file: README.md.

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

frankenphp (php/frankenphp)

Searching Database…

11.4K ·GitHub
Frankenphp
What is this?FrankenPHP is a modern application server for PHP built on top of the Caddy web server, adding features like worker mode, real-time capabilities, hot reloading, and automatic HTTPS.
Is it just a web server, or can I embed it in my own app?It works both ways: as a standalone server/CLI binary for any PHP app, and as a Go library you can embed in your own Go program using net/http.
How do I get it running?Run the one-line install script on Linux/macOS or the PowerShell command on Windows, or download a standalone binary; once installed, run it in a directory to serve its content, or use the provided Docker images.
Do I need PHP installed separately first?No, the Linux, macOS and Windows binaries bundle PHP 8.5 and most popular extensions, so there's nothing extra to install on Linux.
Any install pitfalls I should know about?Extensions not packaged by default need to be installed separately via PIE, and there's a 'Known issues' doc worth checking before deploying to production.
Does it work with Laravel or Symfony out of the box?Yes, FrankenPHP has official worker-mode integrations for both Laravel and Symfony that speed up their request handling, plus skeletons for WordPress, Drupal, Joomla, TYPO3, Magento2 and more.
What is worker mode?Worker mode keeps a PHP app booted in memory between requests instead of restarting it each time, dramatically improving performance for frameworks like Laravel and Symfony.
Does it support HTTP/3 and auto HTTPS?Yes, since it's built on Caddy, FrankenPHP gets automatic HTTPS, HTTP/2, HTTP/3, and Early Hints (103 status code) for free.
Can I package my PHP app as a single binary?Yes, the docs cover creating standalone, self-executable PHP apps and compiling static binaries so you can ship a single file instead of a full deployment.
How do I migrate from Nginx/PHP-FPM?There is a dedicated migration guide in the docs that walks through moving an existing Nginx/PHP-FPM setup to FrankenPHP.
What are similar projects?caddy, webserver, nginx, nginx-proxy, azerioid-stack-manager, h2o, caprover, http-server
Which topics is it in?caddy, https, web-server, laravel, php, devops, performance, go, server, docker, self-hosted, cli
Creator
php
Size
18.6 MB
Stars
11.4K
Updated
CommitOct 16Releasev1.13.1Oct 16
Age
4y
Commits · 90 Days