This module is meant to simplify the usage of Search API and Search API Solr on Pantheon. Search API Solr provides the ability to connect to any Solr server by providing numerous configuration options. This module automatically sets the Solr connection options by extending the plugin from Search API Solr. The module also changes the connection information between Pantheon environments. Doing so eliminates the need to do extra work setting up Solr servers for each environment.
Composer is the best way to install this module because this module relies on Solarium. Solarium is a Solr client library for PHP and is not Drupal-specific. First, register Drupal.org as a provider of Composer packages. This command should be run locally from the root directory of your Drupal 8 git repository.
composer config repositories.drupal composer https://packages.drupal.org/8
Next, require this module.
composer require "drupal/search_api_pantheon ~1.0" --prefer-dist
You should now have this module along with Search API, Search API Solr, and Solarium. Commit the changes and push your repository to Pantheon. Be sure not to commit search_api_pantheon as a git submodule. One way to do that is by removing the .git repository that may have come with it through Composer.
rm -r modules/search_api_pantheon/.git
See the Drupal.org for complete documentation on Search API. To configure the connection with Pantheon, do the following steps on your Dev environment (or a Multidev):
- Enable Solr on your Pantheon site
- Under "Settings" in your Pantheon site dashboard, enable Solr as an add on. This feature is available for sandbox sites as well as paid plans at the Professional level and above.
- Enable the modules
- Go to
admin/modulesand enable "Search API Pantheon." Doing so will also enable Search API and Search API Solr if they are not already enabled.
- Go to
- OPTIONAL: Disable Drupal Core's search module
- If you are using Search API, then you probably will not be using Drupal Core's Search module. Uninstall it to save some confusion in the further configuration steps:
admin/modules/uninstall.
- If you are using Search API, then you probably will not be using Drupal Core's Search module. Uninstall it to save some confusion in the further configuration steps:
- Configure a Search API server
- Go to
/admin/config/search/search-api/add-server - Enter "Pantheon" as the server name. (You can name the server anything you want but using something like "Pantheon" is a good way to remember where the connection goes.)
- Under "Backend", select "Solr".
- Under "Solr Connector", select "Pantheon".
- Having selected "Pantheon", you will then be presented with additional options. Choose the Solr schema file you wish to use. Search API Solr module provides an option for each version of Solr (4, 5, and 6). You can customize schema files by copying these examples to your own custom module and editing them. If you are just getting started, we recommend selecting the file for Solr 4.
- Hit the Save button to save the configuration.
- Go to
- Use the server with an index
The following steps are not Pantheon-specific. This module only alters the the configuration of Search API servers. To use a server, you next need to create an index.
- Go to
admin/config/search/search-api/add-index. - Name your index and choose a data source. If this is your first time using Search API, start by selecting "Content" as a data source. That option will index the articles, basic pages, and other node types you have configured.
- Select "Pantheon" as the server.
- Save the index.
- For this index to be useable, you will also need to configure fields to be searched. Select the "fields" tab and choose fields to be included in the index. You may want to index many fields. "Title" is a good field to start with.
- After adding fields the configuration, make sure the index is full by clicking "Index now" or by running cron.
- Go to
- Search the Index
- To actually search your index you will need a module like Search API Pages which allows for the configuration of search forms on their own pages. Search API Pages will not have been downloaded by using
composer requireon Search API Pantheon. You can download it separately.
- To actually search your index you will need a module like Search API Pages which allows for the configuration of search forms on their own pages. Search API Pages will not have been downloaded by using
- Export your changes
- It is a best practice in Drupal 8 to export your changes to
ymlfiles. Using Terminus while in SFTP mode, you can runterminus --env=dev drush "config-export -y"to export the configuration changes you have made. Once committed, these changes can be deployed out to Test and Live environments.
- It is a best practice in Drupal 8 to export your changes to
The version of Solr on Pantheon is Apache Solr v3.6. To accommodate this older version of Solr, use the 8.x-1.x branch of Search API Solr and its Solr 4 schema file.
Each Pantheon environment (Dev, Test, Live, and Multidevs) has its own Solr server. Indexing and searching in one environment does not impact any other environment.
Bug reports, feature requests, and feedback should be posted in the drupal.org issue queue. For code changes, please submit pull requests against the GitHub repository rather than posting patches to drupal.org.