Skip to content

Commit fe51a11

Browse files
rfayrfay
committed
Initial commit
0 parents  commit fe51a11

26 files changed

+20182
-0
lines changed

‎.github/workflows/tests.yml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: tests
2+
on:
3+
pull_request:
4+
push:
5+
branches: [ master, main ]
6+
7+
schedule:
8+
- cron: '01 07 * * *'
9+
10+
workflow_dispatch:
11+
inputs:
12+
debug_enabled:
13+
description: 'Debug with tmate set "debug_enabled"'
14+
required: false
15+
default: "false"
16+
17+
defaults:
18+
run:
19+
shell: bash
20+
21+
jobs:
22+
tests:
23+
defaults:
24+
run:
25+
shell: bash
26+
27+
strategy:
28+
matrix:
29+
# ddev_version: [latest, edge, HEAD, PR]
30+
ddev_version: [PR]
31+
fail-fast: false
32+
33+
runs-on: ubuntu-20.04
34+
35+
steps:
36+
- uses: actions/checkout@v2
37+
- name: Environment setup
38+
run: |
39+
brew install bats-core mkcert
40+
mkcert -install
41+
42+
- name: Use ddev latest stable
43+
if: matrix.ddev_version == 'latest'
44+
run: brew install drud/ddev/ddev
45+
46+
- name: Use ddev edge
47+
if: matrix.ddev_version == 'edge'
48+
run: brew install drud/ddev-edge/ddev
49+
50+
- name: Use ddev HEAD
51+
if: matrix.ddev_version == 'HEAD'
52+
run: brew install --HEAD drud/ddev/ddev
53+
54+
- name: Use ddev PR
55+
if: matrix.ddev_version == 'PR'
56+
run: |
57+
curl -sSL -o ddev_linux.zip https://nightly.link/drud/ddev/actions/artifacts/144791287.zip
58+
unzip ddev_linux.zip
59+
mv ddev /usr/local/bin/ddev && chmod +x /usr/local/bin/ddev
60+
61+
- name: Download docker images
62+
run: |
63+
mkdir junk && pushd junk && ddev config --auto && ddev debug download-images
64+
docker pull solr:8
65+
- name: tmate debugging session
66+
uses: mxschmitt/action-tmate@v3
67+
with:
68+
limit-access-to-actor: true
69+
github-token: ${{ secrets.GITHUB_TOKEN }}
70+
if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled }}
71+
72+
- name: tests
73+
run: bats tests
74+

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
[![tests](https://github.com/drud/ddev-drupal9-solr/actions/workflows/tests.yml/badge.svg)](https://github.com/drud/ddev-drupal9-solr/actions/workflows/tests.yml)
2+
3+
## What is this?
4+
5+
This repository allows you to quickly install Apache Solr for Drupal 9 into a [Ddev](https://ddev.readthedocs.io) project using just `ddev service get drud/ddev-drupal9-solr`.
6+
7+
## Installation on Drupal 9
8+
9+
1.`ddev service get drud/ddev-drupal9-solr && ddev restart`
10+
2. You may need to install the relevant Drupal requirements: `ddev composer require drush/drush:* drupal/search_api_solr`
11+
3. Enable the Search API Solr Search Defaults module: `ddev drush en -y search_api_solr_defaults`. (If it can't be enabled due to the "article" content type not existing, you can just create a search_api_solr server manually.)
12+
4. Edit the enabled search_api server named `default_solr_server` at `admin/config/search/search-api/server/default_solr_server/edit`
13+
* set "Solr host" to `solr`
14+
* set "Solr core" name to "dev"
15+
* Under "Advanced server configuration" set the "solr.install.dir" to `/opt/solr`
16+
5. `ddev restart`
17+
18+
## Explanation
19+
20+
This is the classic Drupal solr 8 recipe used for a long time by Drupal users and compatible with search_api_solr.
21+
22+
* It installs a [`.ddev/docker-compose.solr.yaml`](docker-compose.solr.yaml) using the solr:8 docker image
23+
* A standard Drupal 9 solr configuration is included in [.ddev/solr/conf](.ddev/solr/conf)
24+
* 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`.
25+
26+
## Interacting with Apache Solr
27+
28+
* The Solr admin interface will be accessible at: `http://<projectname>.ddev.site:8983/solr/` For example, if the project is named `myproject` the hostname will be: `http://myproject.ddev.site:8983/solr/`.
29+
* To access the Solr container from inside the web container use: `http://solr:8983/solr/`
30+
* A Solr core is automatically created by default with the name "dev"; it can be accessed (from inside the web container) at the URL: `http://solr:8983/solr/dev` or from the host at `http://<projectname>.ddev.site:8983/solr/#/~cores/dev`. You can obviously create other cores to meet your needs.
31+
32+
## Caveats
33+
* This recipe won't work with versions of solr before solr:8, and Acquia and Pantheon.io hosting require versions from 3 to 7. You'll want to see the [contributed recipes](https://github.com/drud/ddev-contrib) for older versions of solr.

‎docker-compose.solr.yaml‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# DDev Apache Solr recipe file.
2+
#
3+
# SEE IMPORTANT COMPATIBILITY DIFFERENCES BETWEEEN DDEV v1.18.* and v1.19+ below!
4+
# Before v1.19.* you must comment out the `networks:` line below.
5+
#
6+
# To use this in your own project:
7+
# 1. Copy this file to your project's ".ddev" directory.
8+
# 2. Create the folder path ".ddev/solr/conf".
9+
# 3. Copy the Solr configuration files for the appropriate plugin/module to
10+
# ".ddev/solr/conf". For example, using Drupal 8's Search API Solr module,
11+
# you'll get the config files as a file config.zip from
12+
# /admin/config/search/search-api/server/solr and unzip it into .ddev/solr/conf
13+
# so that a file exists with the path ".ddev/solr/conf/solrconfig.xml".
14+
#
15+
# To access Solr after it is installed:
16+
# - The Solr admin interface will be accessible at:
17+
# http://<projectname>.ddev.site:8983/solr/
18+
# For example, if the project is named "myproject" the hostname will be:
19+
# http://myproject.ddev.site:8983/solr/
20+
# - To access the Solr container from the web container use:
21+
# http://solr:8983/solr/
22+
# - A Solr core is automatically created with the name "dev" unless you
23+
# change that usage throughout. It can be
24+
# accessed at the URL: http://solr:8983/solr/dev (inside web container)
25+
# or at http://myproject.ddev.site:8983/solr/dev (on the host)
26+
27+
version: '3.6'
28+
29+
services:
30+
solr:
31+
# Name of container using standard ddev convention
32+
container_name: ddev-${DDEV_SITENAME}-solr
33+
# The solr docker image is at https://hub.docker.com/_/solr/
34+
# and code at https://github.com/docker-solr/docker-solr
35+
# README: https://github.com/docker-solr/docker-solr/blob/master/README.md
36+
# It's almost impossible to work with it if you don't read the docs there
37+
image: solr:8
38+
# CRITICAL COMPATIBILITY ISSUE WITH DDEV V1.18.x and below.
39+
# REMOVE THIS `networks:` line for ddev v1.18.x and below
40+
networks: [default, ddev_default]
41+
restart: "no"
42+
# Solr is served from this port inside the container.
43+
expose:
44+
- 8983
45+
# These labels ensure this service is discoverable by ddev.
46+
labels:
47+
com.ddev.site-name: ${DDEV_SITENAME}
48+
com.ddev.approot: $DDEV_APPROOT
49+
environment:
50+
# This defines the host name the service should be accessible from. This
51+
# will be sitename.ddev.site.
52+
- VIRTUAL_HOST=$DDEV_HOSTNAME
53+
# HTTP_EXPOSE exposes http traffic from the container port 8983
54+
# to the host port 8983 vid ddev-router reverse proxy.
55+
- HTTP_EXPOSE=8983:8983
56+
volumes:
57+
# solr core *data* is stored on the 'solr' docker volume
58+
# This mount is optional; without it your search index disappears
59+
# each time the ddev project is stopped and started.
60+
- solr:/var/solr
61+
62+
# This mounts the conf in .ddev/solr into the container where
63+
# the solr-precreate command in the entrypoint uses it as a one-time
64+
# configuration to copy config into the newly-created core. It is not
65+
# used if the core has previously been created.
66+
- ./solr:/solr-conf
67+
68+
- ".:/mnt/ddev_config"
69+
70+
# solr-configupdate.sh copies fresh configuration files into the
71+
# solr container on each
72+
# startup, so if you change the config in .ddev/solr/conf
73+
# it will be refreshed on `ddev start`. It must be executable,
74+
# `chmod +x solr
75+
- "./solr/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d"
76+
77+
entrypoint: [ "sh", "-c", "docker-entrypoint.sh solr-precreate dev /solr-conf" ]
78+
79+
external_links:
80+
- "ddev-router:${DDEV_SITENAME}.${DDEV_TLD}"
81+
82+
volumes:
83+
# solr is a persistent Docker volume for solr data
84+
# The persistent volume should have the same name as the service so it can be deleted
85+
# when the project is deleted.
86+
solr:

0 commit comments

Comments
 (0)