Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dunglas/frankenphp

🧟 The modern PHP app server
https://github.com/dunglas/frankenphp

caddy frankenphp go php sapi worker

Last synced: 5 days ago
JSON representation

🧟 The modern PHP app server

Host: GitHub
URL: https://github.com/dunglas/frankenphp
Owner: dunglas
License: mit
Created: 2022-03-25T09:37:54.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-10-29T08:10:37.000Z (6 days ago)
Last Synced: 2024-10-29T09:26:58.186Z (5 days ago)
Topics: caddy, frankenphp, go, php, sapi, worker
Language: Go
Homepage: https://frankenphp.dev
Size: 3.49 MB
Stars: 6,836
Watchers: 72
Forks: 233
Open Issues: 120
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome - dunglas/frankenphp - 🧟 The modern PHP app server (Go)
go-awesome - FrankenPHP - PHP application server (Open source library / The Internet)
stars - dunglas/frankenphp - The modern PHP app server 🧟 (Go)
awesome-golang-repositories - frankenphp

README

        # FrankenPHP: Modern App Server for PHP



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/), 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:



## Getting Started

### Docker

```console

docker run -v $PWD:/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.

### Standalone Binary

If you prefer not to use Docker, we provide standalone FrankenPHP binaries for Linux and macOS

containing [PHP 8.3](https://www.php.net/releases/8.3/en.php) and most popular PHP extensions.

On Windows, use [WSL](https://learn.microsoft.com/windows/wsl/) to run FrankenPHP.

[Download FrankenPHP](https://github.com/dunglas/frankenphp/releases) or copy this line into your

terminal to automatically install the version appropriate for your platform:

```console

curl https://frankenphp.dev/install.sh | sh

mv frankenphp /usr/local/bin/

```

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

```

## Docs

* [The worker mode](https://frankenphp.dev/docs/worker/)

* [Early Hints support (103 HTTP status code)](https://frankenphp.dev/docs/early-hints/)

* [Real-time](https://frankenphp.dev/docs/mercure/)

* [Configuration](https://frankenphp.dev/docs/config/)

* [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/)

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

* [Go library documentation](https://pkg.go.dev/github.com/dunglas/frankenphp)

* [Contributing and debugging](https://frankenphp.dev/docs/contributing/)

## Examples and Skeletons

* [Symfony](https://github.com/dunglas/symfony-docker)

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