PHPackages element119/module-indexer-deploy-config - 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. [Utility & Helpers](/categories/utility) 4. / 5. element119/module-indexer-deploy-config ActiveMagento2-module[Utility & Helpers](/categories/utility) element119/module-indexer-deploy-config ======================================= A Magento 2 module that allows developers to lock indexer modes via deployment config. 1.2.5(11mo ago)33136.6kโ†“11.1%4[2 PRs](https://github.com/pykettk/module-indexer-deploy-config/pulls)OSL-3.0PHPPHP ^7.4 || ^8.0 Since Nov 6Pushed 11mo ago1 watchersCompare [ Source](https://github.com/pykettk/module-indexer-deploy-config)[ Packagist](https://packagist.org/packages/element119/module-indexer-deploy-config)[ RSS](/packages/element119-module-indexer-deploy-config/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (9)Dependencies (1)Versions (11)Used By (0) element119 | Indexer Deploy Config ================================== [](#element119--indexer-deploy-config) #### A Magento 2 module that allows developers to lock indexer modes via deployment config. [](#a-magento-2-module-that-allows-developers-to-lock-indexer-modes-via-deployment-config) [![github release](https://camo.githubusercontent.com/58eea73225866c648a7ff8ad75a5d6bc6c286a4e07a67b327a1495007baa7242/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f70796b6574746b2f6d6f64756c652d696e64657865722d6465706c6f792d636f6e6669673f636f6c6f723d666662663030266c6162656c3d76657273696f6e)](https://camo.githubusercontent.com/58eea73225866c648a7ff8ad75a5d6bc6c286a4e07a67b327a1495007baa7242/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f70796b6574746b2f6d6f64756c652d696e64657865722d6465706c6f792d636f6e6669673f636f6c6f723d666662663030266c6162656c3d76657273696f6e)[![github release date](https://camo.githubusercontent.com/8876a12fb558c2aa45b40a9005ff05f977adebdcf9f8f3bcf70e5df43658b3a9/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652d646174652f70796b6574746b2f6d6f64756c652d696e64657865722d6465706c6f792d636f6e6669673f636f6c6f723d386233326138266c6162656c3d6c61737425323072656c65617365)](https://camo.githubusercontent.com/8876a12fb558c2aa45b40a9005ff05f977adebdcf9f8f3bcf70e5df43658b3a9/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652d646174652f70796b6574746b2f6d6f64756c652d696e64657865722d6465706c6f792d636f6e6669673f636f6c6f723d386233326138266c6162656c3d6c61737425323072656c65617365)[![license](https://camo.githubusercontent.com/d5825877ca1b85c91501e0d9b5e7f47a88b371c399f58d8ac38d1686d4508a08/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4f534c2d6666303064642e737667)](https://camo.githubusercontent.com/d5825877ca1b85c91501e0d9b5e7f47a88b371c399f58d8ac38d1686d4508a08/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4f534c2d6666303064642e737667)[![packagist downloads](https://camo.githubusercontent.com/483d9be26e2a0f457035405fe31d7782c6bc607f76dfc58020d488cb448e45f0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f656c656d656e743131392f6d6f64756c652d696e64657865722d6465706c6f792d636f6e6669673f636f6c6f723d666630303030)](https://camo.githubusercontent.com/483d9be26e2a0f457035405fe31d7782c6bc607f76dfc58020d488cb448e45f0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f656c656d656e743131392f6d6f64756c652d696e64657865722d6465706c6f792d636f6e6669673f636f6c6f723d666630303030) ๐Ÿ“ Features ---------- [](#-features) โœ”๏ธ Allows you to selectively lock indexer modes via the `app/etc/config.php` file โœ”๏ธ Indexer configuration validated and imported as part of `app:config:import` โœ”๏ธ Supports custom indexers โœ”๏ธ Provides messaging for admins to see which indexers are locked via deploy config โœ”๏ธ Informs admins when they try to change indexer modes that are locked via deploy config โœ”๏ธ Supports Magento Open Source and Adobe Commerce โœ”๏ธ Supports Hyvรค and Luma based themes โœ”๏ธ Seamless integration with Magento โœ”๏ธ Built with developers and extensibility in mind to make customisations as easy as possible โœ”๏ธ Installable via Composer ๐Ÿ”Œ Installation -------------- [](#-installation) Run the following command to *install* this module: ``` composer require element119/module-indexer-deploy-config php bin/magento setup:upgrade ``` โซ Updating ---------- [](#-updating) Run the following command to *update* this module: ``` composer update element119/module-indexer-deploy-config php bin/magento setup:upgrade ``` โŒ Uninstallation ---------------- [](#-uninstallation) Run the following command to *uninstall* this module: ``` composer remove element119/module-indexer-deploy-config php bin/magento setup:upgrade ``` ๐Ÿ“š User Guide ------------ [](#-user-guide) ### Locking Indexer Modes [](#locking-indexer-modes) 1. Add a new `indexers` array to the `app/etc/config.php` file 2. Add the `realtime` or `schedule` arrays to the `indexers` array as required 3. Specify the indexer IDs you want to lock to a specific mode within the respective mode array ### Example [](#example) ``` 'indexers' => [ 'realtime' => [ 'catalogrule_rule', 'design_config_grid', ], 'schedule' => [ 'catalog_category_product', 'catalog_product_category', 'catalog_product_attribute', 'catalog_product_price', ], ], ``` > **Note** > > Empty indexer mode arrays may be omitted in the cases where you don't want to lock any indexers to that mode. ### Indexer Mode Locking Cron Fallback [](#indexer-mode-locking-cron-fallback) A new system configuration option allows you to enable a cron job that will ensure indexers are in the mode they are supposed to be in, according to deployment config. This option can be found in `Stores -> Configuration -> Advanced -> System -> Indexer Mode Locking`. [![indexer-mode-locking-cron-config](https://user-images.githubusercontent.com/40261741/221367876-d04e812d-9628-4bb2-a335-8532dd27299e.png)](https://user-images.githubusercontent.com/40261741/221367876-d04e812d-9628-4bb2-a335-8532dd27299e.png) ### `indexer:lock-all` Command [](#indexerlock-all-command) The module adds a new `indexer:lock-all` command that you can use to lock the indexer modes via the command line. ``` Description: Lock all indexers Usage: indexer:lock-all [options] Options: -m, --mode=MODE Passing one of two modes (schedule, realtime) will lock all indexers to that mode. -h, --help Display this help message -q, --quiet Do not output any message -V, --version Display this application version --ansi Force ANSI output --no-ansi Disable ANSI output -n, --no-interaction Do not ask any interactive question -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug ``` > **Note** > > You will need to run `app:config:import` after indexer modes have been set, unset, or changed in the deploy config. > > Due to the fact that this new command writes to the deploy config files and this module makes [additions to the deploy config pool](https://github.com/pykettk/module-indexer-deploy-config/blob/master/etc/di.xml#L26-L39), any automated deployment pipelines will need to run `app:config:import` in non-interactive mode by passing either `-n` or `--no-interaction` as command options to avoid [the usual prompt](https://github.com/pykettk/module-indexer-deploy-config/blob/master/Model/Config/Importer.php#L72-L144). [![no command arguments](https://user-images.githubusercontent.com/40261741/200428379-36934940-cf7a-43f7-9ba3-3358dd97a0de.png)](https://user-images.githubusercontent.com/40261741/200428379-36934940-cf7a-43f7-9ba3-3358dd97a0de.png) *No arguments locks the indexer modes to their current state.* [![realtime argument](https://user-images.githubusercontent.com/40261741/200428676-cdb44054-19a8-4421-a4f8-bf9fbc93cbb6.png)](https://user-images.githubusercontent.com/40261741/200428676-cdb44054-19a8-4421-a4f8-bf9fbc93cbb6.png) *Passing `-m realtime` as the argument sets all indexers to `Update on Save`.* [![schedule argument](https://user-images.githubusercontent.com/40261741/200428778-f4441b0d-67ec-4911-b612-ad1a47a96558.png)](https://user-images.githubusercontent.com/40261741/200428778-f4441b0d-67ec-4911-b612-ad1a47a96558.png) *Passing `-m schedule` as the argument sets all indexers to `Update by Schedule`.* ### Restricted Admin Controls [](#restricted-admin-controls) [![restrictded-admin-controls](https://user-images.githubusercontent.com/40261741/200190327-5e9f5204-d294-4a27-a27e-74fb6ea6b968.png)](https://user-images.githubusercontent.com/40261741/200190327-5e9f5204-d294-4a27-a27e-74fb6ea6b968.png) ### Health Score 45 โ€” FairBetter than 93% of packages Maintenance51 Moderate activity, may be stable Popularity44 Moderate usage in the ecosystem Community13 Small or concentrated contributor base Maturity57 Maturing project, gaining track record Bus Factor1 Top contributor holds 79.5% 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 ~118 days Recently: every ~208 days Total 9 Last Release 344d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/9eb2b9f555deb74b70b6fa37fe4e505579581ee49c6ca3420dcd769602cf8107?d=identicon)[pykettk](/maintainers/pykettk) --- Top Contributors [![pykettk](https://avatars.githubusercontent.com/u/40261741?v=4)](https://github.com/pykettk "pykettk (35 commits)")[![peterjaap](https://avatars.githubusercontent.com/u/431360?v=4)](https://github.com/peterjaap "peterjaap (8 commits)")[![convenient](https://avatars.githubusercontent.com/u/600190?v=4)](https://github.com/convenient "convenient (1 commits)") ### Embed Badge ![Health badge](/badges/element119-module-indexer-deploy-config/health.svg) ``` [![Health](https://phpackages.com/badges/element119-module-indexer-deploy-config/health.svg)](https://phpackages.com/packages/element119-module-indexer-deploy-config) ``` ### Alternatives [run-as-root/magento2-prometheus-exporter Magento2 Prometheus Exporter 69344.4k](/packages/run-as-root-magento2-prometheus-exporter)[commercy/module-improved-indexer Optimizations and Improvements for the Magento 2 indexer. 181.1k](/packages/commercy-module-improved-indexer) PHPackages ยฉ 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)