From e745427b0b39f10464274a7ec2415b2ec9d471c0 Mon Sep 17 00:00:00 2001 From: Wesley Bomar Date: Tue, 6 Aug 2024 19:05:57 -0500 Subject: [PATCH 01/12] fix: CMD-176 unable to disable elastic search I.e. Fix v4.11.1's #834 being ineffectual. --- docs/upgrade-project.md | 21 ++++++++ taccsite_cms/_settings/search.py | 69 +++++++++---------------- taccsite_cms/settings.py | 37 ++++++++++--- taccsite_cms/settings_custom.example.py | 10 ++++ 4 files changed, 85 insertions(+), 52 deletions(-) diff --git a/docs/upgrade-project.md b/docs/upgrade-project.md index 3dbe82eab..1e1485e76 100644 --- a/docs/upgrade-project.md +++ b/docs/upgrade-project.md @@ -2,6 +2,7 @@ ## Table of Contents +- [from v4.N to v4.14](#from-v4n-to-v414) - [from v4.N to v4.13](#from-v4n-to-v413) - [from v4.N to v4.12](#from-v4n-to-v412) - [from v4.N to v4.7](#from-v4n-to-v47) @@ -9,6 +10,26 @@ - [from v3.N to v3.12](#from-v3n-to-v312) - [from v2 to v3](#from-v2-to-v3) +## from v4.N to v4.14 + +- [Do Not Assume Elasticsearch Settings](#do-not-assume-elasticsearch-settings) + +### Do Not Assume Elasticsearch Settings + +**If** client uses Elasticsearch, **then** — + +```py +PORTAL_ES_ENABLED = True +``` + +— **otherwise** — + +```py +PORTAL_ES_ENABLED = False +``` + +
Before 2024, all clients with a search feature used Elasticsearch. Newer CMS-only portals should use Google search instead.
+ ## from v4.N to v4.13 - [Upgrade Custom Branding Setting](#upgrade-custom-logo-setting) diff --git a/taccsite_cms/_settings/search.py b/taccsite_cms/_settings/search.py index ad5e12533..3dd415bc8 100644 --- a/taccsite_cms/_settings/search.py +++ b/taccsite_cms/_settings/search.py @@ -1,52 +1,31 @@ -"""Configure search plugins""" +"""Configure deprecated search solution""" ######################## -# TACC: SEARCH +# SEARCH ######################## -PORTAL_ES_ENABLED = True - PORTAL_SEARCH_PATH = '/search' - -if PORTAL_ES_ENABLED: - # Elasticsearch - PORTAL_SEARCH_QUERY_PARAM_NAME = 'query_string' -else: - # Google - PORTAL_SEARCH_QUERY_PARAM_NAME = 'q' - -######################## -# ELASTICSEARCH -######################## - -if PORTAL_ES_ENABLED: - ES_AUTH = 'username:password' - ES_HOSTS = 'http://elasticsearch:9200' - ES_INDEX_PREFIX = 'cms-dev-{}' - ES_DOMAIN = 'http://localhost:8000' - - # Elasticsearch Indexing - HAYSTACK_ROUTERS = ['aldryn_search.router.LanguageRouter', ] - HAYSTACK_SIGNAL_PROCESSOR = 'taccsite_cms.signal_processor.RealtimeSignalProcessor' - ALDRYN_SEARCH_DEFAULT_LANGUAGE = 'en' - ALDRYN_SEARCH_REGISTER_APPHOOK = True - HAYSTACK_CONNECTIONS = { - 'default': { - 'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine', - 'URL': ES_HOSTS, - 'INDEX_NAME': ES_INDEX_PREFIX.format('cms'), - 'KWARGS': {'http_auth': ES_AUTH} - } +PORTAL_SEARCH_QUERY_PARAM_NAME = 'query_string' + +ES_AUTH = 'username:password' +ES_HOSTS = 'http://elasticsearch:9200' +ES_INDEX_PREFIX = 'cms-dev-{}' +ES_DOMAIN = 'http://localhost:8000' + +HAYSTACK_ROUTERS = ['aldryn_search.router.LanguageRouter', ] +HAYSTACK_SIGNAL_PROCESSOR = 'taccsite_cms.signal_processor.RealtimeSignalProcessor' +ALDRYN_SEARCH_DEFAULT_LANGUAGE = 'en' +ALDRYN_SEARCH_REGISTER_APPHOOK = True +HAYSTACK_CONNECTIONS = { + 'default': { + 'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine', + 'URL': ES_HOSTS, + 'INDEX_NAME': ES_INDEX_PREFIX.format('cms'), + 'KWARGS': {'http_auth': ES_AUTH} } +} -######################## -# DJANGO CMS -######################## - -if PORTAL_ES_ENABLED: - _INSTALLED_APPS = [ - 'haystack', # search index - 'aldryn_apphooks_config', # search index & django CMS Blog - ] -else: - _INSTALLED_APPS = [] +_INSTALLED_APPS = [ + 'haystack', # search index + 'aldryn_apphooks_config', # search index & django CMS Blog +] diff --git a/taccsite_cms/settings.py b/taccsite_cms/settings.py index 4b271bf5c..d96ddef0e 100644 --- a/taccsite_cms/settings.py +++ b/taccsite_cms/settings.py @@ -20,10 +20,6 @@ from taccsite_cms._settings.form_plugin import ( _INSTALLED_APPS as form_plugin_INSTALLED_APPS ) -from taccsite_cms._settings.search import * -from taccsite_cms._settings.search import ( - _INSTALLED_APPS as search_INSTALLED_APPS -) ######################## # DJANGO @@ -474,8 +470,6 @@ def gettext(s): return s 'djangocms_bootstrap4.contrib.bootstrap4_tabs', 'djangocms_bootstrap4.contrib.bootstrap4_utilities', -] + search_INSTALLED_APPS + [ - # miscellaneous 'test_without_migrations', # run tests faster @@ -719,6 +713,25 @@ def get_subdirs_as_module_names(path): (CORTAL_ICONS, 'icon', _('TACC "Cortal" Icons')), ] + + +######################## +# SEARCH +######################## + +# To support any search +PORTAL_SEARCH_PATH = '/search' + +# To support Google search +# PORTAL_SEARCH_QUERY_PARAM_NAME = 'q' +# PORTAL_ES_ENABLED = False + +# To support Elasticsearch +PORTAL_SEARCH_QUERY_PARAM_NAME = 'query_string' +PORTAL_ES_ENABLED = True + + + ######################## # SETTINGS IMPORT ######################## @@ -750,8 +763,9 @@ def get_subdirs_as_module_names(path): ######################## # SETTINGS DEPRECATED -######################## # TODO: Make clients not use nor set these +######################## + deprecated_SETTINGS_EXPORT = [] # For header_branding.html @@ -797,6 +811,15 @@ def get_subdirs_as_module_names(path): if 'INCLUDES_SEARCH_BAR' == old_setting_name: PORTAL_HAS_SEARCH = INCLUDES_SEARCH_BAR +# For clients using Elasticsearch +if PORTAL_ES_ENABLED: + from taccsite_cms._settings.search import * + from taccsite_cms._settings.search import ( + _INSTALLED_APPS as search_INSTALLED_APPS + ) + tacc_app_index = INSTALLED_APPS.index('taccsite_cms') + INSTALLED_APPS[tacc_app_index:tacc_app_index] = search_INSTALLED_APPS + ######################## # SETTINGS EXPORT ######################## diff --git a/taccsite_cms/settings_custom.example.py b/taccsite_cms/settings_custom.example.py index 72cf7450b..937c25fa7 100644 --- a/taccsite_cms/settings_custom.example.py +++ b/taccsite_cms/settings_custom.example.py @@ -196,3 +196,13 @@ # TACC/Core-CMS-Resources#75: Load custom urls.py so we can add urlpatterns for taggit_autosuggest ROOT_URLCONF = 'taccsite_custom.example_cms.urls' + +######################## +# SEARCH +######################## + +# To support Google search +PORTAL_SEARCH_QUERY_PARAM_NAME = 'q' + +# To disable Elasticsearch +PORTAL_ES_ENABLED = False From 9fa866c0f34e282ea7e64f068ce9d1cad9f3c12d Mon Sep 17 00:00:00 2001 From: Wesley Bomar Date: Tue, 6 Aug 2024 19:09:59 -0500 Subject: [PATCH 02/12] refactor: CMD-176 rename search to es_search --- taccsite_cms/_settings/{search.py => es_search.py} | 0 taccsite_cms/settings.py | 8 ++++---- 2 files changed, 4 insertions(+), 4 deletions(-) rename taccsite_cms/_settings/{search.py => es_search.py} (100%) diff --git a/taccsite_cms/_settings/search.py b/taccsite_cms/_settings/es_search.py similarity index 100% rename from taccsite_cms/_settings/search.py rename to taccsite_cms/_settings/es_search.py diff --git a/taccsite_cms/settings.py b/taccsite_cms/settings.py index d96ddef0e..277a408f8 100644 --- a/taccsite_cms/settings.py +++ b/taccsite_cms/settings.py @@ -813,12 +813,12 @@ def get_subdirs_as_module_names(path): # For clients using Elasticsearch if PORTAL_ES_ENABLED: - from taccsite_cms._settings.search import * - from taccsite_cms._settings.search import ( - _INSTALLED_APPS as search_INSTALLED_APPS + from taccsite_cms._settings.es_search import * + from taccsite_cms._settings.es_search import ( + _INSTALLED_APPS as es_search_INSTALLED_APPS ) tacc_app_index = INSTALLED_APPS.index('taccsite_cms') - INSTALLED_APPS[tacc_app_index:tacc_app_index] = search_INSTALLED_APPS + INSTALLED_APPS[tacc_app_index:tacc_app_index] = es_search_INSTALLED_APPS ######################## # SETTINGS EXPORT From 57df4dd4e57481ea3b4bf1570db287b6b725db70 Mon Sep 17 00:00:00 2001 From: Wesley Bomar Date: Tue, 6 Aug 2024 19:20:26 -0500 Subject: [PATCH 03/12] fix: CMD-176 always install aldryn_apphooks_config --- taccsite_cms/_settings/es_search.py | 1 - taccsite_cms/settings.py | 1 + taccsite_cms/settings_custom.example.py | 1 + 3 files changed, 2 insertions(+), 1 deletion(-) diff --git a/taccsite_cms/_settings/es_search.py b/taccsite_cms/_settings/es_search.py index 3dd415bc8..10ce22422 100644 --- a/taccsite_cms/_settings/es_search.py +++ b/taccsite_cms/_settings/es_search.py @@ -27,5 +27,4 @@ _INSTALLED_APPS = [ 'haystack', # search index - 'aldryn_apphooks_config', # search index & django CMS Blog ] diff --git a/taccsite_cms/settings.py b/taccsite_cms/settings.py index 277a408f8..0af1ca602 100644 --- a/taccsite_cms/settings.py +++ b/taccsite_cms/settings.py @@ -472,6 +472,7 @@ def gettext(s): return s # miscellaneous 'test_without_migrations', # run tests faster + 'aldryn_apphooks_config', # search index & django CMS Blog ] + form_plugin_INSTALLED_APPS + [ diff --git a/taccsite_cms/settings_custom.example.py b/taccsite_cms/settings_custom.example.py index 937c25fa7..35cd3f749 100644 --- a/taccsite_cms/settings_custom.example.py +++ b/taccsite_cms/settings_custom.example.py @@ -143,6 +143,7 @@ tacc_app_index = INSTALLED_APPS.index('taccsite_cms') INSTALLED_APPS[tacc_app_index:tacc_app_index] = [ + # 'aldryn_apphooks_config' # already in Core # 'filer', # already in Core # 'easy_thumbnails', # already in Core 'parler', From 3e1afdd822454d4782a1ef35f0590ad121814b7e Mon Sep 17 00:00:00 2001 From: Wesley Bomar Date: Wed, 7 Aug 2024 16:51:56 -0500 Subject: [PATCH 04/12] style: simpler variable name --- taccsite_cms/settings.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/taccsite_cms/settings.py b/taccsite_cms/settings.py index 0af1ca602..23e78634d 100644 --- a/taccsite_cms/settings.py +++ b/taccsite_cms/settings.py @@ -818,8 +818,8 @@ def get_subdirs_as_module_names(path): from taccsite_cms._settings.es_search import ( _INSTALLED_APPS as es_search_INSTALLED_APPS ) - tacc_app_index = INSTALLED_APPS.index('taccsite_cms') - INSTALLED_APPS[tacc_app_index:tacc_app_index] = es_search_INSTALLED_APPS + index = INSTALLED_APPS.index('taccsite_cms') + INSTALLED_APPS[index:index] = es_search_INSTALLED_APPS ######################## # SETTINGS EXPORT @@ -849,3 +849,7 @@ def get_subdirs_as_module_names(path): 'PORTAL_SEARCH_PATH', 'PORTAL_SEARCH_QUERY_PARAM_NAME', ] + +if 'PORTAL_ES_ENABLED' in locals(): print('PORTAL_ES_ENABLED', PORTAL_ES_ENABLED) +if 'INSTALLED_APPS' in locals(): print('INSTALLED_APPS', INSTALLED_APPS) +if 'es_search_INSTALLED_APPS' in locals(): print('es_search_INSTALLED_APPS', es_search_INSTALLED_APPS) From 08f2384f42d2d69bb1ba688e498cbb565f7b7de3 Mon Sep 17 00:00:00 2001 From: Wesley Bomar Date: Wed, 7 Aug 2024 16:54:09 -0500 Subject: [PATCH 05/12] fix: install search plugins where they had been --- taccsite_cms/settings.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/taccsite_cms/settings.py b/taccsite_cms/settings.py index 23e78634d..9d110944d 100644 --- a/taccsite_cms/settings.py +++ b/taccsite_cms/settings.py @@ -471,8 +471,8 @@ def gettext(s): return s 'djangocms_bootstrap4.contrib.bootstrap4_utilities', # miscellaneous - 'test_without_migrations', # run tests faster 'aldryn_apphooks_config', # search index & django CMS Blog + 'test_without_migrations', # run tests faster ] + form_plugin_INSTALLED_APPS + [ @@ -818,7 +818,7 @@ def get_subdirs_as_module_names(path): from taccsite_cms._settings.es_search import ( _INSTALLED_APPS as es_search_INSTALLED_APPS ) - index = INSTALLED_APPS.index('taccsite_cms') + index = INSTALLED_APPS.index('aldryn_apphooks_config') INSTALLED_APPS[index:index] = es_search_INSTALLED_APPS ######################## From 58928d99893f6d0a09c84541f60f923f954e641a Mon Sep 17 00:00:00 2001 From: Wesley Bomar Date: Wed, 7 Aug 2024 17:04:44 -0500 Subject: [PATCH 06/12] chore: delete testing cruft --- taccsite_cms/settings.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/taccsite_cms/settings.py b/taccsite_cms/settings.py index 9d110944d..148eba79c 100644 --- a/taccsite_cms/settings.py +++ b/taccsite_cms/settings.py @@ -849,7 +849,3 @@ def get_subdirs_as_module_names(path): 'PORTAL_SEARCH_PATH', 'PORTAL_SEARCH_QUERY_PARAM_NAME', ] - -if 'PORTAL_ES_ENABLED' in locals(): print('PORTAL_ES_ENABLED', PORTAL_ES_ENABLED) -if 'INSTALLED_APPS' in locals(): print('INSTALLED_APPS', INSTALLED_APPS) -if 'es_search_INSTALLED_APPS' in locals(): print('es_search_INSTALLED_APPS', es_search_INSTALLED_APPS) From 2192aa901b9d2e246d6c597974b806bb3875dc47 Mon Sep 17 00:00:00 2001 From: Wesley Bomar Date: Wed, 7 Aug 2024 17:09:48 -0500 Subject: [PATCH 07/12] chore: delete duplicate settings --- taccsite_cms/_settings/es_search.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/taccsite_cms/_settings/es_search.py b/taccsite_cms/_settings/es_search.py index 10ce22422..af5c24666 100644 --- a/taccsite_cms/_settings/es_search.py +++ b/taccsite_cms/_settings/es_search.py @@ -4,9 +4,6 @@ # SEARCH ######################## -PORTAL_SEARCH_PATH = '/search' -PORTAL_SEARCH_QUERY_PARAM_NAME = 'query_string' - ES_AUTH = 'username:password' ES_HOSTS = 'http://elasticsearch:9200' ES_INDEX_PREFIX = 'cms-dev-{}' From c323500a183be02e1c78c5ec1625f5f2fe2a0c6c Mon Sep 17 00:00:00 2001 From: Wesley Bomar Date: Wed, 7 Aug 2024 17:51:48 -0500 Subject: [PATCH 08/12] fix: do not override secrets --- taccsite_cms/_settings/es_search.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/taccsite_cms/_settings/es_search.py b/taccsite_cms/_settings/es_search.py index af5c24666..400938594 100644 --- a/taccsite_cms/_settings/es_search.py +++ b/taccsite_cms/_settings/es_search.py @@ -4,10 +4,11 @@ # SEARCH ######################## -ES_AUTH = 'username:password' -ES_HOSTS = 'http://elasticsearch:9200' -ES_INDEX_PREFIX = 'cms-dev-{}' -ES_DOMAIN = 'http://localhost:8000' +# Set these in secrets.py +# ES_AUTH = 'username:password' +# ES_HOSTS = 'http://elasticsearch:9200' +# ES_INDEX_PREFIX = 'cms-dev-{}' +# ES_DOMAIN = 'http://localhost:8000' HAYSTACK_ROUTERS = ['aldryn_search.router.LanguageRouter', ] HAYSTACK_SIGNAL_PROCESSOR = 'taccsite_cms.signal_processor.RealtimeSignalProcessor' From 0c5c6ebffd8ab581e240a1b010d05f0868d2e947 Mon Sep 17 00:00:00 2001 From: Wesley Bomar Date: Wed, 7 Aug 2024 18:47:26 -0500 Subject: [PATCH 09/12] fix: restore default ES_* secrets --- taccsite_cms/settings.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/taccsite_cms/settings.py b/taccsite_cms/settings.py index 3351da3b9..7e42d0e92 100644 --- a/taccsite_cms/settings.py +++ b/taccsite_cms/settings.py @@ -735,6 +735,11 @@ def get_subdirs_as_module_names(path): PORTAL_SEARCH_QUERY_PARAM_NAME = 'query_string' PORTAL_ES_ENABLED = True +ES_AUTH = 'username:password' +ES_HOSTS = 'http://elasticsearch:9200' +ES_INDEX_PREFIX = 'cms-dev-{}' +ES_DOMAIN = 'http://localhost:8000' + ######################## From e08ae7a61fd3a41aaef80220ac29c4a42b043442 Mon Sep 17 00:00:00 2001 From: Wesley Bomar Date: Wed, 7 Aug 2024 19:52:32 -0500 Subject: [PATCH 10/12] =?UTF-8?q?refactor:=20=E2=80=A6=5FES=5FENABLED?= =?UTF-8?q?=E2=86=92=E2=80=A6=5FSEARCH=5FINDEX=5FIS=5FAUTOMATIC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../_settings/{es_search.py => search.py} | 26 ++++++++---- taccsite_cms/settings.py | 42 ++++++------------- 2 files changed, 30 insertions(+), 38 deletions(-) rename taccsite_cms/_settings/{es_search.py => search.py} (57%) diff --git a/taccsite_cms/_settings/es_search.py b/taccsite_cms/_settings/search.py similarity index 57% rename from taccsite_cms/_settings/es_search.py rename to taccsite_cms/_settings/search.py index 400938594..26b78e9b6 100644 --- a/taccsite_cms/_settings/es_search.py +++ b/taccsite_cms/_settings/search.py @@ -4,16 +4,23 @@ # SEARCH ######################## -# Set these in secrets.py -# ES_AUTH = 'username:password' -# ES_HOSTS = 'http://elasticsearch:9200' -# ES_INDEX_PREFIX = 'cms-dev-{}' -# ES_DOMAIN = 'http://localhost:8000' +# To support any search +PORTAL_SEARCH_PATH = '/search' + +# To support Google search +# PORTAL_SEARCH_QUERY_PARAM_NAME = 'q' +# PORTAL_SEARCH_INDEX_IS_AUTOMATIC = False + +# To support Elasticsearch +PORTAL_SEARCH_QUERY_PARAM_NAME = 'query_string' +PORTAL_SEARCH_INDEX_IS_AUTOMATIC = True + +ES_AUTH = 'username:password' +ES_HOSTS = 'http://elasticsearch:9200' +ES_INDEX_PREFIX = 'cms-dev-{}' +ES_DOMAIN = 'http://localhost:8000' HAYSTACK_ROUTERS = ['aldryn_search.router.LanguageRouter', ] -HAYSTACK_SIGNAL_PROCESSOR = 'taccsite_cms.signal_processor.RealtimeSignalProcessor' -ALDRYN_SEARCH_DEFAULT_LANGUAGE = 'en' -ALDRYN_SEARCH_REGISTER_APPHOOK = True HAYSTACK_CONNECTIONS = { 'default': { 'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine', @@ -23,6 +30,9 @@ } } +ALDRYN_SEARCH_DEFAULT_LANGUAGE = 'en' +ALDRYN_SEARCH_REGISTER_APPHOOK = True + _INSTALLED_APPS = [ 'haystack', # search index ] diff --git a/taccsite_cms/settings.py b/taccsite_cms/settings.py index 7e42d0e92..9707d7e74 100644 --- a/taccsite_cms/settings.py +++ b/taccsite_cms/settings.py @@ -20,6 +20,10 @@ from taccsite_cms._settings.form_plugin import ( _INSTALLED_APPS as form_plugin_INSTALLED_APPS ) +from taccsite_cms._settings.search import * +from taccsite_cms._settings.search import ( + _INSTALLED_APPS as search_INSTALLED_APPS +) def gettext(s): return s @@ -474,6 +478,8 @@ def gettext(s): return s 'djangocms_bootstrap4.contrib.bootstrap4_tabs', 'djangocms_bootstrap4.contrib.bootstrap4_utilities', +] + search_INSTALLED_APPS + [ + # miscellaneous 'aldryn_apphooks_config', # search index & django CMS Blog 'test_without_migrations', # run tests faster @@ -720,28 +726,6 @@ def get_subdirs_as_module_names(path): -######################## -# SEARCH -######################## - -# To support any search -PORTAL_SEARCH_PATH = '/search' - -# To support Google search -# PORTAL_SEARCH_QUERY_PARAM_NAME = 'q' -# PORTAL_ES_ENABLED = False - -# To support Elasticsearch -PORTAL_SEARCH_QUERY_PARAM_NAME = 'query_string' -PORTAL_ES_ENABLED = True - -ES_AUTH = 'username:password' -ES_HOSTS = 'http://elasticsearch:9200' -ES_INDEX_PREFIX = 'cms-dev-{}' -ES_DOMAIN = 'http://localhost:8000' - - - ######################## # SETTINGS IMPORT ######################## @@ -821,14 +805,12 @@ def get_subdirs_as_module_names(path): if 'INCLUDES_SEARCH_BAR' == old_setting_name: PORTAL_HAS_SEARCH = INCLUDES_SEARCH_BAR -# For clients using Elasticsearch -if PORTAL_ES_ENABLED: - from taccsite_cms._settings.es_search import * - from taccsite_cms._settings.es_search import ( - _INSTALLED_APPS as es_search_INSTALLED_APPS - ) - index = INSTALLED_APPS.index('aldryn_apphooks_config') - INSTALLED_APPS[index:index] = es_search_INSTALLED_APPS +######################## +# SETTINGS CONDITIONAL +######################## + +if PORTAL_SEARCH_INDEX_IS_AUTOMATIC: + HAYSTACK_SIGNAL_PROCESSOR = 'taccsite_cms.signal_processor.RealtimeSignalProcessor' ######################## # SETTINGS EXPORT From 9830175d70c8108da403509e43877590b5326a7b Mon Sep 17 00:00:00 2001 From: Wesley Bomar Date: Wed, 7 Aug 2024 19:58:29 -0500 Subject: [PATCH 11/12] =?UTF-8?q?docs:=20=E2=80=A6=5FES=5FENABLED=20?= =?UTF-8?q?=E2=86=92=20=E2=80=A6=5FSEARCH=5FINDEX=5FIS=5FAUTOMATIC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/upgrade-project.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/docs/upgrade-project.md b/docs/upgrade-project.md index 0d7e058d9..975802774 100644 --- a/docs/upgrade-project.md +++ b/docs/upgrade-project.md @@ -12,22 +12,14 @@ ## from v4.N to v4.14 -- [Do Not Assume Elasticsearch Settings](#do-not-assume-elasticsearch-settings) +- [Rename `PORTAL_ES_ENABLED` Setting](#rename-portal_es_enabled-settings) - [Upgrade Docker Compose](#upgrade-docker-compose) -### Do Not Assume Elasticsearch Settings +### Rename `PORTAL_ES_ENABLED` Setting -**If** client uses Elasticsearch, **then** — - -```py -PORTAL_ES_ENABLED = True -``` - -— **otherwise** — - -```py -PORTAL_ES_ENABLED = False -``` +| from | to | +| - | - | +| `PORTAL_ES_ENABLED` | `PORTAL_SEARCH_INDEX_IS_AUTOMATIC` | ### Upgrade Docker Compose From 3e40927c714947466bca4da0ebe1f46bd21668e4 Mon Sep 17 00:00:00 2001 From: Wesley Bomar Date: Wed, 7 Aug 2024 20:02:49 -0500 Subject: [PATCH 12/12] fix: settings_custom.example.py --- taccsite_cms/settings_custom.example.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/taccsite_cms/settings_custom.example.py b/taccsite_cms/settings_custom.example.py index 35cd3f749..a02105b32 100644 --- a/taccsite_cms/settings_custom.example.py +++ b/taccsite_cms/settings_custom.example.py @@ -135,6 +135,16 @@ "img_file_src": "https://cdn.jsdelivr.net/gh/TACC/Core-CMS-Custom@813aa7c/ptdatax_assets/favicon.ico", } +######################## +# SEARCH +######################## + +# To support Google search +PORTAL_SEARCH_QUERY_PARAM_NAME = 'q' + +# To disable Elasticsearch +PORTAL_SEARCH_INDEX_IS_AUTOMATIC = False + ######################## # DJANGOCMS_BLOG ######################## @@ -197,13 +207,3 @@ # TACC/Core-CMS-Resources#75: Load custom urls.py so we can add urlpatterns for taggit_autosuggest ROOT_URLCONF = 'taccsite_custom.example_cms.urls' - -######################## -# SEARCH -######################## - -# To support Google search -PORTAL_SEARCH_QUERY_PARAM_NAME = 'q' - -# To disable Elasticsearch -PORTAL_ES_ENABLED = False