README

laravel-scout-opensearch

Laravel Scout custom engine for OpenSearch

Requirements

Requires PHP 8.5+

Installation

composer require cline/laravel-scout-opensearch

Documentation

• Getting Started - Installation and Scout setup
• Configuration - OpenSearch client and Scout options
• Basic Usage - Search, filters, sorting, and callbacks
• Query Behavior - How Scout queries map to OpenSearch
• Testing - Local and CI verification commands
• Troubleshooting - Common cluster and indexing issues

Usage

use App\Models\Product;

$results = Product::search('headphones')
    ->where('is_active', true)
    ->orderBy('id', 'desc')
    ->get();

Change log

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

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please use the GitHub security reporting form rather than the issue queue.

Credits

• Brian Faust
• All Contributors

License

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