tris-nm/laravel-scout-opensearch-engine

Custom Laravel Scout OpenSearch Engine

dev-main 2022-06-23 11:10 UTC

Requires

• php: >=8.0
• laravel/framework: ^8.0.0
• laravel/scout: ^8.0

MIT

• NMTri

• search
• laravel
• opensearch
• scout
• aws opensearch

README

Installation

composer require tris-nm/laravel-scout-opensearch-engine

Update your App\Providers\AppServiceProvider

<?php

namespace App\Providers;

// ...

use Trisnm\LaravelScoutOpenSearchEngine\OpenSearchEngine;
use Laravel\Scout\EngineManager;

class AppServiceProvider extends ServiceProvider
{
    public function boot()
    {
        // ...

        resolve(EngineManager::class)->extend(config('scout.driver'), function () {
            return new OpenSearchEngine;
        });

    }
}

Update config\scout.php

<?php

return [
    //
    'driver' => env('SCOUT_DRIVER', 'opensearch'),

    'opensearch' => [
        'host' => env('OPENSEACH_HOST', 'http://localhost:9200'),
        'user' => env('OPENSEACH_USER', 'admin'),
        'pass' => env('OPENSEACH_PASS', 'admin'),
        // Set value of basic auth is `false` incase aws Opensearch cluster use Access policy for security configuration
        'basic_auth' => env('OPENSEACH_BASIC_AUTH', true),
    ],
    //
];

Usage

Learn more about Laravel Scout