Weave Code
Oc Horizon Plugin Laravel Package
vdlp/oc-horizon-plugin
Integrates Laravel Horizon into October CMS so you can monitor and manage Redis-backed queues from Horizon's dashboard, with job metrics, retries, and workload insights available inside your October CMS project.
vdlp/oc-horizon-plugin integrates Laravel Horizon queue monitoring into October CMS. It gives developers a convenient way to inspect Redis-backed queues, jobs, and workers from the October backend, making Horizon’s dashboard and metrics easier to use within an October project.
- Adds Horizon’s queue dashboard to October CMS
- Monitors jobs, queues, workers, and throughput
- Provides visibility into failed jobs and queue health
- Simplifies Horizon access inside the October admin area
Frequently asked questions about Oc Horizon Plugin
- How do I install vdlp/oc-horizon-plugin in October CMS?
- Install it with Composer by requiring vdlp/oc-horizon-plugin, then enable the plugin through the October CMS backend or the plugin:enable artisan command. After enabling, confirm that laravel/horizon is installed and compatible with your Laravel major version, since the plugin is an adapter rather than a replacement for Horizon itself. You will also need a reachable Redis instance and queue connections configured consistently with what Horizon supervises.
- Does this plugin work with Laravel Horizon on October CMS?
- Yes, that is its entire purpose: it grafts Laravel Horizon's queue-monitoring UI and supervisor orchestration onto October CMS's plugin and module architecture. October CMS runs on top of Laravel, so the framework-level fit is natural, but the adapter has to bridge October's plugin lifecycle, backend authentication, and asset publishing. It is only relevant for October CMS projects; for a plain Laravel application you would install Horizon directly.
- What PHP, Laravel, and October CMS versions does this plugin support?
- Check the composer.json constraints in the tagged release for october/*, laravel/framework, and laravel/horizon before adopting. Version 3.4.0 is a minor bump from 3.3.0, but its published release notes contain only an auto-generated compare link, so version floors are not disclosed in the notes. Confirm your PHP version, October CMS version, and Horizon version all satisfy those constraints.
- How does the plugin handle Horizon authorization and October backend permissions?
- Horizon normally relies on Gate and Horizon::auth, while October CMS supplies its own backend user, role, and permission model, so the plugin must bind the two. This is the seam most worth verifying yourself before rollout, because Horizon exposes retry, delete, purge, terminate, and supervisor scaling behind a web route. Confirm that a granular permission is enforced rather than allowing any backend user to reach the dashboard.
- Does the plugin require Redis, and can I use it with database or SQS queues?
- Horizon supervises Redis-backed queues only, so a Redis instance reachable from the application is a hard prerequisite. If your application runs queues on the database driver or SQS, Horizon will not monitor or process those queues. Confirm Redis is available in every environment where Horizon should run, which often excludes local development machines.
- Do I need systemd or supervisor to run the horizon process with this plugin?
- Yes. The plugin integrates Horizon's UI and orchestration into October CMS but cannot provide process supervision for the horizon worker itself. You still need systemd, supervisord, or a container sidecar to keep the horizon process alive and restart it on failure. Plan that operational piece alongside the plugin installation.
- What changed in version 3.4.0 of vdlp/oc-horizon-plugin?
- The published release notes for 3.4.0 contain only an auto-generated compare link, so nothing is disclosed beyond the diff. A minor bump under semver implies additive or fix-level changes, but it could still carry a changed PHP, Laravel, or October constraint, a Horizon major bump, or a permission-handling change. Review the compare/3.3.0...3.4.0 diff and the tagged composer.json before upgrading on the version number alone.
- Is Laravel Horizon vendored by this plugin or does it use my app's installed Horizon version?
- Verify this in the plugin's composer.json, because it determines who owns Horizon upgrades. If Horizon is a normal dependency, your application's constraint governs the installed version and you are responsible for keeping it current. If the plugin pins a specific Horizon range, upgrading Horizon may require waiting for a plugin release, and Horizon internals are not covered by Laravel's backward-compatibility promise the way facades are.
- Are there alternatives to this plugin for monitoring queues in October CMS?
- October CMS does not ship a Horizon-equivalent queue dashboard, so the alternatives are to hand-wire Horizon into a custom plugin, run Horizon from a separate Laravel application, or rely on external or hosted queue monitoring. This package exists specifically to avoid the hand-wiring, so it is the pragmatic choice for Redis-backed October projects. For non-Redis or non-October estates it does not apply.
- How do I upgrade this plugin safely and what should I check first?
- Pin the version in composer.json, review the diff between your current tag and the new one, and check the composer.json constraints for october/*, laravel/framework, and laravel/horizon. Test the upgrade in a staging environment with Horizon running against a real Redis instance, and re-verify that the backend permission still gates the dashboard. Also check the upstream repository's release cadence, since the October plugin ecosystem tends to absorb Laravel and Horizon majors more slowly than Laravel itself.
Weaver
How can I help you explore Laravel packages today?