geo-sot/filament-env-editor

Access .env file though Filament admin panel

0.0.2 2024-04-15 21:20 UTC

This package is auto-updated.

Last update: 2024-04-24 14:25:37 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


Installation

You can install the package via composer:

composer require geo-sot/filament-env-editor

Usage

Add the GeoSot\FilamentEnvEditor\FilamentLEnvEditorPlugin to your panel config.

use GeoSot\FilamentEnvEditor\FilamentEnvEditorPlugin;

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

Configuration

Customizing the navigation item

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

Authorization

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

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

Customizing the log page

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

use GeoSot\FilamentEnvEditor\Pages\ViewEnv as BaseViewEnvEditor;

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

FilamentLEnvEditorPlugin::make()
  ->viewLog(ViewEnv::class)

Contributing

Please see CONTRIBUTING for details.

License

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