arabicsooq/filament-env-editor

Access .env file though Filament admin panel

v1.2 2025-03-08 11:58 UTC

This package is not auto-updated.

Last update: 2025-05-04 10:49:54 UTC


README

Latest Version on Packagist Total Downloads

Banner

A Simple .env file Viewer plugin for your Filament Panels.

Provides features like, manage current .env variables, and a handy backup functionality page


Important Notice: Original Author and Laravel 12 Support

This repository is a modified version of GeoSot/filament-env-editor with adjustments to support Laravel 12. The original author of the package is GeoSot.

These modifications have been made to ensure compatibility with the latest Laravel releases, enabling users to leverage this valuable tool in their Laravel 12 environments.


Installation

You can install the package via composer:

composer require arabicsooq/filament-env-editor

Usage

Add the ArabicSooq\FilamentEnvEditor\FilamentEnvEditorPlugin to your panel config.

use ArabicSooq\FilamentEnvEditor\FilamentEnvEditorPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // ...
            ->plugin(
                FilamentEnvEditorPlugin::make()
            );
    }
}

Configuration

Customizing the navigation item

FilamentEnvEditorPlugin::make()
    ->navigationGroup('System Tools')
    ->navigationLabel('My Env')
    ->navigationIcon('heroicon-o-cog-8-tooth')
    ->navigationSort(1)
    ->slug('env-editor')

Hiding keys

Some keys you may consider to be particularly sensitive and don't wish to expose them, even through this package. You can hide them through this interface:

FilamentEnvEditorPlugin::make()
    ->hideKeys('APP_KEY', 'BCRYPT_ROUNDS')

Authorization

If you would like to prevent certain users from accessing the logs page, you should add a authorize callback in the FilamentLEnvEditorPlugin chain.

FilamentEnvEditorPlugin::make()
  ->authorize(
      fn () => auth()->user()->isAdmin()
  )

Customizing the log page

To customize the "env-editor" page, you can extend the ArabicSooq\FilamentEnvEditor\Pages\ViewEnv page and override its methods.

use ArabicSooq\FilamentEnvEditor\Pages\ViewEnv as BaseViewEnvEditor;

class ViewEnv extends BaseViewEnvEditor
{
    // Your implementation
}
use App\Filament\Pages\ViewEnv;

FilamentEnvEditorPlugin::make()
  ->viewPage(CustomEnvPage::class)

Contributing

Please see CONTRIBUTING for details.

License

The MIT License (MIT). Please see License File for more information.