Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ This plugin provides the following settings to Open edX components for integrati
- (common) ``TYPESENSE_ENABLED: bool = True`` - whether the Typesense backend is enabled
- (common) ``TYPESENSE_COLLECTION_PREFIX: str = "the_configured_collection_prefix"`` - a prefix that the backend should use for all collections (the API key is scoped to this prefix)
- (common) ``FORUM_SEARCH_BACKEND = "forum.search.typesense.TypesenseBackend"`` - necessary to override Tutor's default forum search backend value pointing to Meilisearch
- (cms, lms) ``TYPESENSE_URL: str = "http://typesense:8108"`` - the internal url for accessing the Typesense API
- (cms, lms) ``TYPESENSE_URLS: list[str] = ["http://typesense:8108"]`` - the internal urls for accessing the Typesense API.
- (cms, lms) ``TYPESENSE_PUBLIC_URL: str = "http://(depends on TYPESENSE_PUBLIC_HOST)"`` - the public url to the Typesense API (for user searches on the frontend)
- (cms, lms) ``TYPESENSE_API_KEY: str = "the api key"`` - an api key for the Open edX backend to make updates to Typesense collections
- (lms) ``MFE_CONFIG["TYPESENSE_ENABLED"]: bool = True`` - for MFE's to know when to use Typesense logic
Expand Down
2 changes: 1 addition & 1 deletion tutor_typesense/patches/openedx-cms-production-settings
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
TYPESENSE_URL = "http://typesense:8108"
TYPESENSE_URLS = ["http://typesense:8108"]
TYPESENSE_PUBLIC_URL = "https://{{ TYPESENSE_PUBLIC_HOST }}"
2 changes: 1 addition & 1 deletion tutor_typesense/patches/openedx-development-settings
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
TYPESENSE_URL = "http://typesense:8108"
TYPESENSE_URLS = ["http://typesense:8108"]
TYPESENSE_PUBLIC_URL = "http://{{ TYPESENSE_PUBLIC_HOST }}:8108"
2 changes: 1 addition & 1 deletion tutor_typesense/patches/openedx-lms-production-settings
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
TYPESENSE_URL = "http://typesense:8108"
TYPESENSE_URLS = ["http://typesense:8108"]
TYPESENSE_PUBLIC_URL = "https://{{ TYPESENSE_PUBLIC_HOST }}"
MFE_CONFIG["TYPESENSE_ENABLED"] = TYPESENSE_ENABLED