Skip to content

docs: add verbose instructions for Solr 7 and Drupal 7, fixes #44 #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add verbose instructions for Solr 7 and Drupal 7, fixes #44 #45

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d2b7e9
Added verbose instructions for Solr 7 and Drupal 7
jenlampton Dec 13, 2024
a10d69f
Apply suggestions from code review
stasadev Apr 24, 2025
002be7f
Formatting
stasadev Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 68 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,23 +33,85 @@ This add-on integrates Solr for Drupal 9+ into your [DDEV](https://ddev.com/) pr
ddev drush en -y search_api_solr
```
4. Create a Search API server at `admin/config/search/search-api` -> "Add server"
5. Create a server with the following settings
5. Configure the server with the following settings:
* Set "Server name" to anything you want. Maybe `ddev-solr-server`.
* Set "Backend" to `Solr`
* Configure Solr backend
* Set "Solr Connector" to `Standard`
* Set "Solr host" to `solr`
* Set "solr core" to `dev`
* Under "Advanced server configuration" set the "solr.install.dir" to `/opt/solr`.
6. `ddev restart`
6. Restart DDEV: `ddev restart`

### Outdated Solr config files
## Installation on Drupal 7

### DDEV / Solr configuration

1. Install this add-on: `ddev add-on get ddev/ddev-drupal-solr`
2. Set the version of Solr version 7: Edit the `.ddev/docker-compose.solr.yaml` file. Replace `image: solr:8` with `image: solr:7` on line 34.
3. Add the schema needed for version 7: Defaults can be found in the Search API Solr in the `search_api_solr/solr-conf/7.x` directory . Copy these files into `.ddev/solr/conf`.
4. Restart DDEV: `ddev restart`.
5. Confirm Solr is working by visiting `http://<projectname>.ddev.site:8983/solr/`.
6. If the Ddev drush version is too new for Drupal 7, you may need to symlink `drush` to the `drush8` provided with Ddev. You can do this by adding a `post-start` hook inside your `.ddev/config.yaml` file as follows
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really understand this. If a project is configured with project type drupal7 (or backdrop I think) then drush is already drush8, so why would one need to do this? Using project type php ?

```yaml
hooks:
post-start:
- exec: ln -s /usr/local/bin/drush8 /usr/local/bin/drush
```
7. Restart DDEV: `ddev restart`.

### Drupal configuration

1. You may need to install the relevant Drupal modules: `ddev drush dl search_api_solr`.
2. Enable the `search_api_solr` module either using the web interface or `ddev drush en -y search_api_solr`
3. Create a Search API server at `admin/config/search/search-api` -> "Add server"
4. Configure the server with the following settings:
* Set "Server name" to anything you want. Maybe `ddev-solr-server`.
* Set "Protocol" to `http`
* Set "Solr host" to `solr`
* Set "Solr port" to `8983`
* Set "path" to `/solr/dev`.
The "Solr server URI" should be `http://solr:8983/solr/dev` when done.
5. Create a Search API index at `admin/config/search/search-api` -> "Add index"
6. Configure the index as needed, but this is common:
* Set "Server name" to anything you want. Maybe `ddev-solr-index-content`.
* Set "item type" to `content`
* Set the server to `ddev-solr-server` (or whaver the name is)
* Index the site.
7. Build a new view of indexed content `ddev-solr-index-content` (or whatever the name is)
8. Configure the view as needed, but this is common:
* Set "View name" to anything you want. Maybe `Solr Search`.
* Set "Show" to `ddev-solr-index-content` (or whatever the name is)
* Tick the box for "Create a page"
* Set the "Page title" to `Search` or whatever you prefer
* Set the "Path" to `/search` or whatever you prefer
* Set "Display format" to `HTML list` + `OL` / `Rendered entity` + `Search result` view mode
* Continue and edit
* Add filters:
* Add an EXPOSED filter for `Search: Fulltext search (exposed)`
* Add additional filters as needed (recommended: `Indexed Content: Status (= Published)`)
* Add sort criteria:
* Add a sort on `Search: Relevance (desc)`
* Set "access control: to `Permission` / `View published content`
* Set "Exposed form style" to `Input required`
* Set "No Results behavior" to `Global:text` / `No results matched your search.`
* (Optional) Set "Exposed form in block" setting

## Outdated Solr config files

If you get a message about Solr having outdated config files, you need to update the included Solr config files.

### Drupal 9+:

1. Click "Get config.zip" on the server page
2. Unzip the files, and put the config files into `.ddev/solr/conf/`
3. Run `ddev restart`
3. Restart DDEV: `ddev restart`

### Drupal 7

1. Locate the example files in the `search_api_solr/solr-conf/7.x` directory .
2. Copy these files into `.ddev/solr/conf`.
3. Restart DDEV: `ddev restart`.

### Other frameworks

Expand All @@ -68,7 +130,7 @@ See [the documentation in the `doc` folder](doc/README.md)

This originates from the classic Drupal `solr:8` image recipe used for a long time by Drupal users and compatible with `search_api_solr`.

* It installs a [`.ddev/docker-compose.solr.yaml`](docker-compose.solr.yaml) using the `solr:8` docker image.
* This add-on installs a [`.ddev/docker-compose.solr.yaml`](docker-compose.solr.yaml) using the `solr:8` docker image.
* A standard Drupal 9+ Solr configuration is included in [.ddev/solr/conf](solr/conf).
* A [.ddev/docker-entrypoint-initdb.d/solr-configupdate.sh](solr/docker-entrypoint-initdb.d/solr-configupdate.sh) is included and mounted into the Solr container so that you can change Solr config in `.ddev/solr/conf` with just a `ddev restart`.

Expand Down Expand Up @@ -142,7 +204,7 @@ If you would like to use more than one Solr core, add a `.ddev/docker-compose.s

## Caveats

* This recipe won't work with versions of Solr before `solr:8`, and Acquia's hosting [requires Solr 7](https://docs.acquia.com/acquia-cloud-platform/docs/features/acquia-search). You'll want to see the [contributed recipes](https://github.com/ddev/ddev-contrib) for older versions of Solr.
* This recipe is designed for versions of Solr `solr:8` and beyond. Acquia's hosting [requires Solr 7](https://docs.acquia.com/acquia-cloud-platform/docs/features/acquia-search). You'll want to follow the Drupal 7 instructions above, or see the [contributed recipes](https://github.com/ddev/ddev-contrib) for older versions of Solr.

## Credits

Expand Down