README

A tile for Laravel Dashboard that displays statistics from Pi-hole

Install

Via Composer

$ composer require owenvoke/laravel-dashboard-pihole-tile

Usage

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

// in config/dashboard.php

return [
    // ...
    'tiles' => [
        'pihole' => [
            'url' => env('PIHOLE_URL'),
            'key' => env('PIHOLE_KEY'),
        ],
    ],
];

In app\Console\Kernel.php you should schedule the \OwenVoke\PiholeTile\Commands\FetchPiholeSummaryCommand to run every 10 minutes.

If you want to use the "Top items" tile, you should schedule the \OwenVoke\PiholeTile\Commands\FetchPiholeTopItemsCommand to run every x minutes.

// in app/console/Kernel.php

protected function schedule(Schedule $schedule)
{
    $schedule->command(\OwenVoke\PiholeTile\Commands\FetchPiholeSummaryCommand::class)->everyTenMinutes();

    // Required for the "Top items" tile
    $schedule->command(\OwenVoke\PiholeTile\Commands\FetchPiholeTopItemsCommand::class)->everyTenMinutes();
}

In your dashboard view you use the livewire:pihole-summary-tile component.

<x-dashboard>
    <livewire:pihole-summary-tile position="a1" />

    <!-- This package also provides a "Top items" tile -->
    <livewire:pihole-top-items-tile position="b1" />
</x-dashboard>

Change log

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

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.

Credits

License

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

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here.

Read more about Treeware at treeware.earth.

owenvoke / laravel-dashboard-pihole-tile

Maintainers

Details