tamayo/laravel-scout-elastic

Elastic Driver for Laravel Scout

Laravel Scout Elasticsearch Driver

, _(*1)

Archived

I haven't had the time to dedicate work to this repo and I don't plan to do so in the future., _(*2)

This package provides a Elasticsearch driver for Laravel Scout., _(*3)

Contents

• Installation
• Usage
• Credits
• License

Installation

You can install the package via composer:, _(*4)

composer require tamayo/laravel-scout-elastic

Laravel will automatically register the driver service provider., _(*5)

Install elasticsearch-php client

For use this library we recomend using the latest version at this time (^7.9), _(*6)

composer require elasticsearch/elasticsearch

Setting up Elasticsearch configuration

After you've published the Laravel Scout package configuration, you need to set your driver to elasticsearch and add its configuration:, _(*7)

// config/scout.php
...
    // Set your driver to elasticsearch
    'driver' => env('SCOUT_DRIVER', 'elasticsearch'),
...
    /*
    |--------------------------------------------------------------------------
    | Elasticsearch Configuration
    |--------------------------------------------------------------------------
    |
    | Here you may configure your Elasticsearch settings.
    |
    */
    'elasticsearch' => [
        'hosts' => [
            env('ELASTICSEARCH_HOST', 'localhost'),
            // [
            //     'host'   => env('ELASTICSEARCH_HOST', 'localhost'),
            //     'port'   => env('ELASTICSEARCH_PORT', '9200'),
            //     'scheme' => env('ELASTICSEARCH_SCHEME', 'https'),
            //     'path'   => env('ELASTICSEARCH_PATH', '/elastic'),
            //     'user'   => env('ELASTICSEARCH_USER', 'username'),
            //     'pass'   => env('ELASTICSEARCH_PASS', 'password'),
            // ]
        ],
    ]
...

For host configuration you can refer to the official Elasticsearch documentation, _(*8)

Usage

Now you can use Laravel Scout as described in the Laravel Scout official documentation, _(*9)

Limitations

Identifying Users Currrently user identification is not supported., _(*10)

Credits

• Erick Tamayo
• All Contributors

License

The MIT License (MIT)., _(*11)