https://github.com/tdgroot/magento2-worker-daemon
Daemon for running Magento 2 queue consumers
https://github.com/tdgroot/magento2-worker-daemon
daemon magento2 queue-workers
Last synced: 17 days ago
JSON representation
Daemon for running Magento 2 queue consumers
- Host: GitHub
- URL: https://github.com/tdgroot/magento2-worker-daemon
- Owner: tdgroot
- License: mit
- Created: 2023-04-28T13:32:33.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-24T14:51:24.000Z (almost 2 years ago)
- Last Synced: 2025-04-12T00:15:47.688Z (17 days ago)
- Topics: daemon, magento2, queue-workers
- Language: Rust
- Homepage:
- Size: 45.9 KB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Magento 2 Worker Daemon
Daemon for running Magento 2 queue consumers, designed to be run as a systemd/supervisor service.
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).
## Features
- Detects and runs all eligible Magento 2 queue consumers
- RabbitMQ specific consumers are not run when RabbitMQ is not configured in Magento.
- Compatible with the `cron_consumers_runner.consumers` setting to only run specified consumers.
- 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).
- Restarts consumers if they fail/stop
- Supports running consumers in a different working directory
- Validates Magento 2 installation before starting consumers
## Installation
The program is not available yet on any package repository, so for now you can to download it from the latest GitHub release.
```bash
wget --quiet https://github.com/tdgroot/magento2-worker-daemon/releases/latest/download/magento2-worker-daemon -O magento2-worker-daemon
chmod +x magento2-worker-daemon
./magento2-worker-daemon
```
## Usage
```console
$ magento2-worker-daemon
2023-04-28T13:36:12.788Z INFO [magento2_worker_daemon] Found 19 consumers
2023-04-28T13:36:12.793Z INFO [magento2_worker_daemon] Started 19 consumers
```
### Command line options
```console
$ magento2-worker-daemon --help
Usage: magento2-worker-daemon [OPTIONS]
Options:
-v, --verbose Enable verbose logging
-w, --working-directory Magento 2 working directory
-h, --help Print help
-V, --version Print version
```
## Configuration
First make sure you disable the `cron_consumers_runner.cron_run` setting in the `app/etc/env.php`:
```php
return [
...
'cron_consumers_runner' => [
'cron_run' => false
],
...
];
```
Also make sure you have the correct `php` binary in the `PATH` environment variable where you're going to run this.
So if you have PHP installed in a directory that is not in the default `PATH`, make sure you set the proper environment configuration for systemd/supervisor.
### Systemd
```ini
[Unit]
Description=Magento 2 Worker Daemon
After=network.target
[Service]
WorkingDirectory=/path/to/magento2
ExecStart=/usr/bin/magento2-worker-daemon
Restart=always
[Install]
WantedBy=multi-user.target
```
### Supervisor
```ini
[program:magento2-worker-daemon]
directory=/path/to/magento2
command=/usr/bin/magento2-worker-daemon
autostart=true
autorestart=true
stopsignal=INT
stopasgroup=true
```