You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-9Lines changed: 29 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -106,10 +106,14 @@ server:
106
106
command: 'php vendor/bin/rr-worker start'
107
107
```
108
108
109
-
When RoadRunner creates a worker pool for a specific plugin, it sets the `RR_MODE` environment variable to indicate which plugin is being used.
110
-
The Laravel Bridge checks this variable to determine which Worker class should handle the request based on your configuration.
109
+
When RoadRunner creates a worker pool for a specific plugin,
110
+
it sets the `RR_MODE` environment variable to indicate which plugin is being used.
111
+
The Laravel Bridge checks this variable to determine
112
+
which Worker class should handle the request based on your configuration.
111
113
112
-
The selected worker then listens for requests from the RoadRunner server and handles them using the Octane worker, which clears the application state after each task (request, command, etc.).
114
+
The selected worker then listens for requests from the RoadRunner server
115
+
and handles them using the [Octane][octane] worker,
116
+
which clears the application state after each task (request, command, etc.).
113
117
114
118
## Supported Plugins
115
119
@@ -132,11 +136,13 @@ http:
132
136
forbid: [ ".php" ]
133
137
```
134
138
135
-
> **Note:** Read more about the HTTP plugin in the [RoadRunner documentation](https://docs.roadrunner.dev/docs/http/http).
139
+
> [!TIP]
140
+
> Read more about the HTTP plugin in the [RoadRunner documentation][roadrunner-docs-http].
136
141
137
142
### Jobs (Queue) Plugin
138
143
139
-
The Queue plugin allows you to use RoadRunner as a queue driver for Laravel without additional services like Redis or a database.
144
+
The Queue plugin allows you to use RoadRunner as a queue driver for Laravel
145
+
without additional services like Redis or a database.
140
146
141
147
#### Configuration
142
148
@@ -184,7 +190,7 @@ QUEUE_CONNECTION=roadrunner
184
190
That's it! You can now dispatch jobs to the RoadRunner queue without any additional services like Redis or Database.
185
191
186
192
> [!TIP]
187
-
> Read more about the Jobs plugin in the [RoadRunner documentation](https://docs.roadrunner.dev/docs/queues-and-jobs/overview-queues).
193
+
> Read more about the Jobs plugin in the [RoadRunner documentation][roadrunner-docs-jobs].
188
194
189
195
### gRPC Plugin
190
196
@@ -273,7 +279,8 @@ This section explains how to create and register custom workers in your applicat
273
279
274
280
### Understanding Workers
275
281
276
-
Workers are responsible for handling requests from the RoadRunner server and processing them in your Laravel application.
282
+
Workers are responsible for handling requests from the RoadRunner server
283
+
and processing them in your Laravel application.
277
284
The predefined workers are configured in the `config/roadrunner.php` file:
278
285
279
286
```php
@@ -304,7 +311,8 @@ class CustomWorker implements WorkerInterface
304
311
{
305
312
public function start(WorkerOptionsInterface $options): void
306
313
{
307
-
// Your custom worker implementation
314
+
// Your worker implementation goes here
315
+
// This method should handle requests from the RoadRunner server
308
316
}
309
317
}
310
318
```
@@ -328,15 +336,21 @@ return [
328
336
];
329
337
```
330
338
339
+
The key in the `workers` array should match the value of the `RR_MODE` environment variable
340
+
set by the RoadRunner server for your plugin.
341
+
331
342
## Support
332
343
333
-
If you find this package helpful, please consider giving it a star on GitHub. Your support helps make the project more visible to other developers who might benefit from it!
344
+
If you find this package helpful, please consider giving it a star on GitHub.
345
+
Your support helps make the project more visible to other developers who might benefit from it!
334
346
335
347
[![Issues][badge_issues]][link_issues]
336
348
[![Issues][badge_pulls]][link_pulls]
337
349
338
350
If you find any package errors, please, [make an issue][link_create_issue] in a current repository.
339
351
352
+
You can also [sponsor this project][link_sponsor] to help ensure its continued development and maintenance.
353
+
340
354
## License
341
355
342
356
MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
@@ -383,6 +397,8 @@ MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
0 commit comments