1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
<p align="center">
<img src="https://user-images.githubusercontent.com/796136/50286124-6f7f3780-046f-11e9-9f45-e8fedd4f786d.png" height="75px" alt="RoadRunner">
</p>
<p align="center">
<a href="https://packagist.org/packages/spiral/roadrunner"><img src="https://poser.pugx.org/spiral/roadrunner/version"></a>
<a href="https://godoc.org/github.com/spiral/roadrunner"><img src="https://godoc.org/github.com/spiral/roadrunner?status.svg"></a>
<a href="https://travis-ci.org/spiral/roadrunner"><img src="https://travis-ci.org/spiral/roadrunner.svg?branch=master"></a>
<a href="https://goreportcard.com/report/github.com/spiral/roadrunner"><img src="https://goreportcard.com/badge/github.com/spiral/roadrunner"></a>
<a href="https://scrutinizer-ci.com/g/spiral/roadrunner/?branch=master"><img src="https://scrutinizer-ci.com/g/spiral/roadrunner/badges/quality-score.png"></a>
<a href="https://codecov.io/gh/spiral/roadrunner/"><img src="https://codecov.io/gh/spiral/roadrunner/branch/master/graph/badge.svg"></a>
<a href="https://discord.gg/TFeEmCs"><img src="https://img.shields.io/badge/discord-chat-blue.svg"></a>
</p>
RoadRunner is an open source (MIT licensed) high-performance PHP application server, load balancer and process manager.
It supports running as a service with the ability to extend its functionality on a per-project basis.
RoadRunner includes PSR-7/PSR-17 compatible HTTP and HTTP/2 server and can be used to replace classic Nginx+FPM setup with much greater performance and flexibility.
Table of Contents
-----------------
* Introduction
* [About RoadRunner](https://github.com/spiral/roadrunner/wiki/About-RoadRunner)
* [Installation](https://github.com/spiral/roadrunner/wiki/Installation)
* [Quick Builds](https://github.com/spiral/roadrunner/wiki/Quick-Builds)
* [Configuration](https://github.com/spiral/roadrunner/wiki/Configuration)
* [License](https://github.com/spiral/roadrunner/wiki/License)
* Using RoadRunner
* [Environment Configuration](https://github.com/spiral/roadrunner/wiki/Enviroment-Configuration)
* [HTTPS and HTTP/2](https://github.com/spiral/roadrunner/wiki/HTTPS-and-HTTP2)
* [**PHP Workers**](https://github.com/spiral/roadrunner/wiki/PHP-Workers)
* [Debugging](https://github.com/spiral/roadrunner/wiki/Debugging)
* [Server Commands](https://github.com/spiral/roadrunner/wiki/Server-Commands)
* [RPC Integration](https://github.com/spiral/roadrunner/wiki/RPC-Integration)
* [Restarting Workers](https://github.com/spiral/roadrunner/wiki/Restarting-Workers)
* [IDE integration](https://github.com/spiral/roadrunner/wiki/IDE-Integration)
* [Error Handling](https://github.com/spiral/roadrunner/wiki/Debug-And-Error-Handling)
* [Production Usage](https://github.com/spiral/roadrunner/wiki/Production-Usage)
* Integrations
* [Laravel Framework](https://github.com/spiral/roadrunner/wiki/Laravel-Framework) (pending verification)
* [Slim Framework](https://github.com/spiral/roadrunner/issues/62) (pending verification)
* [Symfony Framework](https://github.com/spiral/roadrunner/wiki/Symfony-Framework) (native sessions support [is not stable](https://github.com/spiral/roadrunner/issues/18))
* [Yii2/3 Framework](https://github.com/spiral/roadrunner/issues/78) (in progress)
- [Other Examples](https://github.com/spiral/roadrunner/wiki/Other-Examples)
* Server Customization
* [Building Server](https://github.com/spiral/roadrunner/wiki/Building-Server)
* [Writing Services](https://github.com/spiral/roadrunner/wiki/Writing-Services)
* [HTTP Middlewares](https://github.com/spiral/roadrunner/wiki/Middlewares)
* Additional Notes
* [Event Listeners](https://github.com/spiral/roadrunner/wiki/Event-Listeners)
* [Standalone Usage](https://github.com/spiral/roadrunner/wiki/Standalone-usage)
* [AWS Lambda](https://github.com/spiral/roadrunner/wiki/AWS-Lambda)
* Custom Builds
* [GRPC Server](https://github.com/spiral/php-grpc)
Features:
--------
- production ready
- PSR-7 HTTP server (file uploads, error handling, static files, hot reload, middlewares, event listeners)
- HTTPS and HTTP/2 support (including HTTP/2 Push)
- fully customizable server
- flexible environment configuration
- no external PHP dependencies, drop-in (based on [Goridge](https://github.com/spiral/goridge))
- load balancer, process manager and task pipeline
- frontend agnostic ([Queue](https://github.com/spiral/jobs), PSR-7, [GRPC](https://github.com/spiral/php-grpc), etc)
- works over TCP, unix sockets and standard pipes
- automatic worker replacement and safe PHP process destruction
- worker lifecycle management (create/allocate/destroy timeouts)
- payload context and body
- control over max jobs per worker
- protocol, worker and job level error management (including PHP errors)
- memory leak failswitch
- very fast (~250k rpc calls per second on Ryzen 1700X using 16 threads)
- works on Windows
Example:
--------
```php
<?php
ini_set('display_errors', 'stderr');
include "vendor/autoload.php";
$relay = new Spiral\Goridge\StreamRelay(STDIN, STDOUT);
$psr7 = new Spiral\RoadRunner\PSR7Client(new Spiral\RoadRunner\Worker($relay));
while ($req = $psr7->acceptRequest()) {
try {
$resp = new \Zend\Diactoros\Response();
$resp->getBody()->write("hello world");
$psr7->respond($resp);
} catch (\Throwable $e) {
$psr7->getWorker()->error((string)$e);
}
}
```
Configuration can be located in `.rr.yaml` file:
```yaml
http:
address: 0.0.0.0:8080
workers:
command: "php psr-worker.php"
pool:
numWorkers: 4
```
> Read more in [Wiki](https://github.com/spiral/roadrunner/wiki/PHP-Workers).
License:
--------
The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information. Maintained by [SpiralScout](https://spiralscout.com).
|
