PHPackages vdlp/oc-horizon-plugin - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Caching](/categories/caching) 4. / 5. vdlp/oc-horizon-plugin ActiveOctober-plugin[Caching](/categories/caching) vdlp/oc-horizon-plugin ====================== Laravel Horizon integration for October CMS 3.4.0(10mo ago)837.4k↓39.6%3GPL-2.0-onlyPHPPHP ^8.0.2CI passing Since Jun 22Pushed 10mo ago9 watchersCompare [ Source](https://github.com/vdlp/oc-horizon-plugin)[ Packagist](https://packagist.org/packages/vdlp/oc-horizon-plugin)[ Docs](https://vdlp.nl)[ RSS](/packages/vdlp-oc-horizon-plugin/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (4)Versions (15)Used By (0) Vdlp.Horizon ============ [](#vdlphorizon) Provides a seamless integration of [Laravel Horizon 5.0](https://laravel.com/docs/9.x/horizon) inside October CMS. [![Laravel Horizon Logo](https://camo.githubusercontent.com/09c3153c2b508ab8fc7b1e57ad80c3006c85e23023a1728ec02c7beddaa3c6e2/68747470733a2f2f706c7567696e732e76646c702e6e6c2f6f63746f626572636d732f6f632d686f72697a6f6e2d706c7567696e2f6c6f676f2e706e67)](https://camo.githubusercontent.com/09c3153c2b508ab8fc7b1e57ad80c3006c85e23023a1728ec02c7beddaa3c6e2/68747470733a2f2f706c7567696e732e76646c702e6e6c2f6f63746f626572636d732f6f632d686f72697a6f6e2d706c7567696e2f6c6f676f2e706e67) Queues, With X-Ray Vision. Supercharge your queues with a beautiful dashboard and code-driven configuration. [![Laravel Horizon Dashboard](https://camo.githubusercontent.com/25cdd6d8d40025004e420a777f521342c79eaf1c4f9574868fb7743ebaded8f0/68747470733a2f2f706c7567696e732e76646c702e6e6c2f6f63746f626572636d732f6f632d686f72697a6f6e2d706c7567696e2f64617368626f6172642e706e67)](https://camo.githubusercontent.com/25cdd6d8d40025004e420a777f521342c79eaf1c4f9574868fb7743ebaded8f0/68747470733a2f2f706c7567696e732e76646c702e6e6c2f6f63746f626572636d732f6f632d686f72697a6f6e2d706c7567696e2f64617368626f6172642e706e67) ### A match made in heaven [](#a-match-made-in-heaven) Horizon is developed by the core developers of the Laravel framework and provides a robust queue monitoring solution for Laravel's Redis queue. Horizon allows you to easily monitor key metrics of your queue system such as job throughput, runtime, and job failures. ### Open Source [](#open-source) Horizon is 100% open source, so you're free to dig through the source to see exactly how it works. See something that needs to be improved? Just send us a pull request on GitHub. Requirements ------------ [](#requirements) - October CMS 3.0 or 4.0 - PHP 8.0.2 or higher - PHP extensions: `ext-pcntl`, `ext-posix` and `ext-redis`. - Supervisor, see [Laravel 9.x supervisor configuration](https://laravel.com/docs/9.x/queues#supervisor-configuration). Installation ------------ [](#installation) ``` composer require vdlp/oc-horizon-plugin ``` ### Turn off auto discovery for `laravel/horizon` (important) [](#turn-off-auto-discovery-for-laravelhorizon-important) Because this plugin has it's own `HorizonServiceProvider` which extends from the `Laravel\Horizon\HorizonServiceProvider`we need to prevent the `Laravel\Horizon\HorizonServiceProvider` from being loaded due to Laravels' auto package discovery. You should add the `dont-discover` option to your projects `composer.json` file (which is located in the root path of your project). ``` "extra": { "laravel": { "dont-discover": [ "laravel/horizon" ] } } ``` > IMPORTANT: After adding these lines, make sure you execute `composer update` to apply the changes. You also need to remove the file `storage/framework/packages.php` file. No worries. This file will be re-generated once you access your project. > IMPORTANT: Make sure the `composer.json` is deployed to your hosting site. This will be parsed by te framework to determine which service providers should be ignored. Configuration ------------- [](#configuration) ``` php artisan horizon:install ``` - Configure Laravel Horizon settings file at `config/horizon.php`, please make sure `use` contains `horizon` (see the configuration snippet below). ``` /* |-------------------------------------------------------------------------- | Horizon Redis Connection |-------------------------------------------------------------------------- | | This is the name of the Redis connection where Horizon will store the | meta information required for it to function. It includes the list | of supervisors, failed jobs, job metrics, and other information. | */ 'use' => 'horizon', ``` - Add connection to `config/queue.php`: ``` 'redis' => [ 'driver' => 'redis', 'connection' => 'horizon', // References: databases.redis.horizon 'queue' => env('REDIS_QUEUE', 'default'), 'retry_after' => env('QUEUE_RETRY_AFTER', 90), 'block_for' => null, ], ``` - Add Redis database configuration for Horizon specifically to `config/databases.php`: ``` 'redis' => [ 'cluster' => false, 'client' => 'phpredis', 'default' => [ // .. ], 'horizon' => [ 'host' => env('HORIZON_REDIS_HOST', '127.0.0.1'), 'password' => env('HORIZON_REDIS_PASSWORD'), 'port' => env('HORIZON_REDIS_PORT', 6379), 'database' => env('HORIZON_REDIS_DATABASE', '1'), ] ], ``` - Modify the queue connection `QUEUE_CONNECTION` (which can be found in `config/queue.php`) to `redis` as such: ``` /* |-------------------------------------------------------------------------- | Default Queue Driver |-------------------------------------------------------------------------- | | The Laravel queue API supports a variety of back-ends via an unified | API, giving you convenient access to each back-end using the same | syntax for each one. Here you may set the default queue driver. | | Supported: "null", "sync", "database", "beanstalkd", | "sqs", "iron", "redis" | */ 'default' => env('QUEUE_CONNECTION', 'redis'), ``` - `.env` should at least have the following `QUEUE_` and `HORIZON_` variables: ``` # # Queue # QUEUE_CONNECTION = "redis" QUEUE_RETRY_AFTER = 90 # # Horizon # HORIZON_PREFIX = "myproject-local:" HORIZON_REDIS_HOST = "127.0.0.1" HORIZON_REDIS_PASSWORD = null HORIZON_REDIS_PORT = 6379 HORIZON_REDIS_DATABASE = "1" ``` It's recommended to add your Queue Worker Configuration `config.horizon.environments` to the `.env` file as well. Server configuration -------------------- [](#server-configuration) - Add the following to the `supervisord` configuration on the server. The complete `supervisord` configuration can be found [on the supervisor website](http://supervisord.org/index.html). - See [Configuring Supervisor](https://laravel.com/docs/9.x/queues#configuring-supervisor) (Official Laravel Documentation). ``` [program:-queue] process_name=%(program_name)s_%(process_num)02d directory=/ command=//php //artisan horizon autostart=true autorestart=true stopasgroup=true killasgroup=true user= numprocs=1 redirect_stderr=true stdout_logfile=/var/log/supervisord/-queue.log stopwaitsecs=90 ``` - Add the following to the cronjob configuration on the server. This will make sure the [Horizon metrics](https://laravel.com/docs/9.x/horizon#metrics) are created periodically. ``` * * * * * //php //artisan schedule:run > /dev/null ``` Creating Job classes -------------------- [](#creating-job-classes) Follow the instructions at [Laravel 9.x generating job classes](https://laravel.com/docs/9.x/queues#generating-job-classes) on how to make Job classes. > Please note that the use of the `php artisan make:job` command is not supported in October CMS. October CMS is using a different application structure in comparison to a generic Laravel project. This plugin also contains an example job file: `Vdlp\Horizon\Example`. This example file does not use the `SerializesModels` and `InteractsWithQueue` trait. Testing ------- [](#testing) 1. Log-in to the backend. 2. Put application in debug mode using the `.env` file: `APP_DEBUG=true` or by changing the `debug` key in the `config/app.php` file. 3. Run Horizon using this command: `php artisan horizon`. 4. Now run this command to push some `Vdlp\Horizon\Example` jobs to the queue: ``` php artisan vdlp:horizon:push-example-jobs ``` 5. Check the Horizon dashboard at `/backend/vdlp/horizon/dashboard` or at `/horizon`. 6. Each `Vdlp\Horizon\Example` job should log a random string to the application log (level = `debug`). Documentation ------------- [](#documentation) Please go to the Laravel website for detailed documentation about Laravel Horizon. [Horizon for Laravel 9.x](https://laravel.com/docs/9.x/horizon) Questions --------- [](#questions) If you have any question about how to use this plugin, please don't hesitate to contact us at . We're happy to help you. You can also visit the support forum and drop your questions/issues there. ### Health Score 46 — FairBetter than 93% of packages Maintenance54 Moderate activity, may be stable Popularity36 Limited adoption so far Community18 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 69.4% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~133 days Recently: every ~219 days Total 12 Last Release 320d ago Major Versions 1.0.0 → 2.0.02021-11-05 2.x-dev → 3.0.02022-04-16 PHP version history (3 changes)1.0.0PHP >=7.1 2.0.0PHP ^7.4 || ^8.0 3.0.0PHP ^8.0.2 ### Community Maintainers ![](https://www.gravatar.com/avatar/ed365dfb5c3f4b31be2bf8ad39d1541c4c35be295e94a80ed39a4b26204355d0?d=identicon)[vdlp](/maintainers/vdlp) --- Top Contributors [![adrenth](https://avatars.githubusercontent.com/u/5699988?v=4)](https://github.com/adrenth "adrenth (50 commits)")[![sander-beenen](https://avatars.githubusercontent.com/u/2843816?v=4)](https://github.com/sander-beenen "sander-beenen (11 commits)")[![martenvdlp](https://avatars.githubusercontent.com/u/83412223?v=4)](https://github.com/martenvdlp "martenvdlp (6 commits)")[![jacobdekeizer](https://avatars.githubusercontent.com/u/15017400?v=4)](https://github.com/jacobdekeizer "jacobdekeizer (3 commits)")[![JaccoVDLP](https://avatars.githubusercontent.com/u/152970490?v=4)](https://github.com/JaccoVDLP "JaccoVDLP (1 commits)")[![mrmaarek](https://avatars.githubusercontent.com/u/3919811?v=4)](https://github.com/mrmaarek "mrmaarek (1 commits)") --- Tags cmslaraveloctobercms-pluginphpqueueredishorizonoctoberoctobercmslaravel-queues ### Embed Badge ![Health badge](/badges/vdlp-oc-horizon-plugin/health.svg) ``` [![Health](https://phpackages.com/badges/vdlp-oc-horizon-plugin/health.svg)](https://phpackages.com/packages/vdlp-oc-horizon-plugin) ``` ### Alternatives [rainlab/builder-plugin Builder plugin for October CMS 17147.2k1](/packages/rainlab-builder-plugin)[rainlab/translate-plugin Translate plugin for October CMS 12666.5k9](/packages/rainlab-translate-plugin)[rainlab/pages-plugin Pages plugin for October CMS 12252.4k4](/packages/rainlab-pages-plugin)[rainlab/user-plugin User plugin for October CMS 11954.3k13](/packages/rainlab-user-plugin)[rainlab/blog-plugin Blog plugin for October CMS 17257.7k](/packages/rainlab-blog-plugin)[rainlab/sitemap-plugin Sitemap plugin for October CMS 2277.8k1](/packages/rainlab-sitemap-plugin) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)