Explore
Topics
Collections
Documents
FAQ
GitHub
Explore repos
Explore
Topics
Collections
Documents
FAQ
GitHub
Explore repos
Explore
/
Go
/
frankenphp
php
php/frankenphp
馃 The modern PHP app server
View on GitHub
Website / Demo
Copy link
Back to listing
11.5k
stars
508
forks
100+
contributors
Go
README.md
View on GitHub
# FrankenPHP: modern app server for PHP <h1 align="center"><a href="https://frankenphp.dev"><img src="frankenphp.png" alt="FrankenPHP" width="600"></a></h1> FrankenPHP is a modern application server for PHP built on top of the [Caddy](https://caddyserver.com/) web server. FrankenPHP gives superpowers to your PHP apps thanks to its stunning features: [_Early Hints_](https://frankenphp.dev/docs/early-hints/), [worker mode](https://frankenphp.dev/docs/worker/), [real-time capabilities](https://frankenphp.dev/docs/mercure/), [hot reloading](https://frankenphp.dev/docs/hot-reload/), 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_](https://frankenphp.dev) and in this slide deck: <a href="https://dunglas.dev/2022/10/frankenphp-the-modern-php-app-server-written-in-go/"><img src="https://dunglas.dev/wp-content/uploads/2022/10/frankenphp.png" alt="Slides" width="600"></a> ## Getting started ### Install script On Linux and macOS, copy this line into your terminal to automatically install an appropriate version for your platform: ```console curl https://frankenphp.dev/install.sh | sh ``` On Windows, run this in PowerShell: ```powershell irm https://frankenphp.dev/install.ps1 | iex ``` ### Standalone binary We provide FrankenPHP binaries for Linux, macOS (Apple Silicon) and Windows containing [PHP 8.5](https://www.php.net/releases/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](https://github.com/php/frankenphp/releases) ### rpm packages Our maintainers offer rpm packages for all systems using `dnf`. To install, run: ```console 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](https://github.com/php/pie): ```console 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: ```console 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](https://github.com/php/pie): ```console 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: ```console 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](https://github.com/php/pie): ```console sudo apk add pie-zts sudo pie-zts install asgrim/example-pie-extension ``` ### Homebrew FrankenPHP is also available as a [Homebrew](https://brew.sh) package for macOS and Linux. ```console brew install dunglas/frankenphp/frankenphp ``` **Installing extensions:** Use [PIE](https://github.com/php/pie). ### Usage To serve the content of the current directory, run: ```console frankenphp php-server ``` You can also run command-line scripts with: ```console frankenphp php-cli /path/to/your/script.php ``` For the deb and rpm packages, you can also start the systemd service: ```console sudo systemctl start frankenphp ``` ### Docker Alternatively, [Docker images](https://frankenphp.dev/docs/docker/) are available: ```console 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](docs/config.md#environment-variables) to change the domain to use. ## Docs - [Classic mode](https://frankenphp.dev/docs/classic/) - [Worker mode](https://frankenphp.dev/docs/worker/) - [Migrating from Nginx/PHP-FPM](https://frankenphp.dev/docs/migrate/) - [Early Hints support (103 HTTP status code)](https://frankenphp.dev/docs/early-hints/) - [Real-time](https://frankenphp.dev/docs/mercure/) - [Logging](https://frankenphp.dev/docs/logging/) - [Hot reloading](https://frankenphp.dev/docs/hot-reload/) - [Efficiently serving large static files](https://frankenphp.dev/docs/x-sendfile/) - [Configuration](https://frankenphp.dev/docs/config/) - [Writing PHP extensions in Go](https://frankenphp.dev/docs/extensions/) - [Docker images](https://frankenphp.dev/docs/docker/) - [Deploy in production](https://frankenphp.dev/docs/production/) - [Performance optimization](https://frankenphp.dev/docs/performance/) - [Create **standalone**, self-executable PHP apps](https://frankenphp.dev/docs/embed/) - [Create static binaries](https://frankenphp.dev/docs/static/) - [Compile from sources](https://frankenphp.dev/docs/compile/) - [Observability](https://frankenphp.dev/docs/observability/) - [WordPress integration](https://frankenphp.dev/docs/wordpress/) - [Symfony integration](https://frankenphp.dev/docs/symfony/) - [Laravel integration](https://frankenphp.dev/docs/laravel/) - [Known issues](https://frankenphp.dev/docs/known-issues/) - [Demo app (Symfony) and benchmarks](https://github.com/dunglas/frankenphp-demo) - [Use as a Go library](https://frankenphp.dev/docs/library/) - [Go library documentation](https://pkg.go.dev/github.com/dunglas/frankenphp) - [Contributing and debugging](https://frankenphp.dev/docs/contributing/) - [Internals (architecture overview)](docs/internals.md) ## Examples and skeletons - [Symfony](https://frankenphp.dev/docs/symfony/) - [API Platform](https://api-platform.com/docs/symfony) - [Laravel](https://frankenphp.dev/docs/laravel/) - [Sulu](https://sulu.io/blog/running-sulu-with-frankenphp) - [WordPress](https://github.com/StephenMiracle/frankenwp) - [Drupal](https://github.com/dunglas/frankenphp-drupal) - [Joomla](https://github.com/alexandreelise/frankenphp-joomla) - [TYPO3](https://github.com/ochorocho/franken-typo3) - [Magento2](https://github.com/ekino/frankenphp-magento2) - [WoltLab Suite](https://github.com/SoftCreatRMedia/frankenphp-woltlab-suite)
Live Chat
