basilicom / pimcore-plugin-system-banner
Shows a banner of the pimcore environment, to indicate if you are on prod or dev or else.
Package info
github.com/basilicom/pimcore-plugin-system-banner
Language:TypeScript
Type:pimcore-bundle
pkg:composer/basilicom/pimcore-plugin-system-banner
Requires
- php: >=8.1
- pimcore/pimcore: ^11.0 || ^12.0 || ^2026.1
Requires (Dev)
None
Suggests
- pimcore/studio-ui-bundle: Required to show the banner in the Pimcore Studio UI (^2025.4 on Pimcore 12, ^2026.1 on Pimcore 2026)
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-09-15 05:28:57 UTC
README
This plugin will show a banner on the top right with the environment name, coloured by APP_ENV:
APP_ENV |
Colour |
|---|---|
dev, development |
🟢 |
test, testing |
🟣 |
stage, staging |
🟡 |
prod, production |
🔴 |
| anything else | ⚪ |
Classic UI
Studio UI
The environment is read from the APP_ENV variable.
Version information
| Bundle Version | PHP | Pimcore | Classic UI | Studio UI |
|---|---|---|---|---|
| < 2.0 | ^7.3 | ^6.0 | ✓ | |
| >= 2.0 | ^8.0 | ^10.0 | ✓ | |
| >= 3.0 | ^8.1 | ^11.0 | ✓ | |
| >= 4.0 | ^8.3 | ^12.0 | ✓ | |
| >= 5.0 | ^8.1 | ^11.0, ^12.0, ^2026.1 | ✓ | ✓ |
Both UIs are detected at runtime, no configuration needed:
- Classic UI assets are registered through the Pimcore bundle manager events, so they only load where
pimcore/admin-ui-classic-bundleis present. Pimcore 2026 dropped the classic UI. - The Studio UI plugin is only registered when
pimcore/studio-ui-bundleis installed (^2025.4on Pimcore 12,^2026.1on Pimcore 2026). It is built against Studio 2026.2.
Installation
composer require basilicom/pimcore-plugin-system-banner
Activate Plugin
- Add to config/bundles.php
return [
...
PimcorePluginSystemBannerBundle::class => ['all' => true],
];
or
- Activate in the Pimcore backend in Tools -> Bundles & Bricks
Install assets
for Pimcore >= 10
bin/console assets:install public --symlink --relative
for lower than Pimcore X respectively lower than Symfony 5
bin/console assets:install web --symlink --relative
Customize the env name and color
You can customize the display of the name in the .env file (or .env.local); by default, it uses the APP_ENV. Use the following variable:
SYSTEM_BANNER_TEXT="My env name"
To customize the colour, you can use the following variable:
SYSTEM_BANNER_COLOR="#ff0000"
It accepts a three or six digit hex value, or one of 🟢 🟡 🔴 🟣 🔵.
Anything else is ignored and the APP_ENV colour from the table above is used.

