README

A developer-friendly Laravel Scout driver for Elasticsearch — built for distributed, scalable, and clean search experiences.
Crafted with ❤️ by the Abrbit team.

🚀 Features

✅ Plug-and-play with Laravel Scout
✅ Uses official Elasticsearch REST API
✅ Auto-maps documents & IDs for distributed clusters
✅ Supports multi-field search (e.g., title + description)
✅ Fully configurable via config/services.php
✅ Developer-friendly syntax — clean and minimal

📦 Installation

composer require abrbit/laravel-scout-elasticsearch

Then register your search service endpoint and credentials in .env:

SEARCH_URL=https://search.services.abrbit.com
SEARCH_TOKEN=your-api-token

⚙️ Configuration

In your config/scout.php, set the driver to abrbit:

'driver' => 'abrbit',

And in config/services.php, add:

'search' => [
    'url' => env('SEARCH_URL', 'https://example.com'),
    'token' => env('SEARCH_TOKEN'),
],

🧩 Usage

You can use Laravel Scout’s native methods directly:

use App\Models\Song;

// Search across title & description fields
$songs = Song::search('شام')->get();

// Paginate results
$songs = Song::search('عشق')->paginate(20);

Your Eloquent model only needs to implement the Searchable trait:

use Laravel\Scout\Searchable;
use Illuminate\Database\Eloquent\Model;

class Song extends Model
{
    use Searchable;

    protected $fillable = ['title', 'description'];

    protected $searchableFields = ['name', 'description'];

    public function getSearchableFields(): array
    {
        return $this->searchableFields ?? ['id'];
    }

    public function toSearchableArray()
    {
        return [
            'id' => $this->getKey(),
            'title' => $this->title,
            'description' => $this->description,
        ];
    }
}

🔍 Example Query

Here’s what an example query looks like under the hood:

{
  "from": 0,
  "size": 20,
  "query": {
    "multi_match": {
      "fields": ["title", "description"],
      "query": "شام"
    }
  }
}

🧠 How It Works

AbrbitSearchEngine is a custom Laravel Scout engine that:

Sends search requests to your Elasticsearch instance.
Handles _id assignment automatically by Elasticsearch.
Supports distributed, multi-tenant indexes like tenant_songs or user_posts.
Maps _source data back into Eloquent models seamlessly.

Example search response:

{
  "id": "Swv5oJkBk5ZOaUeK3x_O",
  "title": "شام غریبان",
  "description": "نوحه زیبای حاج محمود کریمی",
  "score": 6.6
}

🧰 Developer Notes

Designed for SaaS and multi-tenant applications.
Compatible with any REST-compatible Elasticsearch cluster (v8+ recommended).
Works perfectly with Laravel Scout’s indexing pipeline.

🧑‍💻 Contributing

We welcome contributions!
Feel free to open issues or submit pull requests.

⚖️ License

Released under the MIT License.

🌐 About Abrbit

Abrbit provides modern cloud infrastructure and SaaS services —
from DNS & mail hosting to AI, storage, and classroom platforms.

💡 Visit us at abrbit.com

abrbit / laravel-scout-elasticsearch

Maintainers

Details