README

Displays a configurable visual environment indicator on every admin page to identify the current hostname.

Overview

Sjmb_EnvironmentInfo injects a small UI element into the Magento 2 admin panel so developers and administrators can immediately identify which environment (staging, production, local) they are working in. The indicator is driven entirely by system configuration: it can be globally disabled, always enabled, or restricted to a list of specific hostnames. Three visual styles are available — a top bar, a corner badge, and a dismissible alert — each rendered via a dedicated template.

Requirements

• Magento 2.4.x or higher
• PHP 8.3 or higher
• No external module dependencies declared

Installation

Composer installation

Run command to install module:

composer require --dev sjmb/module-environment-info

Manual installation

Download module and place in directory <magento-root>/app/code/Sjmb/EnvironmentInfo

Enable the module

php bin/magento module:enable Sjmb_EnvironmentInfo
php bin/magento setup:upgrade
php bin/magento cache:flush

Configuration

CLI

To enable display info can use CLI command:

php bin/magento config:set sjmb_env_info/general/mode 1

To save config to app/etc/env.php can add flag --lock-env:

php bin/magento config:set sjmb_env_info/general/mode 1 --lock-env

env.php

To enable display by app/etc/env.php can add bellow code:

...
'system' => [
    'default' => [
        'sjmb_env_info' => [
            'general' => [
                'mode' => '1'
            ]
        ]
    ]
]
...

Admin panel

Navigate to Stores > Configuration > SJMB > Environment Info > General Settings.

Display Mode values

Display Type values

Features

• Admin system configuration section under Stores > Configuration > SJMB > Environment Info.
• Three display modes: Disabled, Enabled, and Selected Domains.
• Three visual indicator styles: topbar, corner badge, dismissible alert.
• Selected Domains mode performs an exact HTTP_HOST match against a JSON-serialized list of domain rows configured via a dynamic-rows UI field.

Usage

Enable with topbar on all pages

1. Go to Stores > Configuration > SJMB > Environment Info.
2. Set Display Mode to Enabled.
3. Set Display Type to Topbar.
4. Save configuration and flush cache.

Restrict to specific environments by hostname

1. Set Display Mode to Selected Domains.
2. In the Allowed Domains grid, add one row per hostname (e.g. staging.example.com).
3. Set Display Type to the desired style.
4. Save configuration and flush cache.

The indicator will appear only when the admin is accessed from a matching hostname.

Info

• GIT repository: https://github.com/sjmb/environment-info

Copyright (c) 2026 SJMB · Code in 🐻‍❄️ in 🇵🇱