Weave Code
Solr Laravel Package
ibexa/solr
Ibexa Solr search engine bundle for Ibexa DXP, providing the Solr search backend implementation. Includes unit and integration test setup instructions for contributors.
At a glance
Frequently asked questions about Solr
- Can I use ibexa/solr in a Laravel application?
- No. ibexa/solr is a Symfony bundle built for Ibexa DXP that implements the Ibexa search engine SPI against Apache Solr; it ships no Laravel service provider, no Laravel contracts, and no Eloquent or Query Builder bridge. Pulling it into a Laravel app would not give you a working search backend because its public API is expressed entirely in Ibexa domain objects such as Content, Location, and ContentType. For Solr full-text search in Laravel, look at Laravel Scout with a Solr driver, or Scout with Meilisearch, Typesense, or Algolia instead.
- What does the ibexa/solr package actually do?
- It is the official Solr search engine bundle for Ibexa DXP, replacing the database-backed search handler with Apache Solr queried over HTTP. It implements the Ibexa search API, including criterion and sort clause visitors, facet and aggregation builders, spellchecking, and dense-vector fields for semantic retrieval. The practical result is fast, scalable full-text search across large content repositories instead of slow database queries.
- How do I install and enable ibexa/solr?
- Run composer require ibexa/solr inside an existing Ibexa DXP installation, enable IbexaSolrBundle, and point the configuration at your Solr connection. You then create the required cores from the shipped configset and run a full reindex of the content repository. The only documented prerequisite is a working Ibexa DXP install, since the bundle is not designed to be used standalone.
- Which Ibexa DXP, PHP, and Symfony versions does ibexa/solr support?
- The supported stack is PHP 8.3 or newer, Symfony 6.4 or 7.x, and Ibexa DXP 4.6 LTS or 5.0, with the 4.6.x and 5.0.x release lines maintained in parallel. Because this is a first-party DXP component, your DXP upgrade and the bundle version must be coordinated deliberately. Pin the branch that matches your DXP version and track its published end of life.
- Which Apache Solr versions are supported?
- Recent releases target Apache Solr 9.8 and newer. Confirm the exact supported window for the bundle version you pin, and plan configset and schema changes alongside DXP minor upgrades. Older Solr releases are not validated by the maintainers.
- How do I configure Solr cores for a single-core or multi-core setup?
- Core setup is configurable, and the integration test suite demonstrates a single-core deployment via CORES_SETUP="single", while multi-core deployments are also supported. In production this means owning the configset and schema lifecycle, not just the connection string. Treat core creation, configset upgrades, and reindex windows as part of your deployment runbook.
- How do I run the unit and integration tests for this bundle?
- Unit tests run with php vendor/bin/phpunit --bootstrap tests/bootstrap.php after a composer install. Integration tests require ibexa/core plus a live Solr instance, and are typically run with export CORES_SETUP="single" followed by php -d memory_limit=-1 vendor/bin/phpunit --bootstrap tests/bootstrap.php -vc vendor/ibexa/core/phpunit-integration-legacy-solr.xml. Contributors are expected to keep both suites passing.
- What license does ibexa/solr use, and can I use it commercially?
- It is dual licensed under the Ibexa Business Use License v2.4, which is granted through a valid paid Ibexa DXP subscription, or GPLv2. GitHub reports the license as NOASSERTION, so commercial closed-source use is effectively subscription-gated and requires legal review. If you have no Ibexa subscription in place, verify your GPLv2 obligations before adopting it.
- How do I add custom criteria or sort clauses to the Solr search backend?
- Criterion and sort clause visitors are registered through a tagged iterator, which is the supported place to add custom query semantics for your own domain objects. You implement the visitor against Ibexa domain objects such as Content, Location, and ContentType rather than a generic query builder. This is an extension point inside an Ibexa bundle, not a general-purpose search abstraction you can reuse elsewhere.
- How should I handle reindexing and production operations with ibexa/solr?
- Adding Solr introduces a JVM tier plus configset and schema lifecycle management, so treat index rebuilds as planned maintenance with documented recovery expectations. The README does not describe a zero-downtime dual-core swap procedure, so confirm the supported reindex path with the vendor before promising one. HTTP client timeout and retry counts are configurable, which helps absorb transient Solr outages during normal operation.
Weaver
How can I help you explore Laravel packages today?