Skip to content

Commit 9f176a4

Browse files
committed
Update README.md
- Add information about the cron_consumers_runner configuration - Add note about assumption that php is in PATH - Add features - Update the help message
1 parent 5d0c6ce commit 9f176a4

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,22 @@
22

33
Daemon for running Magento 2 queue consumers, designed to be run as a systemd/supervisor service.
44

5+
This daemon acts as a drop-in replacement for the Magento 2 cron consumers runner, compatible with the Magento 2 [cron consumers runner configuration](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/message-queues/manage-message-queues.html#configuration).
6+
57
## Features
68

79
- Detects and runs all eligible Magento 2 queue consumers
8-
- If RabbitMQ is not configured, it will not run consumers that require RabbitMQ
10+
- RabbitMQ specific consumers are not run when RabbitMQ is not configured in Magento.
11+
- Compatible with the `cron_consumers_runner.consumers` setting to only run specified consumers.
12+
- Regards all settings in the `cron_consumers_runner` [environment configuration](https://experienceleague.adobe.com/docs/commerce-operations/configuration-guide/message-queues/manage-message-queues.html#configuration).
913
- Restarts consumers if they fail/stop
1014
- Supports running consumers in a different working directory
1115
- Validates Magento 2 installation before starting consumers
1216

1317
## Installation
1418

19+
Make sure you have the correct `php` binary in the PATH environment variable where you're going to run this.
20+
1521
```bash
1622
wget --quiet https://github.com/tdgroot/magento2-worker-daemon/releases/latest/download/magento2-worker-daemon -O magento2-worker-daemon
1723
chmod +x magento2-worker-daemon
@@ -33,8 +39,8 @@ $ magento2-worker-daemon --help
3339
Usage: magento2-worker-daemon [OPTIONS]
3440

3541
Options:
36-
-v, --verbose
37-
-w, --working-directory <WORKING_DIRECTORY>
42+
-v, --verbose Enable verbose logging
43+
-w, --working-directory <WORKING_DIRECTORY> Magento 2 working directory
3844
-h, --help Print help
3945
-V, --version Print version
4046
```
@@ -81,10 +87,3 @@ stopsignal=INT
8187
stopasgroup=true
8288
```
8389

84-
## Work in progress
85-
86-
This project is still a work in progress, and is not yet ready for production use.
87-
88-
Things that still need to be done:
89-
- Blocklist for consumers that should not be started
90-
- Support for specifying consumer options (e.g. max messages, multi-process, etc.)

0 commit comments

Comments
 (0)