CONTRIBUTING

Welcome to RoadRunner docs contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on RR :sparkles:.

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Issues

#### Create a new issue

If you spot a problem with the RR, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

#### Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to update the docs if you are solving one.
- Make sure, that all checkboxes in the PR template are solved.
Once you submit your PR, a RR team member will review your proposal. We may ask questions or request for additional information.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations :tada::tada: The RoadRunner team thanks you :sparkles:.

Once your PR is merged, your contributions will be publicly visible on the RR page.

Now that you are part of the RoadRunner server community, see how else you can contribute to the RR.

---

README

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 😉

Join our discord server: Link

<a href="https://roadrunner.dev/">Official Website</a> |
<a href="https://docs.roadrunner.dev/">Documentation</a> |
<a href="https://github.com/orgs/roadrunner-server/discussions">Forum</a> |
<a href="https://github.com/orgs/roadrunner-server/projects/4">Release schedule</a> |
<a href="https://gurubase.io/g/roadrunner">Ask RoadRunner Guru</a>

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).

dockerfile

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:

bash

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)

bash

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:

bash

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

MacOS using Homebrew:

bash

brew install roadrunner

Windows using Chocolatey:

bash

choco install roadrunner

---

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

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.

Example Worker:
--------

php

<?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.

---

Available Plugins: link

Run:
----
To run application server:

text

$ ./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!

---

SECURITY

Security Policy

Supported Versions

| Version | Supported |
|----------|-----------|
| 2.x | No |
| 2023.x.x | No |
| 2024.x.x | Yes |
| 2025.x.x | Yes |

---

CONTRIBUTING Copy Section

Welcome to RoadRunner docs contributing guide

Issues Copy Section

Pull Request Copy Section

Your PR is merged! Copy Section

README Copy Section

Features

Join our discord server: Link

Installation

Docker: Copy Chapter

USE THE RR

Installation via Composer Copy Chapter

Installation option for the Debian-derivatives (Ubuntu, Mint, MX, etc) Copy Chapter

Download the latest release via curl: Copy Chapter

MacOS using Homebrew: Homebrew:')" title="Copy chapter prompt for LLMs"> Copy Chapter

Windows using Chocolatey: Chocolatey:')" title="Copy chapter prompt for LLMs"> Copy Chapter

Available Plugins: link link')" title="Copy section prompt for LLMs"> Copy Section

Contributors Copy Chapter

SECURITY Copy Section

Security Policy

Supported Versions Copy Chapter

Explore Related Technologies & Topics

CONTRIBUTING

Issues

Pull Request

Your PR is merged!

README

Docker:

Installation via Composer

Installation option for the Debian-derivatives (Ubuntu, Mint, MX, etc)

Download the latest release via curl:

MacOS using Homebrew:

Windows using Chocolatey:

Available Plugins: link

Contributors

SECURITY

Supported Versions