magenizr/oc-envbar

This October CMS plugin allows you to differentiate between environments by adding a custom colored bar above the top navigation.

Fund package maintenance!
Patreon

Installs: 6

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 2

Forks: 2

Open Issues: 1

Type:october-plugin

1.0.6 2024-03-01 11:00 UTC

This package is auto-updated.

Last update: 2024-10-30 12:35:53 UTC


README

This October CMS plugin allows you to differentiate between environments by adding a custom colored bar above the top navigation.

October Envbar - Intro

System Requirements

  • October CMS 1.x, 2.x, 3.x
  • PHP 7.x, 8.x

Installation

Backend

The plugin can be installed via backend as follows.

Go to Settings > System > Updates & Plugins and search for the plugin. Click on Install Plugins and search for envbar.

Artisan

Alternatively the plugin can be installed via CLI by using the command plugin:install.

php artisan plugin:install Magenizr.Envbar
php artisan cache:clear

Manually

  1. Download the code.
  2. Extract the downloaded tar.gz file. Example: tar -xzf October_Envbar_1.0.5.tar.gz.
  3. Copy the code into ./plugins/magenizr/envbar/.

Configuration

Make sure the name of the environment ( e.g development ) matches the value of the variable APP_ENV or default in ./config/environment.php or in your .env file.

Features

  • Enable or disable plugin temporarily.
  • Enable plugin for Superusers only.
  • Add multiple environments and choose the color of the bar.
  • Automatically clear cached styles ( colors ) after saving settings or if .env file has been updated.

Usage

Simply navigate to Settings > System > Envbar and enable the plugin. Update colors within the Environments section if required.

Support

If you experience any issues, don't hesitate to open an issue on Github.

Contact

Follow us on GitHub, Twitter and Facebook.

History

===== 1.0.6 =====

  • Fix member function isSuperUser() on null

===== 1.0.5 =====

  • October CMS 3.0 compatibility

===== 1.0.4 =====

  • Create temp folder if not exists. Thx @jan-vince

===== 1.0.3 =====

  • Automatically clear cached styles ( colors ) if .env file has been updated. Thx @kavishdahekar

===== 1.0.2 =====

  • Move compiled CSS file from ./storage/temp to ./storage/temp/public. Thx @jan-vince

===== 1.0.1 =====

  • Fallback for APP_ENV variable.
  • Compile CSS again if ./storage/temp has been cleared.

===== 1.0.0 =====

  • First release

License

MIT License