PHPackages                             blackbird/scoped-maintenance - 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. blackbird/scoped-maintenance

ActiveMagento2-module[Utility & Helpers](/categories/utility)

blackbird/scoped-maintenance
============================

This module allows you to enable maintenance mode for specific stores in a Magento instance while leaving others accessible.

1.0.2(8mo ago)47.4k↓53.2%MITPHPPHP >=7.3

Since Feb 7Pushed 8mo ago2 watchersCompare

[ Source](https://github.com/blackbird-agency/magento-2-scoped-maintenance)[ Packagist](https://packagist.org/packages/blackbird/scoped-maintenance)[ RSS](/packages/blackbird-scoped-maintenance/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (2)Dependencies (1)Versions (4)Used By (0)

Blackbird Scoped Maintenance
============================

[](#blackbird-scoped-maintenance)

[![Latest Stable Version](https://camo.githubusercontent.com/f61d47e792d39b7c43cde4eb0c43df5da07966350b56a4964f10c9e6adcc973e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f626c61636b626972642f73636f7065642d6d61696e74656e616e63652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/blackbird/scoped-maintenance)[![License: MIT](https://camo.githubusercontent.com/15dd8ab2a4d113607683cd03241d479c68114cddb009cd5a0d7ecc906d23965f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f626c61636b626972642d6167656e63792f6d6167656e746f2d322d73636f7065642d6d61696e74656e616e63652e7376673f7374796c653d666c61742d737175617265)](./LICENSE.txt)

This module allows you to enable maintenance mode for specific stores in a Magento instance while leaving others accessible. It provides fine-grained control over store access during maintenance mode and optionally allows specific IP addresses to bypass maintenance restrictions.

Key functionality includes:

- Activating maintenance mode for specific stores (scoped maintenance).
- Specifying IP addresses to allow access during maintenance mode.
- Automatically managing cache to reflect store maintenance state.

The source code is available at the [GitHub repository](https://github.com/blackbird-agency/magento-2-scoped-maintenance).

---

Setup
-----

[](#setup)

### Get the Package

[](#get-the-package)

#### **Zip Package:**

[](#zip-package)

Unzip the package into `app/code/Blackbird/ScopedMaintenance`, from the root of your Magento instance.

#### **Composer Package:**

[](#composer-package)

```
    composer require blackbird/scoped-maintenance
```

### Install the Module

[](#install-the-module)

Go to your Magento root directory, then run the following Magento command:

**If you are in production mode, do not forget to recompile and redeploy the static resources, or to use the `--keep-generated` option.**

```
    bin/magento setup:upgrade
```

### Features

[](#features)

#### Scoped Maintenance

[](#scoped-maintenance)

The Scoped Maintenance module introduces the ability to enable maintenance mode for specific Magento stores, instead of forcing it globally across all stores. You can target individual stores or groups of store IDs to restrict access while ensuring other stores remain fully operational. This module add a `.maintenance.store` file to store the list of stores in maintenance.

#### IP Whitelisting

[](#ip-whitelisting)

While in maintenance mode, you can specify a list of IP addresses that will still have access to the stores under maintenance, bypassing the restrictions. This feature is useful for developers or a specific set of users who need to test or access the stores during downtime. The native ip whitelist of the maintenance is kept.

#### Automatic Cache Purging

[](#automatic-cache-purging)

When maintenance mode is activated or deactivated for specific stores, the module handles purging the full-page cache for the affected stores to ensure consistency and immediate effect of the maintenance status. A special cache tag `store_{$id}` is added to all pages to specify the store\_id and clean only the full page cache of specified stores.

---

Usage
-----

[](#usage)

### Enabling Maintenance for Specific Stores

[](#enabling-maintenance-for-specific-stores)

To enable maintenance mode for specific stores, use the built-in Magento CLI command provided by this module:

- **``**: A comma-separated list of store IDs for which maintenance mode should be enabled.
- **`--ip`**: (Optional) A comma-separated list of IP addresses that are allowed access to the stores during maintenance mode.

**Example:**

Enable maintenance mode for stores with IDs `1` and `2`, while allowing access to IPs `192.168.1.1` and `192.168.1.2`:

```
    bin/magento maintenance:enable-store 1,2 --ip=192.168.1.1,192.168.1.2
```

### Disabling Maintenance Mode

[](#disabling-maintenance-mode)

To disable maintenance mode for all stores, use Magento's standard maintenance disable command:

```
    bin/magento maintenance:disable
```

### Checking Store Maintenance Mode Status

[](#checking-store-maintenance-mode-status)

The module includes the ability to check whether maintenance mode is enabled for a specific store programmatically. You can use the `\Blackbird\ScopedMaintenance\Service\Maintenance` service for this purpose.

```
    bin/magento maintenance:status
```

---

Support
-------

[](#support)

- If you have any issue with this code, feel free to [open an issue](https://github.com/blackbird-agency/magento-2-scoped-maintenance/issues/new).
- If you want to contribute to this project, feel free to [create a pull request](https://github.com/blackbird-agency/magento-2-scoped-maintenance/compare).

---

Contact
-------

[](#contact)

For further information, contact us:

- by email:
- or by form: [https://black.bird.eu/en/contacts/](https://black.bird.eu/contacts/)

---

Authors
-------

[](#authors)

- **Blackbird Team** - *Maintainer* - [They're awesome!](https://github.com/blackbird-agency)

---

License
-------

[](#license)

This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details.

---

***That's all folks!***

###  Health Score

35

—

LowBetter than 77% of packages

Maintenance59

Moderate activity, may be stable

Popularity28

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity35

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% 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 ~125 days

Total

3

Last Release

261d ago

PHP version history (2 changes)1.0.0PHP 7.3

1.0.1PHP >=7.3

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/12445118?v=4)[anthony-blackbird](/maintainers/anthony-blackbird)[@anthony-blackbird](https://github.com/anthony-blackbird)

---

Top Contributors

[![bruno-blackbird](https://avatars.githubusercontent.com/u/77049160?v=4)](https://github.com/bruno-blackbird "bruno-blackbird (5 commits)")

### Embed Badge

![Health badge](/badges/blackbird-scoped-maintenance/health.svg)

```
[![Health](https://phpackages.com/badges/blackbird-scoped-maintenance/health.svg)](https://phpackages.com/packages/blackbird-scoped-maintenance)
```

###  Alternatives

[elgentos/regenerate-catalog-urls

Regenerate Catalog URL Rewrites (products, categories, cms pages)

2842.6M](/packages/elgentos-regenerate-catalog-urls)[nosto/module-nostotagging

Increase your conversion rate and average order value by delivering your customers personalized product recommendations throughout their shopping journey.

27703.7k4](/packages/nosto-module-nostotagging)[tig/postnl-magento2

TIG Magento 2 PostNL extension

59570.5k5](/packages/tig-postnl-magento2)[myparcelnl/magento

A Magento 2 module that creates MyParcel labels

1860.2k](/packages/myparcelnl-magento)[loki/magento2-components

Core module for defining Alpine.js components with advanced AJAX features

1011.8k26](/packages/loki-magento2-components)[zwernemann/module-withdrawal

Magento 2 EU Withdrawal Button Module - Adds a withdrawal/revocation button for orders in compliance with EU Directive (EU) 2023/2673

244.9k2](/packages/zwernemann-module-withdrawal)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)