blackbird/module-environment-banner

Magento 2 extension. Tell at a glance if you are in a production, staging or dev environment - visual banners on frontend and admin

1.0.1 2024-03-21 16:53 UTC

Requires

• php: ~5.5.0|~5.6.0|>7|>8
• magento/framework: *
• magento/magento-composer-installer: *

MIT

README

Magento 2 extension that provides a quick visual indication of the environment (production, staging, or development) you are currently in, with banners displayed on both the frontend and admin areas.

Why choose this extension?

This module offers a convenient solution for teams working on Magento projects to easily identify the environment they are working in, helping to prevent any accidental changes or actions in production environments. With clear banners displayed prominently, developers, testers, and administrators can confidently navigate through different environments without confusion.

Features

• Visual banners displayed on frontend and admin areas.
• Clearly distinguish between production, staging, and development environments.
• Easy setup and configuration.

Installation

1. Install via Composer

composer require blackbird/module-environment-banner

1. Enable the module

php bin/magento setup:upgrade

1. Configure the extension in the Magento admin panel under Stores > Configuration > Advanced > Environment Banner. Fill the environment mapping.

2. Add the environment to the app/etc/env.php file. The value should match one from the mapping.

[
    'system' => [
        'default' => [
            'environment' => 'development',
        ],
    ],
];

About this fork

This extension is a fork of the original c3limited/magento2-environment-banner module. While the original module provided valuable functionality, it had limitations such as compatibility only with Apache servers and absence from Packagist. In our fork, we have addressed these limitations and made enhancements for broader compatibility, including support for Nginx and other web servers.

Notably, instead of relying on server configuration, as in the original module, our fork utilizes the env.php file for environment configuration, offering greater flexibility and ease of use.