Migrate to Fess 15.7 with OpenSearch and docsearch static theme#1
Open
marevol wants to merge 3 commits into
Open
Migrate to Fess 15.7 with OpenSearch and docsearch static theme#1marevol wants to merge 3 commits into
marevol wants to merge 3 commits into
Conversation
- Upgrade Fess 14.8.0 -> 15.7.0 and switch the search engine from Elasticsearch 7.17 to OpenSearch 3.7.0 (ghcr.io/codelibs/fess-opensearch:3.7.0); rename the service es01 -> search01 and ES_HTTP_URL -> SEARCH_ENGINE_HTTP_URL. - Replace the legacy JSP-based docsearch view/CSS/image overrides with the docsearch static theme, synced from the fess-themes repository by setup.sh and mounted at /usr/share/fess/app/themes/docsearch. - Activate the theme with -Dfess.system.theme.default=docsearch. - Move all Fess settings out of the mounted system.properties file into -D flags in compose.yaml (-Dfess.config.* for config keys, -Dfess.system.* for dynamic/system properties). - Drop the fess-script-groovy plugin download; the Groovy engine has been part of Fess core since 15.0. - Add healthchecks for both services and gate fess01 on search01 health. - Update README and .gitignore accordingly.
Keep fess_config.properties overrides as -Dfess.config.* flags, but move dynamic system settings (theme.default=docsearch, login.required, etc.) back into a mounted /opt/fess/system.properties file instead of -Dfess.system.* flags. setup.sh seeds the live (git-ignored) system.properties from the tracked system.properties.template on first run; existing files are preserved so Fess can rewrite them at runtime and git pull does not conflict.
The system.properties backup/restore dance git_pull.sh existed for is gone, so the script was just a thin git pull + setup.sh wrapper. Document the update steps in README instead, noting that the git-ignored system.properties is preserved across updates.
marevol
force-pushed
the
feature/fess-15.7-opensearch-docsearch-theme
branch
from
b1d5e8c to
38e6e21
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrates the
docker-docsearchdeployment to Fess 15.7 with OpenSearch 3.7.0, and replaces the legacy JSP-baseddocsearchUI with the newdocsearchstatic theme from fess-themes. All Fess settings now live as-Dflags incompose.yamlinstead of a mountedsystem.propertiesfile.Changes
Stack upgrade
14.8.0→ghcr.io/codelibs/fess:15.7.0.7.17.7→ OpenSearch3.7.0(ghcr.io/codelibs/fess-opensearch:3.7.0). Servicees01→search01,ES_HTTP_URL→SEARCH_ENGINE_HTTP_URL, dictionary/data paths moved under/usr/share/opensearch/....fess01now waits forsearch01to be healthy.Static theme
data/fess/.../{WEB-INF/view,css,images}/docsearch.setup.shnow syncs thedocsearchstatic theme from the fess-themes repository intodata/fess/usr/share/fess/app/themes/docsearch(mounted into the container). Source is configurable viaFESS_THEMES_DIR(local checkout) orFESS_THEMES_REPO/FESS_THEMES_REF.-Dfess.system.theme.default=docsearch.Configuration via
-Dflagssystem.propertiesare now-Dflags inFESS_JAVA_OPTS:fess_config.propertieskeys use-Dfess.config.<key>.-Dfess.system.<key>.virtual.host.value(theme activation now handled globally bytheme.default) andpurge.by.bots(identical to the Fess 15.7 built-in default).Plugins
fess-script-groovyplugin download — the Groovy engine has been bundled in Fess core since 15.0.Notes / verification
compose.yamlvalidated;FESS_JAVA_OPTSrenders as the expected flag list.setup.sh/git_pull.shpassbash -n; theme sync produces a validthemes/docsearch/(theme.ymlwithname: docsearch)./api/v2/health, which is provided by Fess core in 15.7 (the/api/v1/*surface moved to the separatefess-webapp-v1-apiplugin) and matches the officialfess:15.7.0image healthcheck.vm.max_map_count >= 262144(documented in README).Test plan
bash ./bin/setup.shdocker compose -f compose.yaml up -dsearch01becomes healthy, thenfess01starts/and/themes/docsearch/