Skip to content

This plugin will show a banner on the top right with the environment name.

License

Notifications You must be signed in to change notification settings

basilicom/pimcore-plugin-system-banner

Repository files navigation

Pimcore Plugin System Banner

This plugin will show a banner on the top right with the environment name.

  • development environments = green
  • test environments = purple
  • stage environments = yellow
  • prod environments = red

Environment dev

it is used the .env variable APP_ENV.

Version information

Bundle Version PHP Pimcore
< 2.0 ^7.3 ^6.0
>= 2.0 ^8.0 ^10.0
>= 3.0 ^8.1 ^11.0

Installation

composer require basilicom/pimcore-plugin-system-banner

Activate Plugin

  • Add to \App\Kernel.php
public function registerBundlesToCollection(BundleCollection $collection)
{
    // ...
    $collection->addBundle(new PimcorePluginSystemBannerBundle());
    // ...
}

or

  • Activate in the Pimcore backend in Tools -> Bundles & Bricks

Build 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). Use the following variable:

SYSTEM_BANNER_TEXT="My env name"

To customize the color, you can use the following variable:

SYSTEM_BANNER_COLOR=purple

you can choose between:

  • green
  • yellow
  • red
  • purple
  • blue