diff --git a/README.rst b/README.rst index caad045..6a52eff 100644 --- a/README.rst +++ b/README.rst @@ -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 diff --git a/tutor_typesense/patches/openedx-cms-production-settings b/tutor_typesense/patches/openedx-cms-production-settings index 383e577..131df5a 100644 --- a/tutor_typesense/patches/openedx-cms-production-settings +++ b/tutor_typesense/patches/openedx-cms-production-settings @@ -1,2 +1,2 @@ -TYPESENSE_URL = "http://typesense:8108" +TYPESENSE_URLS = ["http://typesense:8108"] TYPESENSE_PUBLIC_URL = "https://{{ TYPESENSE_PUBLIC_HOST }}" diff --git a/tutor_typesense/patches/openedx-development-settings b/tutor_typesense/patches/openedx-development-settings index 8c0941a..2b9d981 100644 --- a/tutor_typesense/patches/openedx-development-settings +++ b/tutor_typesense/patches/openedx-development-settings @@ -1,2 +1,2 @@ -TYPESENSE_URL = "http://typesense:8108" +TYPESENSE_URLS = ["http://typesense:8108"] TYPESENSE_PUBLIC_URL = "http://{{ TYPESENSE_PUBLIC_HOST }}:8108" diff --git a/tutor_typesense/patches/openedx-lms-production-settings b/tutor_typesense/patches/openedx-lms-production-settings index 6dffef6..16e03ba 100644 --- a/tutor_typesense/patches/openedx-lms-production-settings +++ b/tutor_typesense/patches/openedx-lms-production-settings @@ -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