faithcatholic/custom_solr

Provides custom Solr search with configs and styles.

1.0.3 2025-06-25 21:47 UTC

Requires

• php: ^8.0
• drupal/better_exposed_filters: ^6.0
• drupal/core: ^9.2 || ^10
• drupal/facets: ^3.0
• drupal/search_api: ^1.3
• drupal/search_api_solr: ^4.3
• drupal/search_api_solr_admin: ^4.3
• faithcatholic/diocesan_directory: ^2.0

GPL-2.0-or-later

README

Todo: This document will be completed after the first round of initial testing, client review, and following iterations.

This custom module installs a Solr search feature on diocesan websites that combines a selection of contributed modules and a small amount of custom code. This module establishes baseline functionality that can be extended for other sites.

Installation

Run $ composer require faithcatholic/custom_solr on the command line to pull the latest version of the module. Before installing the module, be sure to install all dependencies, which include a selection of search_api* modules, better_exposed_filters, facets, and block_class.

Setup

Navigate to Admin > Configuration > Search and metadata > Search API and edit the top-level server configuration named "SOLR". Make sure the server is enabled, and for Platform.sh sites, select the "Standard" Solr Connector and keep the default settings.

Next, edit the Default index and verify that "SOLR" is selected under the Server section. Keep default settings unless you know what you are doing.

Customization of functionality

You can add additional searchable fields using the "Fields" tab on the Default index settings page. When adding or editing fields, you can set the importance of each individual field using the "Boost" setting.

You can also add additional processing via the "Processors" tab located to the right of the Fields tab. Leave default-enabled processors as-is unless you know what you are doing. Toward the bottom of the Processors page is are boost fields that apply to entity as a whole. Processor boosts take precedence before field boosts; both types of boosts apply but processor boosts have a greater effect on overall sorting.

New filters and sorts can be added to the results page by editing the "Search Results" view. Be careful to nest appropriate fields under the appropriate entity-specific filter groups, with the exception of facet filters that display above the grouped filters.

Customization of styles

Stylesheet updates should be made using the *.scss files in the sass directory, and not in the dist directory.

Similarly, javascript updates should be made in the js directory.

You can run preprocessing by running $ npm run development or via gulp $ gulp (to use gulp, you must be able to run the command, which is installed from gulp_cli in package.json).