README

Environment Indicator

The Environment Indicator Vendor Module reads the SS_ENVIRONMENT_TYPE variable in your .env file (dev, test or live) and loads the applicable javascript to insert a custom div above the menu header in the CMS Admin interface.

The EnvBarExtension also inserts a custom element into the HTML of all pages to provide an information bar detailing the environment and page version. If the logged-in user has access to pages in the CMS, the bar acts as a link to open the page in the CMS via a new browser tab.

The bar does not appear in live mode for unauthorised users.

Requirements

• SilverStripe CMS ^4 OR SilverStripe CMS ^5

Installation

Composer:

    composer require signify-nz/silverstripe-environmentindicator

Documentation

No further configuration is required.

Customisation can be achieved by editing the EnvBar.ss template or the envbar- .js and .css files. Functional tests are available in the tests directory. These will need to be updated if you modify the template.

• Changelog
• Contributing
• Issues
• License

Usage

This module performs an informative function only. No special usage instructions are available.