Skip to content

fix!: generate a configuration that RoadRunner 3 accepts #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
roxblnfk merged 1 commit into from
Oct 12, 2026
Merged

fix!: generate a configuration that RoadRunner 3 accepts #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,9 @@ See the [RoadRunner documentation](https://docs.roadrunner.dev) for the configur
`plugin` and `preset` options, a configuration with the default plugins (`rpc`, `server`, `http`, `jobs`, `kv`, `metrics`) is created.
Using the `plugin` option (shortcut `p`) can create an example configuration file with only plugins needed.
For example, with http plugin only: `get-binary -p http`, http and jobs: `get-binary -p http -p jobs`.
Available plugins: `amqp`, `beanstalk`, `boltdb`, `broadcast`, `endure`, `fileserver`, `grpc`, `http`, `jobs`, `kv`,
`logs`, `metrics`, `nats`, `otel`, `redis`, `reload`, `rpc`, `server`, `service`, `sqs`, `status`, `tcp`, `temporal`, `websockets`.
Available plugins: `amqp`, `beanstalk`, `boltdb`, `centrifuge`, `endure`, `fileserver`, `google_pub_sub`, `grpc`,
`http`, `jobs`, `kafka`, `kv`, `logs`, `metrics`, `nats`, `nsq`, `otel`, `protoreg`, `redis`, `rpc`, `server`,
`service`, `sqs`, `status`, `temporal`.
Using the `preset` option can create an example configuration file with popular plugins for different typical tasks.
For example, with web preset: `get-binary --preset web`.
Available presets: `web` (contains plugins `http`, `jobs`).
Expand Down
2 changes: 1 addition & 1 deletion src/Internal/Configuration/Generator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public function generate(Plugins $plugins): string
{
$this->collectSections($plugins->getPlugins());

return Yaml::dump($this->getContent(), 10);
return Yaml::dump($this->getContent(), 10, 4, Yaml::DUMP_OBJECT_AS_MAP);
}

private function getContent(): array
Expand Down
18 changes: 10 additions & 8 deletions src/Internal/Configuration/Plugins.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,30 @@
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Amqp;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Beanstalk;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Boltdb;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Broadcast;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Centrifuge;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Endure;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Fileserver;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\GooglePubSub;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Grpc;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Http;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Jobs;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Kafka;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Kv;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Logs;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Metrics;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Nats;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Nsq;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Otel;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Protoreg;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Redis;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Reload;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Rpc;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\SectionInterface;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Server;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Service;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Sqs;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Status;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Tcp;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Temporal;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Version;
use Spiral\RoadRunner\Console\Internal\Configuration\Section\Websockets;

/**
* @internal
Expand All @@ -45,28 +46,29 @@ final class Plugins
Amqp::class,
Beanstalk::class,
Boltdb::class,
Broadcast::class,
Centrifuge::class,
Endure::class,
Fileserver::class,
GooglePubSub::class,
Grpc::class,
Http::class,
Jobs::class,
Kafka::class,
Kv::class,
Logs::class,
Metrics::class,
Nats::class,
Nsq::class,
Otel::class,
Protoreg::class,
Redis::class,
Reload::class,
Rpc::class,
Server::class,
Service::class,
Sqs::class,
Status::class,
Tcp::class,
Temporal::class,
Version::class,
Websockets::class,
];

/**
Expand Down
8 changes: 8 additions & 0 deletions src/Internal/Configuration/Section/Amqp.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,12 @@ public function render(): array
],
];
}

#[\Override]
public function getRequired(): array
{
return [
Jobs::class,
];
}
}
9 changes: 8 additions & 1 deletion src/Internal/Configuration/Section/Beanstalk.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,15 @@ public function render(): array
return [
self::NAME => [
'addr' => 'tcp://127.0.0.1:11300',
'timeout' => '10s',
],
];
}

#[\Override]
public function getRequired(): array
{
return [
Jobs::class,
];
}
}
2 changes: 1 addition & 1 deletion src/Internal/Configuration/Section/Boltdb.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function render(): array
{
return [
self::NAME => [
'permissions' => 0777,
'file' => 'rr.db',
],
];
}
Expand Down
60 changes: 0 additions & 60 deletions src/Internal/Configuration/Section/Broadcast.php
View file
Open in desktop

This file was deleted.

38 changes: 38 additions & 0 deletions src/Internal/Configuration/Section/Centrifuge.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php

declare(strict_types=1);

namespace Spiral\RoadRunner\Console\Internal\Configuration\Section;

/**
* @internal
*/
final class Centrifuge extends AbstractSection
{
private const NAME = 'centrifuge';

#[\Override]
public static function getShortName(): string
{
return self::NAME;
}

#[\Override]
public function render(): array
{
return [
self::NAME => [
'proxy_address' => 'tcp://127.0.0.1:30000',
'grpc_api_address' => '127.0.0.1:10000',
],
];
}

#[\Override]
public function getRequired(): array
{
return [
Server::class,
];
}
}
26 changes: 6 additions & 20 deletions src/Internal/Configuration/Section/Fileserver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,12 @@ public function render(): array
self::NAME => [
'address' => '127.0.0.1:10101',
'calculate_etag' => true,
'weak' => false,
'stream_request_body' => true,
// 'serve' => [
// [
// 'prefix' => '/foo',
// 'root' => '../../../tests',
// 'compress' => false,
// 'cache_duration' => 10,
// 'max_age' => 10,
// 'bytes_range' => true
// ],
// [
// 'prefix' => '/foo/bar',
// 'root' => '../../../tests',
// 'compress' => false,
// 'cache_duration' => 10,
// 'max_age' => 10,
// 'bytes_range' => true
// ]
// ]
'serve' => [
[
'prefix' => '/',
'root' => 'public',
],
],
],
];
}
Expand Down
38 changes: 38 additions & 0 deletions src/Internal/Configuration/Section/GooglePubSub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php

declare(strict_types=1);

namespace Spiral\RoadRunner\Console\Internal\Configuration\Section;

/**
* @internal
*/
final class GooglePubSub extends AbstractSection
{
private const NAME = 'google_pub_sub';

#[\Override]
public static function getShortName(): string
{
return self::NAME;
}

#[\Override]
public function render(): array
{
return [
self::NAME => [
'insecure' => true,
'endpoint' => '127.0.0.1:8085',
],
];
}

#[\Override]
public function getRequired(): array
{
return [
Jobs::class,
];
}
}
23 changes: 1 addition & 22 deletions src/Internal/Configuration/Section/Grpc.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,29 +24,8 @@ public function render(): array
self::NAME => [
'listen' => 'tcp://127.0.0.1:9001',
'proto' => [
'first.proto',
'second.proto',
'proto/helloworld.proto',
],
// 'tls' => [
// 'key' => '',
// 'cert' => '',
// 'root_ca' => '',
// 'client_auth_type' => 'no_client_certs'
// ],
// 'max_send_msg_size' => 50,
// 'max_recv_msg_size' => 50,
// 'max_connection_idle' => '0s',
// 'max_connection_age' => '0s',
// 'max_connection_age_grace' => '0s8h',
// 'max_concurrent_streams' => 10,
// 'ping_time' => '1s',
// 'timeout' => '200s',
// 'pool' => [
// 'num_workers' => 2,
// 'max_jobs' => 0,
// 'allocate_timeout' => '60s',
// 'destroy_timeout' => 60
// ]
],
];
}
Expand Down
15 changes: 13 additions & 2 deletions src/Internal/Configuration/Section/Jobs.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,20 @@ public function render(): array
self::NAME => [
'pool' => [
'num_workers' => 2,
'max_worker_memory' => 100,
'supervisor' => [
'max_worker_memory' => 100,
],
],
'consume' => ['local'],
'pipelines' => [
'local' => [
'driver' => 'memory',
'config' => [
'priority' => 10,
'prefetch' => 10,
],
],
],
'consume' => [],
],
];
}
Expand Down
39 changes: 39 additions & 0 deletions src/Internal/Configuration/Section/Kafka.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<?php

declare(strict_types=1);

namespace Spiral\RoadRunner\Console\Internal\Configuration\Section;

/**
* @internal
*/
final class Kafka extends AbstractSection
{
private const NAME = 'kafka';

#[\Override]
public static function getShortName(): string
{
return self::NAME;
}

#[\Override]
public function render(): array
{
return [
self::NAME => [
'brokers' => [
'127.0.0.1:9092',
],
],
];
}

#[\Override]
public function getRequired(): array
{
return [
Jobs::class,
];
}
}
Loading
Loading