frankenphp/README.md

# 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*](docs/early-hints.md), [worker mode](docs/worker.md), [real-time capabilities](docs/mercure.md), automatic HTTPS, HTTP/2 and HTTP/3 support...

FrankenPHP works with any PHP app and makes your Symfony projects faster than ever thanks to provided integration with the worker mode (Laravel Octane support coming).

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) 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

☢️ FrankenPHP is very experimental, don't use it in production yet, [file bugs](https://github.com/dunglas/frankenphp/issues) and write patches! ☢️

```
docker run -v $PWD:/app/public \
    -p 80:80 -p 443:443 \
    dunglas/frankenphp
```

Go to `https://localhost`, and enjoy!

## Docs

* [The worker mode](docs/worker.md)
* [Early Hints support (103 HTTP status code)](docs/early-hints.md)
* [Real-time](docs/mercure.md)
* [Configuration](docs/config.md)
* [Demo app (Symfony) and benchmarks](https://github.com/dunglas/frankenphp-demo)
* [Compile from sources](docs/compile.md)
* [Go library documentation](https://pkg.go.dev/github.com/dunglas/frankenphp)
feat: improve Dockerfile and add some docs (#15) 2022-10-13 16:05:22 +00:00			`# FrankenPHP: Modern App Server for PHP`
initial commit 2021-09-24 16:52:20 +00:00
docs: add more docs (#16) 2022-10-14 10:20:57 +00:00			`<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.`

docs: fix mercure link (#17) 2022-10-14 15:54:33 +00:00			`FrankenPHP gives superpowers to your PHP apps thanks to its stunning features: [Early Hints](docs/early-hints.md), [worker mode](docs/worker.md), [real-time capabilities](docs/mercure.md), automatic HTTPS, HTTP/2 and HTTP/3 support...`
docs: add more docs (#16) 2022-10-14 10:20:57 +00:00
			`FrankenPHP works with any PHP app and makes your Symfony projects faster than ever thanks to provided integration with the worker mode (Laravel Octane support coming).`

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

[Docs] Minor typos and tweaks (#23) 2022-10-15 08:50:49 +00:00			`[Learn more on frankenphp.dev](https://frankenphp.dev) in this slide deck:`
docs: add link to presentation 2022-10-14 15:14:17 +00:00
			`<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>`
docs: add more docs (#16) 2022-10-14 10:20:57 +00:00
feat: improve Dockerfile and add some docs (#15) 2022-10-13 16:05:22 +00:00			`## Getting Started`
initial commit 2021-09-24 16:52:20 +00:00
Small typo (#18) Was reading the docs and saw something small. I did try to click the Go library documentation thinking it was the docs on how to use this in a normal Go app, but was surprised it was a link to the Go.dev docs. Any plans, I know it’s early, to document integration with a Go app? 2022-10-14 22:16:50 +00:00			`☢️ FrankenPHP is very experimental, don't use it in production yet, [file bugs](https://github.com/dunglas/frankenphp/issues) and write patches! ☢️`
docs: add more docs (#16) 2022-10-14 10:20:57 +00:00
initial commit 2021-09-24 16:52:20 +00:00			```
feat: improve Dockerfile and add some docs (#15) 2022-10-13 16:05:22 +00:00			`docker run -v $PWD:/app/public \`
			`-p 80:80 -p 443:443 \`
			`dunglas/frankenphp`
feat: use threads instead of GoRoutines (#6) * feat: use threads instead of GoRoutines * many improvements * fix some bugs 2022-10-04 12:36:03 +00:00			```
feat: add a woker mode (#1) * refactor: better memory management * wip * tmp * introduce a go-like api * upgraded to PHP 8.2 * Fix thread safety issues * fix tests * wip * refactor worker * worker prototype * fix populate env * session * improve tests * fix Caddy tests * refactor 2022-05-18 09:52:24 +00:00
docs: add more docs (#16) 2022-10-14 10:20:57 +00:00			Go to `https://localhost`, and enjoy!
initial commit 2021-09-24 16:52:20 +00:00
feat: improve Dockerfile and add some docs (#15) 2022-10-13 16:05:22 +00:00			`## Docs`
initial commit 2021-09-24 16:52:20 +00:00
docs: add more docs (#16) 2022-10-14 10:20:57 +00:00			`* [The worker mode](docs/worker.md)`
feat: improve Dockerfile and add some docs (#15) 2022-10-13 16:05:22 +00:00			`* [Early Hints support (103 HTTP status code)](docs/early-hints.md)`
docs: add more docs (#16) 2022-10-14 10:20:57 +00:00			`* [Real-time](docs/mercure.md)`
			`* [Configuration](docs/config.md)`
			`* [Demo app (Symfony) and benchmarks](https://github.com/dunglas/frankenphp-demo)`
			`* [Compile from sources](docs/compile.md)`
			`* [Go library documentation](https://pkg.go.dev/github.com/dunglas/frankenphp)`