-
-
Notifications
You must be signed in to change notification settings - Fork 220
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
48 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,35 @@ | ||
# 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.rocks), 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) | ||
|
||
## Getting Started | ||
|
||
☢️ FrankenPHP is very experimental, don't use it in production yet, [fill bugs](https://github.com/dunglas/frankenphp/issues) and write patches! ☢️ | ||
|
||
``` | ||
docker run -v $PWD:/app/public \ | ||
-p 80:80 -p 443:443 \ | ||
dunglas/frankenphp | ||
``` | ||
|
||
Your app is served at https://localhost! | ||
Go to `https://localhost`, and enjoy! | ||
|
||
## Docs | ||
|
||
* [worker mode](docs/worker.md) | ||
* [The worker mode](docs/worker.md) | ||
* [Early Hints support (103 HTTP status code)](docs/early-hints.md) | ||
* [compile from sources](docs/compile.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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Configuration | ||
|
||
FrankenPHP, Caddy as well the Mercure and Vulcain modules can be configured using [the formats supported by Caddy](https://caddyserver.com/docs/getting-started#your-first-config). | ||
|
||
In the Docker image, the `Caddyfile` is located at `/etc/Caddyfile`. | ||
|
||
You can also configure PHP using `php.ini` as usual. | ||
|
||
In the Docker image, the `php.ini` file is located at `/usr/local/lib/php.ini`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Real-time | ||
|
||
FrankenPHP comes with a built-in Mercure hub! | ||
Mercure allows to push event in real-time to all the connected devices: they will receive instantly a JavaScript event. | ||
|
||
No JS library or SDK required! | ||
|
||
![Mercure](https://mercure.rocks/static/main.png) | ||
|
||
To enable the Mercure hub, update the `Caddyfile` as described [on Mercure's website](https://mercure.rocks/docs/hub/config). | ||
|
||
To push Mercure updates from your code, we recommend the [Symfony Mercure Component](https://symfony.com/components/Mercure) (you don't need the Symfony full stack framework to use it). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.