# element119/module-indexer-deploy-config
> A Magento 2 module that allows developers to lock indexer modes via deployment config.
`composer require element119/module-indexer-deploy-config`
Canonical URL: https://packagento.com/element119/module-indexer-deploy-config
## At a glance
- **Vendor**: element119 (https://packagento.com/element119.md)
- **Latest version**: 1.2.5 โ released 2025-06-08
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers
## Installation
Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.
1. **Sign in or create an account** at https://packagento.com/customer/account/.
2. **Add the package to your account.** Open https://packagento.com/element119/module-indexer-deploy-config and complete the free checkout. A licence is minted automatically.
3. **Create or pick a project, then activate the licence on it.**
- Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
- Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.
4. **Add the project credentials to your Magento codebase.**
Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:
```json
{
"http-basic": {
"packagento.com": {
"username": "ppk_live_...",
"password": "psk_live_..."
}
}
}
```
Add the Packagento Composer repository to `composer.json`:
```json
{
"repositories": [
{ "type": "composer", "url": "https://packagento.com" }
]
}
```
5. **Install and apply.**
```bash
composer require element119/module-indexer-deploy-config:*
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:flush
```
## What it does
A Magento 2 module that allows developers to lock indexer modes via deployment config.
## README
element119 | Indexer Deploy Config
A Magento 2 module that allows developers to lock indexer modes via deployment config.
### ๐ 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
Run the following command to *install* this module:
```bash
composer require element119/module-indexer-deploy-config
php bin/magento setup:upgrade
```
### โซ Updating
Run the following command to *update* this module:
```bash
composer update element119/module-indexer-deploy-config
php bin/magento setup:upgrade
```
### โ Uninstallation
Run the following command to *uninstall* this module:
```bash
composer remove element119/module-indexer-deploy-config
php bin/magento setup:upgrade
```
### ๐ User Guide
#### 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
```php
'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
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:lock-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 arguments locks the indexer modes to their current state.*
*Passing `-m realtime` as the argument sets all indexers to `Update on Save`.*
*Passing `-m schedule` as the argument sets all indexers to `Update by Schedule`.*
#### Restricted Admin Controls
## Recent Versions
| Version | Released |
|---|---|
| 1.2.5 | 2025-06-08 |
| 1.2.4 | 2025-05-01 |
| 1.2.3 | 2023-03-17 |
| 1.2.2 | 2023-02-27 |
| 1.2.1 | 2023-02-27 |
| 1.2.0 | 2023-02-25 |
| 1.1.1 | 2022-11-08 |
| 1.1.0 | 2022-11-07 |
| 1.0.0 | 2022-11-06 |
## Dependencies
### Require
| Package | Constraint |
|---|---|
| magento/module-indexer | ^100.0 |
| php | ^7.4 \|\| ^8.0 |
## Quality
Latest release (1.2.5) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line ร PHP version) for the matrixed tools, and run-once for the static / security tiers.
### Compatibility
Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `โ`.
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | โ | โ |
| 2.4.8 | โ | Pass | Pass | โ |
| 2.4.9 | โ | โ | 1 | 1 |
### Code Quality
Advisory checks against the module's source. Never affect the Compatibility verdict โ a phpcs finding can't make a module incompatible.
#### Static Analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 6 | 6 warnings (ruleset: Magento2) โ 2 auto-fixable with phpcbf |
| PHPMD | Warning | 9 | 9 rule violations (IfStatementAssignment:5, CyclomaticComplexity:2, NPathComplexity:2) |
| Cpd | Pass | 0 | |
| Composer validate | Pass | 0 | |
#### PHPStan
Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 9 | 9 | โ | โ |
| 2.4.8 | โ | 9 | 9 | โ |
| 2.4.9 | โ | โ | 10 | 10 |
### Tests
Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.
#### Unit Tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | โ | โ |
| 2.4.8 | โ | N/A | N/A | โ |
| 2.4.9 | โ | โ | N/A | N/A |
#### Integration Tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | โ | โ |
| 2.4.8 | โ | N/A | N/A | โ |
| 2.4.9 | โ | โ | N/A | N/A |
### Security
Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.
| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 | |
## Licence and pricing
Free. A licence is still minted on checkout and bound to your project for Composer access โ no payment step.
Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.
## Install via Claude Code or any MCP client
The Packagento MCP server can run the licence + project + Composer steps above in one tool call:
```
purchase_and_install_packages(
composer_names=["element119/module-indexer-deploy-config"],
project_id="proj_xxx"
)
```
This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.
## Vendor
element119 is a Magento 2 vendor on Packagento. See https://packagento.com/element119.md for their full catalogue.