Official Website | Documentation | Release schedule
Features: -------- - Production-ready - PCI DSS compliant - PSR-7 HTTP server (file uploads, error handling, static files, hot reload, middlewares, event listeners) - HTTPS and HTTP/2 support (including HTTP/2 Push, H2C) - A Fully customizable server, FastCGI support - Flexible environment configuration - No external PHP dependencies (64bit version required), drop-in (based on [Goridge](https://github.com/roadrunner-server/goridge)) - Process manager and task pipeline - Integrated metrics (Prometheus) - [Workflow engine](https://github.com/temporalio/sdk-php) by [Temporal.io](https://temporal.io) - Works over TCP, UNIX sockets and standard pipes - Automatic worker replacement and safe PHP process destruction - Worker create/allocate/destroy timeouts - Max jobs per worker - Worker lifecycle management (controller) - maxMemory (graceful stop) - TTL (graceful stop) - idleTTL (graceful stop) - execTTL (brute, max_execution_time) - Payload context and body - Protocol, worker and job level error management (including PHP errors) - Development Mode - Integrations with Symfony, [Laravel](https://github.com/spiral/roadrunner-laravel), Slim, CakePHP, Zend Expressive - Application server for [Spiral](https://github.com/spiral/framework) - Included in Laravel Octane - Automatic reloading on file changes - Works on Windows (Unix sockets (AF_UNIX) supported on Windows 10) Installation: -------- To get the roadrunner binary file you can use our docker image: `spiralscout/roadrunner:2.X.X` (more information about image and tags can be found [here](https://hub.docker.com/r/spiralscout/roadrunner/)) or use the GitHub package: `ghcr.io/roadrunner-server/roadrunner:2.X.X` - Docker: ```dockerfile FROM ghcr.io/roadrunner-server/roadrunner:2.X.X AS roadrunner FROM php:8.2-cli COPY --from=roadrunner /usr/bin/rr /usr/local/bin/rr # USE THE RR ``` - Composer ```bash $ composer require spiral/roadrunner:v2.0 nyholm/psr7 $ ./vendor/bin/rr get-binary ``` - Ubuntu (Debian-derivatives): ```bash $ wget https://github.com/roadrunner-server/roadrunner/releases/download/v2.X.X/roadrunner-2.X.X-linux-amd64.deb $ sudo dpkg -i roadrunner-2.X.X-linux-amd64.deb ``` - Download the latest release (WSL2/Linux/macOS): ```bash curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/roadrunner-server/roadrunner/master/download-latest.sh | sh ``` Configuration can be located in `.rr.yaml` file ([full sample](https://github.com/roadrunner-server/roadrunner/blob/master/.rr.yaml)): ```yaml # configuration version: https://roadrunner.dev/docs/beep-beep-config/2.x/en version: '2.7' rpc: listen: tcp://127.0.0.1:6001 server: command: "php worker.php" http: address: "0.0.0.0:8080" logs: level: error ``` > Read more in [Documentation](https://roadrunner.dev/docs). Example Worker: -------- ```php waitRequest()) { try { $rsp = new Psr7\Response(); $rsp->getBody()->write('Hello world!'); $worker->respond($rsp); } catch (\Throwable $e) { $worker->getWorker()->error((string)$e); } } ``` ### Available Plugins: [link](https://roadrunner.dev/docs) Run: ---- To run application server: ``` $ ./rr serve ``` License: -------- The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information. Maintained by [Spiral Scout](https://spiralscout.com). ## Contributors Thanks to all the people who already contributed!