roadrunner

module
v2025.1.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 17, 2026 License: MIT

README

All releases

RoadRunner is an open-source (MIT licensed) high-performance PHP application server, process manager written in Go and powered with plugins ❤️. It supports running as a service with the ability to extend its functionality on a per-project basis with plugins.

Features

RoadRunner features a range of plugins, including HTTP(S)/2/3 and fCGI servers that are compatible with PSR-7/PSR-17 standards. This is just one of its many capabilities. It serves as an effective alternative to the traditional Nginx+FPM setup, providing improved performance and more flexibility. Its extensive plugin options go far beyond just HTTP(S)/2/3 and fCGI servers, offering a broad range of functionalities:

  • Queue drivers: RabbitMQ, Kafka, SQS, Beanstalk, NATS, In-Memory.
  • KV drivers: Redis, Memcached, BoltDB, In-Memory.
  • OpenTelemetry protocol support (gRPC, http, jaeger).
  • Workflow engine via Temporal.
  • gRPC server. For increased speed, the protobuf extension can be used.
  • HTTP(S)/2/3 and fCGI servers features automatic TLS management, 103 Early Hints support and middleware like: Static, Headers, gzip, prometheus (metrics), send (x-sendfile), OTEL, proxy_ip_parser, etc.
  • Embedded distribute lock plugin which manages access to shared resources.
  • Metrics server (you might easily expose your own).
  • WebSockets and Broadcast via Centrifugo server.
  • Systemd-like services manager with auto-restarts, execution time limiter, etc.
  • Production-ready.
  • And more 😉

Official Website | Documentation | Forum | Release schedule | Ask RoadRunner Guru

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.

Docker:

To get the roadrunner binary file you can use our docker image: ghcr.io/roadrunner-server/roadrunner:2025.X.X (more information about image and tags can be found here).

FROM ghcr.io/roadrunner-server/roadrunner:2025.X.X AS roadrunner
FROM php:8.3-cli

COPY --from=roadrunner /usr/bin/rr /usr/local/bin/rr

# USE THE RR

Configuration located in the .rr.yaml file (full sample):

Installation via Composer

You can also install RoadRunner automatically using the command shipped with the composer package, run:

composer require spiral/roadrunner-cli
./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)

wget https://github.com/roadrunner-server/roadrunner/releases/download/v2025.X.X/roadrunner-2025.X.X-linux-amd64.deb
sudo dpkg -i roadrunner-2025.X.X-linux-amd64.deb

Download the latest release via curl:

curl --proto '=https' --tlsv1.2 -sSf  https://raw.githubusercontent.com/roadrunner-server/roadrunner/master/download-latest.sh | sh

MacOS using Homebrew:

brew install roadrunner

Windows using Chocolatey:

choco install roadrunner

Configuration can be located in .rr.yaml file (full sample):

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.

Example Worker:

<?php

use Spiral\RoadRunner;
use Nyholm\Psr7;

include "vendor/autoload.php";

$worker = RoadRunner\Worker::create();
$psrFactory = new Psr7\Factory\Psr17Factory();

$worker = new RoadRunner\Http\PSR7Worker($worker, $psrFactory, $psrFactory, $psrFactory);

while ($req = $worker->waitRequest()) {
    try {
        $rsp = new Psr7\Response();
        $rsp->getBody()->write('Hello world!');

        $worker->respond($rsp);
    } catch (\Throwable $e) {
        $worker->getWorker()->error((string)$e);
    }
}

[!IMPORTANT] If you see the EOF error, check that you have installed the PHP packages from this step. If this does not help, try to execute the command php worker.php directly and check the output.


Run:

To run application server:

$ ./rr serve -c .rr.yaml

License:

The MIT License (MIT). Please see LICENSE for more information. Maintained by Spiral Scout.

Contributors

Thanks to all the people who already contributed!

Directories

Path Synopsis
cmd
rr command
Package main is the entry point for the RoadRunner CLI application.
Package main is the entry point for the RoadRunner CLI application.
Package container provides Endure dependency injection container configuration and plugin registration for the RoadRunner application server.
Package container provides Endure dependency injection container configuration and plugin registration for the RoadRunner application server.
internal
cli
Package cli implements the root Cobra command for the RoadRunner CLI, including persistent flags, environment variable loading, debug server initialization, and subcommand registration.
Package cli implements the root Cobra command for the RoadRunner CLI, including persistent flags, environment variable loading, debug server initialization, and subcommand registration.
cli/jobs
Package jobs implements the "jobs" command for managing job pipelines, supporting pause, resume, destroy, and list operations via RPC.
Package jobs implements the "jobs" command for managing job pipelines, supporting pause, resume, destroy, and list operations via RPC.
cli/reset
Package reset implements the "reset" command that resets workers of all or specific RoadRunner plugins concurrently via RPC.
Package reset implements the "reset" command that resets workers of all or specific RoadRunner plugins concurrently via RPC.
cli/serve
Package serve implements the "serve" command that starts the RoadRunner server, manages the Endure container lifecycle, handles OS signals for graceful shutdown and restart, and integrates with systemd via sdnotify.
Package serve implements the "serve" command that starts the RoadRunner server, manages the Endure container lifecycle, handles OS signals for graceful shutdown and restart, and integrates with systemd via sdnotify.
cli/stop
Package stop implements the "stop" command that gracefully stops the RoadRunner server by sending SIGTERM to the process identified by the .pid file.
Package stop implements the "stop" command that gracefully stops the RoadRunner server by sending SIGTERM to the process identified by the .pid file.
cli/workers
Package workers implements the "workers" command that displays information about active RoadRunner workers and job pipelines via RPC, with support for interactive real-time updates.
Package workers implements the "workers" command that displays information about active RoadRunner workers and job pipelines via RPC, with support for interactive real-time updates.
debug
Package debug provides an HTTP server with pprof endpoints for runtime profiling and diagnostics.
Package debug provides an HTTP server with pprof endpoints for runtime profiling and diagnostics.
meta
Package meta holds build-time version and build timestamp metadata set via linker flags during compilation.
Package meta holds build-time version and build timestamp metadata set via linker flags during compilation.
rpc
Package rpc provides an internal RPC client for CLI-to-server communication.
Package rpc provides an internal RPC client for CLI-to-server communication.
sdnotify
Package sdnotify provides a Go implementation of the sd_notify protocol.
Package sdnotify provides a Go implementation of the sd_notify protocol.
Package lib provides a public API for embedding RoadRunner as a library.
Package lib provides a public API for embedding RoadRunner as a library.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL