README

This is a package that brings the Ploi dashboard to Filament admin panel. Provide the server id and the id of the site you wish to manage and unlock the Ploi features straight in your Filament admin panel.

Installation

You can install the package via composer:

composer require lartisan/ploi-dashboard

You can publish the config file with:

php artisan vendor:publish --tag="ploi-dashboard-config"

This is the contents of the published config file:

return [
    'server_id' => env('PLOI_SERVER_ID'),

    'website_id' => env('PLOI_WEBSITE_ID'),

    'services' => [
        'api_url' => env('PLOI_API_URL', 'https://ploi.io/api'),
        'api_key' => env('PLOI_API_KEY'),
    ],

    'polling' => [
        'interval' => env('PLOI_POLLING_INTERVAL', '10s'),
    ],
];

Usage

Add the plugin to you Panel Provide, example:

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            ...
            ->plugins([
                new \Lartisan\PloiDashboard\PloiDashboardPlugin,
            ])
        ;
    }
}

and provide the necessary environment variables in your .env file:

PLOI_API_KEY=your-api-key
PLOI_SERVER_ID=your-server-id
PLOI_WEBSITE_ID=your-website-id

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

lartisan / ploi-dashboard

Maintainers

Details