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
这是什么？FrankenPHP 是一款现代化的 PHP 应用服务器，基于 Caddy Web 服务器构建，并提供工作模式、实时通信能力、热重载和自动 HTTPS 等功能。
它只是一个 Web 服务器，还是我可以把它嵌入到自己的应用里？两种用法都支持：既可以作为独立的服务器或命令行可执行文件，用于任何 PHP 应用；也可以作为 Go 库，通过 net/http 嵌入到你自己的 Go 程序中。
我该怎么让它运行起来？在 Linux/macOS 上运行一行安装脚本，或在 Windows 上运行 PowerShell 命令；也可以直接下载独立的可执行文件。安装完成后，在某个目录中运行它即可提供该目录的内容；也可以使用提供的 Docker 镜像。
我需要先单独安装 PHP 吗？不需要。Linux、macOS 和 Windows 版的可执行文件都内置了 PHP 8.5 以及大多数常用扩展，因此在 Linux 上无需额外安装任何东西。
安装时有哪些需要注意的坑吗？默认未打包的扩展需要通过 PIE 单独安装；在部署到生产环境之前，值得先查看文档中的“Known issues”（已知问题）一节。
它能直接用于 Laravel 或 Symfony 吗？可以。FrankenPHP 为 Laravel 和 Symfony 提供了官方的工作模式集成，可加快它们的请求处理速度；此外还提供了 WordPress、Drupal、Joomla、TYPO3、Magento2 等项目的骨架，以及更多选择。
什么是工作模式？工作模式会让 PHP 应用在请求之间一直保持在内存中启动的状态，而不是每次都重新启动，从而显著提升 Laravel、Symfony 等框架的性能。
它支持 HTTP/3 和自动 HTTPS 吗？支持。由于它基于 Caddy 构建，FrankenPHP 可免费获得自动 HTTPS、HTTP/2、HTTP/3 以及 Early Hints（103 状态码）功能。
我能把自己的 PHP 应用打包成单个二进制文件吗？可以。文档介绍了如何创建独立的、可自执行的 PHP 应用，以及如何编译静态二进制文件，这样你就能只交付一个文件，而不必交付一整套部署内容。
我该如何从 Nginx/PHP-FPM 迁移？文档中有一份专门的迁移指南，会一步步说明如何将现有的 Nginx/PHP-FPM 配置迁移到 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