Official Website | Documentation | Forum | Release schedule
# Features: -------- - Production-ready - PCI DSS compliant (HTTP plugin) - PSR-7 HTTP server (file uploads, error handling, static files, hot reload, middleware, event listeners) - HTTPS and HTTP/2 support (including HTTP/2 Push, H2C) - A Fully customizable http(s)/2 server - FastCGI support (HTTP plugin) - Flexible environment configuration - No external PHP dependencies (64bit version required) - Integrated metrics (Prometheus) - [Workflow engine](https://github.com/temporalio/sdk-php) by [Temporal.io](https://temporal.io) - Works over TCP, UNIX sockets and process pipes - Automatic worker replacement, graceful and safe PHP process destruction - Worker create/allocate/destroy timeouts - Max requests per worker limitation - Worker lifecycle management (controller) - max_memory (graceful stop) - ttl (graceful stop) - idle_ttl (graceful stop) - exec_tll (brute, max_execution_time) - Protocol, worker and job level error management (including PHP errors) - Development Mode - Integrations with [Symfony](https://github.com/php-runtime/roadrunner-symfony-nyholm), [Laravel](https://github.com/laravel/octane), Slim, CakePHP, Zend Expressive - Application server for [Spiral](https://github.com/spiral/framework) - Works on Windows 10/11 and WSL2 --- # Installation The easiest way to get the latest RoadRunner version is to use one of the pre-built release binaries, which are available for OSX, Linux, FreeBSD, and Windows. Instructions for using these binaries are on the GitHub [releases page](https://github.com/roadrunner-server/roadrunner/releases). ## Docker: To get the roadrunner binary file you can use our docker image: `ghcr.io/roadrunner-server/roadrunner:2023.X.X` (more information about image and tags can be found [here](https://github.com/roadrunner-server/roadrunner/pkgs/container/roadrunner)). ```dockerfile FROM ghcr.io/roadrunner-server/roadrunner:2023.X.X AS roadrunner FROM php:8.2-cli COPY --from=roadrunner /usr/bin/rr /usr/local/bin/rr # USE THE RR ``` Configuration located in the `.rr.yaml` file ([full sample](https://github.com/roadrunner-server/roadrunner/blob/master/.rr.yaml)): ## Installation via Composer You can also install RoadRunner automatically using command shipped with the composer package, run: ```bash composer require spiral/roadrunner:v2023.1.0 nyholm/psr7 ./vendor/bin/rr get-binary ``` Server binary will be available at the root of your project. > **Note** > > PHP's extensions `php-curl` and `php-zip` are required to download RoadRunner automatically. > PHP's extensions `php-sockets` need to be installed to run roadrunner. > Check with `php --modules` your installed extensions. ## Installation option for the Debian-derivatives (Ubuntu, Mint, MX, etc) ```bash wget https://github.com/roadrunner-server/roadrunner/releases/download/v2023.X.X/roadrunner-2023.X.X-linux-amd64.deb sudo dpkg -i roadrunner-2023.X.X-linux-amd64.deb ``` ## Dowload the latest release via curl: ```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 version: '3' 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 -c .rr.yaml ``` 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!