README

Displays Forge Servers and Recent Events.

This tile can be used on the Laravel Dashboard.

Installation

You can install the package via composer:

composer require aglipanci/laravel-dashboard-forge-tile

Usage

In the dashboard config file, you must add this configuration in the tiles key.

// in config/dashboard.php

return [
    // ...
    'tiles' => [
         'forge' => [
              'token' => env('FORGE_API_TOKEN'),
              'servers' => [
                   'refresh_interval_in_seconds' => 3600
               ],
              'recent_events' => [
                    'refresh_interval_in_seconds' => 60
              ],
         ],
    ],
];

In app\Console\Kernel.php you should schedule the below to run every x minutes. Only add the commands where you have configured the related tiles above.

// in app/console/Kernel.php

protected function schedule(Schedule $schedule)
{
    $schedule->command(\aglipanci\ForgeTile\Commands\FetchForgeServersCommand::class)->hourly();
    $schedule->command(\aglipanci\ForgeTile\Commands\FetchForgeRecentEventsCommand::class)->everyMinute();
}

In your dashboard view you can use the livewire:forge-server-tile and livewire:forge-recent-events-tile component.

<x-dashboard>
    <livewire:forge-server-tile position="a1"/>
    <livewire:forge-recent-events-tile position="b1"/>
    ...
</x-dashboard>

Customizing the view

If you want to customize the view used to render this tile, run this command:

php artisan vendor:publish --provider="aglipanci\ForgeTile\ForgeTileServiceProvider" --tag="dashboard-forge-tile-views"

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email agli.panci@gmail.com instead of using the issue tracker.

Credits

All Contributors

License

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

aglipanci / laravel-dashboard-forge-tile

Maintainers

Details