Docs/Integrations

Our Laravel Nova tool

Nova is first party Laravel package that makes it easy to add an admin section to your Laravel application.

Our nova-ohdear-tool package contains a tool that will display all check results of an Oh Dear monitored website.

Here's what it looks like in action.

ohdear tool index ohdear tool uptime

Install the Nova tool

You can install the package in a Laravel application that uses Nova via composer:

composer require ohdearapp/nova-ohdear-tool

Next up, you must register the tool with Nova. This is typically done in the register method of the NovaServiceProvider.

// in app/Providers/NovaServiceProvder.php

// ...

public function register()
{
    Nova::tools([
        // ...
        new \OhDear\OhDearTool\OhDearTool(),
    ]);
}

Afterwards you must publish the config file:

php artisan vendor:publish --provider="OhDear\OhDearTool\OhDearToolServiceProvider"

This is the content of the published config file config/nova-ohdear-tool.php.

return [
    /*
     * A valid API token for your Oh Dear account. Instructions on how to get a
     * token can be found on this page: https://ohdear.app/docs/api/authentication
     */
    'api_token' => env('OH_DEAR_API_TOKEN'),

    /*
     * The id of the site you want to display in the tool.
     * You can get the id of the site on the settings screen of a site on Oh Dear
     */
    'site_id' => env('OH_DEAR_SITE_ID'),
];

These values can be stored in your .env environment file.

OH_DEAR_API_TOKEN=
OH_DEAR_SITE_ID=

If you cache your configuration files, don't forget to renew your cache with php artisan config:cache.

Using the Nova tool

After the installation you can find an "Oh Dear" menu item in your Nova app to see the broken links and mixed content of your site.

Was this page helpful?

Feel free to reach out via [email protected] or on Twitter via @OhDearApp if you have any other questions. We'd love to help!