Skip to content

Commit bfdcca6

Browse files
angonzbradenmacdonald
authored andcommitted
feat: Add proxy for meilisearch host when run out of the cluster.
1 parent 8fca567 commit bfdcca6

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,42 @@ from this job, run:") in a separate terminal in order to monitor the status.
276276

277277
## Configuration Reference
278278

279+
### Multi-tenant Meilisearch
280+
281+
Meilisearch is the new search engine used by Open edX since "Sumac" version.
282+
If you are running Redwood or an older version, please check the instructions to
283+
set up Elasticsearch bellow.
284+
285+
You have three options to run Meilisearch for Open edX:
286+
287+
#### Default installation
288+
289+
By default, Tutor will setup a Meilisearch instance inside the K8s cluster.
290+
If you have multiple sites in your cluster, each one will have its own Meilisearch pod.
291+
Just leave all Meilisearch settings by default.
292+
293+
#### Public Meilisearch server
294+
295+
If you want to use [Meilisearch Cloud](https://www.meilisearch.com/cloud) or you have your own Meilisarch
296+
internet-facing server, set `RUN_MEILISEARCH=false` and `MEILISEARCH_PUBLIC_URL` to the public address
297+
(e.g. https://ms-yourinstanceid.meilisearch.io). The server must be accessible from Internet and must
298+
support HTTPS with its own certificates.
299+
300+
Make sure to set `MEILISEARCH_INDEX_PREFIX` to a value different for each site.
301+
302+
#### Private Meilisearch server
303+
304+
You can [install Meilisearch](https://www.meilisearch.com/docs/learn/self_hosted/getting_started_with_self_hosted_meilisearch)
305+
in a private server. In this case, make sure that the cluster has routes and security rules
306+
that allow traffic from and to the server (by default Meilisearch listens to port 7700).
307+
In this case, set `RUN_MEILISEARCH=false` and `MEILISEARCH_URL` with the internal name or IP address of the Meilisearch
308+
server, including port number (e.g., http://10.1.2.3:7700).
309+
310+
The server doesn't need SSL certificates; they will be managed by cert-manager.
311+
Just leave MEILISEARCH_PUBLIC_URL unset, which will be https://meilisearch.{{LMS_HOST}} by default.
312+
313+
Make sure to set `MEILISEARCH_INDEX_PREFIX` to a value different for each site.
314+
279315
### Multi-tenant Elasticsearch (Deprecated)
280316

281317
Note: this is not required nor recommended for "Sumac" and newer versions of Open edX, which use Meilisearch instead of Elasticsearch.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{% if not RUN_MEILISEARCH %}{{ MEILISEARCH_HOST }}{$default_site_port} {
2+
import proxy "{{ MEILISEARCH_URL.split("://")[1] }}"
3+
}{% endif %}

0 commit comments

Comments
 (0)