PHPackages                             jainilnagar/env-beacon - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. jainilnagar/env-beacon

ActiveCraft-plugin[Utility & Helpers](/categories/utility)

jainilnagar/env-beacon
======================

A lightweight Craft CMS 4 and 5 plugin that displays a clear environment badge in the control panel and frontend.

1.0.0(1w ago)018↓100%MITPHPPHP ^8.0.2

Since May 31Pushed 1w agoCompare

[ Source](https://github.com/jainilnagar/craft-env-beacon)[ Packagist](https://packagist.org/packages/jainilnagar/env-beacon)[ RSS](/packages/jainilnagar-env-beacon/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (1)Dependencies (3)Versions (2)Used By (0)

[![Env Beacon icon](src/icon.svg)](src/icon.svg)

Env Beacon for Craft CMS
========================

[](#env-beacon-for-craft-cms)

Env Beacon is a lightweight Craft CMS plugin that displays a small environment badge in the Craft control panel and, optionally, on the front-end site.

Use it to make the current environment obvious to editors, admins, and developers:

- Local
- Development
- Staging
- QA
- Production

It is intentionally simple: no database tables, no queues, no external services, and no JavaScript dependency.

Features
--------

[](#features)

- Control panel badge for the current environment
- Optional front-end site badge
- Fixed bottom-right badge position
- Automatic label detection from common environment variables
- Custom environment variable mode
- Custom label mode
- Automatic colors:
    - Production / Live → red
    - Staging / Test / QA → amber
    - Local / Dev / DDEV → blue
- Custom hex color support
- Optional status dot
- Optional hostname display
- Optional admin-only visibility
- Optional login-screen visibility
- Supports project config and `config/env-beacon.php` overrides

Requirements
------------

[](#requirements)

- Craft CMS 4.x or 5.x
- PHP 8.0.2 or later

Installation
------------

[](#installation)

You can install Env Beacon via the plugin store, or through Composer.

### Composer

[](#composer)

You can also add the package to your project using Composer and the command line.

1. Open your terminal and go to your Craft project:

    ```
     cd /path/to/project

    ```
2. Then tell Composer to require the plugin, and Craft to install it:

    ```
     composer require jainilnagar/env-beacon && php craft plugin/install env-beacon

    ```

### Craft Plugin Store

[](#craft-plugin-store)

To install Env Beacon, navigate to the Plugin Store section of your Craft control panel, search for Env Beacon.

Configuration
-------------

[](#configuration)

You can configure Env Beacon from:

```
Settings → Plugins → Env Beacon

```

You can also override settings per environment in:

```
config/env-beacon.php

```

Example:

```