signify-nz/silverstripe-environmentindicator

Vendor module to add an environment indicator in the CMS as well as information bar for the front-end.

1.0.0 2020-05-26 00:29 UTC

This package is not auto-updated.

Last update: 2020-08-06 05:01:01 UTC


README

Build Status Scrutinizer Code Quality

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

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.

Usage

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

Live Published Anonymous Live Published Editor Live Draft Editor Live CMS Page Live CMS Tree

Test Published Anonymous Test Published Editor Test Draft Editor Test CMS Page Test CMS Tree

Dev Published Anonymous Dev Published Editor Dev Draft Editor Dev CMS Page Dev CMS Tree