Download the PHP package blackbird/scoped-maintenance without Composer

On this page you can find all versions of the php package blackbird/scoped-maintenance. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package scoped-maintenance

Blackbird Scoped Maintenance

Latest Stable Version

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:

The source code is available at the GitHub repository.


Setup

Get the Package

Zip Package:

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

Composer Package:

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.

Features

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

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

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

Enabling Maintenance for Specific Stores

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

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:

Disabling Maintenance Mode

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

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.


Support


Contact

For further information, contact us:


Authors


License

This project is licensed under the MIT License - see the LICENSE file for details.


That's all folks!


All versions of scoped-maintenance with dependencies

PHP Build Version
Package Version
Requires php Version >=7.3
magento/framework Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package blackbird/scoped-maintenance contains the following files

Loading the files please wait ....