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. Он добавляет такие возможности, как режим воркеров, работу в реальном времени, горячую перезагрузку и автоматический HTTPS.
Это просто веб-сервер или его можно встроить в моё приложение?Работает в обоих вариантах: как самостоятельный сервер или исполняемый файл командной строки для любого приложения на PHP, а также как библиотека на языке Go, которую можно встроить в свою программу на Go с помощью net/http.
Как это запустить?Запустите скрипт установки одной строкой в Linux/macOS или команду PowerShell в Windows либо скачайте самостоятельный бинарный файл. После установки запустите его в каталоге, чтобы отдавать содержимое этого каталога, или используйте готовые образы 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