PHPackages                             yiisoft/yii-runner-roadrunner - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. yiisoft/yii-runner-roadrunner

ActiveLibrary[Framework](/categories/framework)

yiisoft/yii-runner-roadrunner
=============================

Web application runner for RoadRunner

3.1.1(6mo ago)3410.4k↓33.3%10[1 PRs](https://github.com/yiisoft/yii-runner-roadrunner/pulls)BSD-3-ClausePHPPHP 8.1 - 8.4CI passing

Since Jan 26Pushed 5mo ago13 watchersCompare

[ Source](https://github.com/yiisoft/yii-runner-roadrunner)[ Packagist](https://packagist.org/packages/yiisoft/yii-runner-roadrunner)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-yii-runner-roadrunner/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (9)Dependencies (29)Versions (12)Used By (0)

 [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft)

Yii RoadRunner Runner
=====================

[](#yii-roadrunner-runner)

[![Latest Stable Version](https://camo.githubusercontent.com/cddcf9a69d779dcf828f4883b4332b6bda0490c89c8a573838b65281fa019bb0/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f7969692d72756e6e65722d726f616472756e6e65722f76)](https://packagist.org/packages/yiisoft/yii-runner-roadrunner)[![Total Downloads](https://camo.githubusercontent.com/46beef01c4b6b3f0074a11acdd27f5c4b3d608a4bc6239bb99e4921fda95afd2/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f7969692d72756e6e65722d726f616472756e6e65722f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/yii-runner-roadrunner)[![Build status](https://github.com/yiisoft/yii-runner-roadrunner/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/yii-runner-roadrunner/actions/workflows/build.yml)[![Code Coverage](https://camo.githubusercontent.com/19e365a3deb78b7ad8033eca985f31d71780b0548a42ce5e15130f1ab9c595fe/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f7969692d72756e6e65722d726f616472756e6e65722f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/yiisoft/yii-runner-roadrunner)[![Mutation testing badge](https://camo.githubusercontent.com/2c1f7d0c7f6e69e00dfde431544c5e4e126c0495a908a1d822bb4032fefb5dc3/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f66742532467969692d72756e6e65722d726f616472756e6e65722532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/yii-runner-roadrunner/master)[![static analysis](https://github.com/yiisoft/yii-runner-roadrunner/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/yii-runner-roadrunner/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/d8562be8b5b333acf79bcece48290971cc8758240a4a6bd509662ae686ef2eaf/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f7969692d72756e6e65722d726f616472756e6e65722f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/yii-runner-roadrunner)

The package contains a bootstrap for running Yii3 applications using [RoadRunner](https://roadrunner.dev/).

Requirements
------------

[](#requirements)

- PHP 8.1 or higher.

Installation
------------

[](#installation)

The package could be installed with [Composer](https://getcomposer.org):

```
composer require yiisoft/yii-runner-roadrunner
```

General usage
-------------

[](#general-usage)

Get RoadRunner:

```
./vendor/bin/rr get
```

Create `worker.php` in your application root directory:

```
use Yiisoft\Yii\Runner\RoadRunner\RoadRunnerHttpApplicationRunner;

ini_set('display_errors', 'stderr');

require_once __DIR__ . '/autoload.php';

(new RoadRunnerHttpApplicationRunner(
    rootPath: __DIR__,
    debug: $_ENV['YII_DEBUG'],
    checkEvents: $_ENV['YII_DEBUG'],
    environment: $_ENV['YII_ENV']
))->run();
```

Specify it in your `.rr.yaml`:

```
version: '3'
server:
    command: "php ./worker.php"

rpc:
    listen: tcp://127.0.0.1:6001

http:
    address: :8082
    pool:
        num_workers: 8
        # Debug mode for the pool. In this mode, pool will not pre-allocate the worker.
        # Worker (only 1, num_workers ignored) will be allocated right after the request arrived.
        debug: false
    middleware: ["static", "headers"]
    static:
        dir:   "./public"
        forbid: [".php", ".htaccess"]
    headers:
        response:
            "Cache-Control": "no-cache"

logs:
    mode: production
    level: warn
```

> **Note**: Official [configuration reference](https://roadrunner.dev/docs/intro-config/). You can also activate `RoadRunner`schema in your IDE to get autocompletion hints.

Run RoadRunner with the config specified:

```
./rr serve
```

### Additional configuration

[](#additional-configuration)

By default, the `RoadRunnerHttpApplicationRunner` is configured to work with Yii application templates and follows the [config groups convention](https://github.com/yiisoft/docs/blob/master/022-config-groups.md).

You can override the default configuration using constructor parameters and immutable setters.

#### Constructor parameters

[](#constructor-parameters)

`$rootPath` — the absolute path to the project root.

`$debug` — whether the debug mode is enabled.

`$checkEvents` — whether check events' configuration.

`$environment` — the environment name.

`$bootstrapGroup` — the bootstrap configuration group name.

`$eventsGroup` — the events' configuration group name.

`$diGroup` — the container definitions' configuration group name.

`$diProvidersGroup` — the container providers' configuration group name.

`$diDelegatesGroup` — the container delegates' configuration group name.

`$diTagsGroup` — the container tags' configuration group name.

`$paramsGroup` — the config parameters group name.

`$nestedParamsGroups` — configuration group names that are included into config parameters group. This is needed for recursive merge parameters.

`$nestedEventsGroups` — configuration group names that are included into events' configuration group. This is needed for reverse and recursive merge events' configurations.

#### Immutable setters

[](#immutable-setters)

If the configuration instance settings differ from the default you can specify a customized configuration instance:

```
/**
 * @var Yiisoft\Config\ConfigInterface $config
 * @var Yiisoft\Yii\Runner\RoadRunner\RoadRunnerHttpApplicationRunner $runner
 */

$runner = $runner->withConfig($config);
```

The default container is `Yiisoft\Di\Container`. But you can specify any implementation of the `Psr\Container\ContainerInterface`:

```
/**
 * @var Psr\Container\ContainerInterface $container
 * @var Yiisoft\Yii\Runner\RoadRunner\RoadRunnerHttpApplicationRunner $runner
 */

$runner = $runner->withContainer($container);
```

In addition to the error handler that is defined in the container, the runner uses a temporary error handler. A temporary error handler is needed to handle the creation of configuration and container instances, then the error handler configured in your application configuration will be used.

By default, the temporary error handler uses HTML renderer and logging to a file. You can override this as follows:

```
/**
 * @var Psr\Log\LoggerInterface $logger
 * @var Yiisoft\ErrorHandler\Renderer\PlainTextRenderer $renderer
 * @var Yiisoft\Yii\Runner\RoadRunner\RoadRunnerHttpApplicationRunner $runner
 */

$runner = $runner->withTemporaryErrorHandler(
    new Yiisoft\ErrorHandler\ErrorHandler($logger, $renderer),
);
```

You can also use your own implementation of the `Spiral\RoadRunner\Http\PSR7WorkerInterface`(default is a `Spiral\RoadRunner\Http\PSR7Worker`):

```
/**
 * @var Spiral\RoadRunner\Http\PSR7WorkerInterface $psr7Worker
 * @var Yiisoft\Yii\Runner\RoadRunner\RoadRunnerHttpApplicationRunner $runner
 */

$runner = $runner->withPsr7Worker($psr7Worker);
```

Temporal
--------

[](#temporal)

Temporal is a distributed, scalable, durable, and highly available orchestration engine used to execute asynchronous long-running business logic in a scalable and resilient way.

Explore more about Temporal on [the official website](https://temporal.io) and in [the SDK repository](https://github.com/temporalio/sdk-php).

> If you want to add support for Temporal you need to install the SDK and configure workflows and activities as described below.

### Installation

[](#installation-1)

```
composer require temporal/sdk
```

### Configuration

[](#configuration)

Temporal has at least two main class types: [Activity](https://docs.temporal.io/activities) and [Workflow](https://docs.temporal.io/workflows). Any activity must have the attribute `\Temporal\Activity\ActivityInterface`:

```
namespace App\Activity;

#[\Temporal\Activity\ActivityInterface]
class MyActivity
{
   // ...
}
```

Any workflow must have the attribute `\Temporal\Workflow\WorkflowInterface`.

```
namespace App\Workflow;

#[\Temporal\Workflow\WorkflowInterface]
class MyWorkflow
{
   // ...
}
```

Configure Temporal engine to make it able to work with your activities and workflows in the `params.php`:

```
// config/common/params.php

return [
    'yiisoft/yii-runner-roadrunner' => [
        'temporal' => [
            'enabled' => true,
            'host' => 'localhost:7233', // host of Temporal engine
            'workflows' => [
                \App\Workflow\MyWorkflow::class,
            ],
            'activities' => [
                \App\Activity\MyActivity::class,
            ],
        ],
    ],
]
```

> If you use another container instead of `yiisoft/di`, make sure that `\Yiisoft\Yii\Runner\RoadRunner\Temporal\TemporalDeclarationProvider`is registered and returns all of your workflows and activities.

The last thing is to call `withTemporalEnabled(true)` on the `\Yiisoft\Yii\Runner\RoadRunner\RoadRunnerHttpApplicationRunner` in the `public/index.php`:

```
(new RoadRunnerHttpApplicationRunner())
    ->withTemporalEnabled(true)
    ->run();
```

Testing
-------

[](#testing)

### Unit testing

[](#unit-testing)

The package is tested with [PHPUnit](https://phpunit.de/). To run tests:

Documentation
-------------

[](#documentation)

- Guide: [English](docs/guide/en/README.md), [Português - Brasil](docs/guide/pt-BR/README.md), [Русский](docs/guide/ru/README.md)
- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

License
-------

[](#license)

The Yii RoadRunner Runner is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

Support the project
-------------------

[](#support-the-project)

[![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft)

Follow updates
--------------

[](#follow-updates)

[![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack)

###  Health Score

55

—

FairBetter than 98% of packages

Maintenance69

Regular maintenance activity

Popularity37

Limited adoption so far

Community29

Small or concentrated contributor base

Maturity73

Established project with proven stability

 Bus Factor3

3 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~152 days

Recently: every ~245 days

Total

10

Last Release

204d ago

Major Versions

1.1.2 → 2.0.02023-02-19

2.0.0 → 3.0.02024-02-22

PHP version history (3 changes)1.0.0PHP ^8.0

3.0.0PHP ^8.1

3.1.0PHP 8.1 - 8.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe)

![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark)

![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire)

![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol)

---

Top Contributors

[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (26 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (26 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (22 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (12 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (10 commits)")[![s1lver](https://avatars.githubusercontent.com/u/4567634?v=4)](https://github.com/s1lver "s1lver (6 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (4 commits)")[![arogachev](https://avatars.githubusercontent.com/u/8326201?v=4)](https://github.com/arogachev "arogachev (3 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (3 commits)")[![roxblnfk](https://avatars.githubusercontent.com/u/4152481?v=4)](https://github.com/roxblnfk "roxblnfk (2 commits)")[![batyrmastyr](https://avatars.githubusercontent.com/u/9303221?v=4)](https://github.com/batyrmastyr "batyrmastyr (1 commits)")[![Perfectio](https://avatars.githubusercontent.com/u/241746583?v=4)](https://github.com/Perfectio "Perfectio (1 commits)")[![lav45](https://avatars.githubusercontent.com/u/675367?v=4)](https://github.com/lav45 "lav45 (1 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (1 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)")[![DikoIbragimov](https://avatars.githubusercontent.com/u/167644693?v=4)](https://github.com/DikoIbragimov "DikoIbragimov (1 commits)")[![razonyang](https://avatars.githubusercontent.com/u/17720932?v=4)](https://github.com/razonyang "razonyang (1 commits)")[![phphleb](https://avatars.githubusercontent.com/u/48386098?v=4)](https://github.com/phphleb "phphleb (1 commits)")

---

Tags

hacktoberfestroadrunneryii3roadrunneryii3

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm, Rector

Type Coverage Yes

### Embed Badge

![Health badge](/badges/yiisoft-yii-runner-roadrunner/health.svg)

```
[![Health](https://phpackages.com/badges/yiisoft-yii-runner-roadrunner/health.svg)](https://phpackages.com/packages/yiisoft-yii-runner-roadrunner)
```

###  Alternatives

[cakephp/cakephp

The CakePHP framework

8.8k18.5M1.6k](/packages/cakephp-cakephp)[yiisoft/app

Yii3 web application template

35512.3k](/packages/yiisoft-app)[yiisoft/app-api

Yii3 API project template

971.5k](/packages/yiisoft-app-api)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[neos/flow

Flow Application Framework

862.0M451](/packages/neos-flow)[drupal/core-recommended

Locked core dependencies; require this project INSTEAD OF drupal/core.

6939.5M343](/packages/drupal-core-recommended)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)