Skip to content

Commit 94a7aeb

Browse files
stasadevbserem
andauthored
docs: Update readme, make it easier to copy commands (#54)
Co-authored-by: Bill Seremetis <[email protected]>
1 parent eefb4e8 commit 94a7aeb

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,18 @@ This add-on integrates Solr for Drupal 9+ into your [DDEV](https://ddev.com/) pr
2020

2121
## Installation on Drupal 9+
2222

23-
1. `ddev add-on get ddev/ddev-drupal-solr && ddev restart`
24-
2. You may need to install the relevant Drupal requirements: `ddev composer require drush/drush drupal/search_api_solr`
25-
3. Enable the `search_api_solr` module either using the web interface or `ddev drush en -y search_api_solr`
23+
1. ```bash
24+
ddev add-on get ddev/ddev-drupal-solr
25+
ddev restart
26+
```
27+
2. You may need to install the relevant Drupal requirements:
28+
```bash
29+
ddev composer require drush/drush drupal/search_api_solr
30+
```
31+
3. Enable the `search_api_solr` module either using the web interface or
32+
```bash
33+
ddev drush en -y search_api_solr
34+
```
2635
4. Create a Search API server at `admin/config/search/search-api` -> "Add server"
2736
5. Create a server with the following settings
2837
* Set "Server name" to anything you want. Maybe `ddev-solr-server`.
@@ -57,9 +66,9 @@ See [the documentation in the `doc` folder](doc/README.md)
5766

5867
## Explanation
5968

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

62-
* It installs a [`.ddev/docker-compose.solr.yaml`](docker-compose.solr.yaml) using the solr:8 docker image.
71+
* It installs a [`.ddev/docker-compose.solr.yaml`](docker-compose.solr.yaml) using the `solr:8` docker image.
6372
* A standard Drupal 9+ Solr configuration is included in [.ddev/solr/conf](solr/conf).
6473
* 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`.
6574

0 commit comments

Comments
 (0)