dzv3r0/laravel-scout-aws-elastic

There is no license information available for the latest version (3.0.5) of this package.

Elastic Driver for Laravel Scout

3.0.5 2017-08-31 15:43 UTC

Requires

• php: >=5.6.4
• elasticsearch/elasticsearch: ^5.0
• jsq/amazon-es-php: ^0.2.0
• laravel/scout: ^3.0

Requires (Dev)

• fzaninotto/faker: ~1.4
• mockery/mockery: 0.9.*
• phpunit/phpunit: ~5.0

Suggests

• elasticsearch/elasticsearch: Required to use the Elasticsearch engine (^5.0).

Unknown License

• elasticsearch
• laravel
• elastic
• scout

README

This package makes is the Elasticsearch driver for Laravel Scout with AWS support.

Contents

• Installation
• Usage
• Credits
• License

Installation

You can install the package via composer:

composer require dzv3r0/laravel-scout-aws-elastic

You must add the Scout service provider and the package service provider in your app.php config:

// config/app.php
'providers' => [
    ...
    Laravel\Scout\ScoutServiceProvider::class,
    ...
    ScoutEngines\Elasticsearch\ElasticsearchProvider::class,
],

Setting up Elasticsearch configuration

You must have a Elasticsearch server up and running with the index you want to use created

If you need help with this please refer to the Elasticsearch documentation

If you want to use AWS Elasticsearh make sure you have setup the credentials

AWS_KEY=
AWS_SECRET=
AWS_REGION=

and set

ELASTICSERACH_DRIVER=aws

After you've published the Laravel Scout package configuration:

// config/scout.php
// Set your driver to elasticsearch
    'driver' => env('SCOUT_DRIVER', 'elasticsearch'),

...
    'elasticsearch' => [
        'index' => env('ELASTICSEARCH_INDEX', 'laravel'),
        'hosts' => [
            env('ELASTICSEARCH_HOST', 'http://localhost'),
        ],
    ],
...

Usage

Now you can use Laravel Scout as described in the official documentation

Credits

• Erick Tamayo
• All Contributors

License

The MIT License (MIT).