Repository navigation
docs(15.9): describe the ZIP installation with fess-setup in the quick start - #605
Merged
Merged
Conversation
…k start Fess 15.9 no longer bundles OpenSearch, but the quick start guide still told ZIP users to install OpenSearch by hand, and setup.rst and the Windows service page still referred to an embedded OpenSearch. - quick-start.rst: the ZIP method now needs only Java 21. OpenSearch is installed with bin/fess-setup install opensearch, then OpenSearch and Fess are started in that order and checked with bin/fess-setup check. Notes the macOS limitation and that the command disables the OpenSearch security plugin. - setup.rst: drop the embedded OpenSearch warning and point the links at 15.9. - 15.9/config/setup-windows-service.rst: omitting fess.search_engine.http_address now stops Fess with an error instead of starting an embedded OpenSearch. Applied to all seven languages.
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
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
Fess 15.9 no longer bundles OpenSearch, so the ZIP installation needs
bin/fess-setup.15.9/install/already documents it; the top-level quick start and a few other pages did not.quick-start.rst: the ZIP method needs only Java 21. OpenSearch is installed withbin/fess-setup install opensearch(Windows:bin\fess-setup.bat), OpenSearch is started before Fess, andbin/fess-setup checkverifies the setup. It also notes that OpenSearch has no macOS build and that the command disables the OpenSearch security plugin.setup.rst: removes the "embedded OpenSearch" warning and updates the15.6/links to15.9/.15.9/config/setup-windows-service.rst: withoutfess.search_engine.http_address, 15.9 no longer starts an embedded OpenSearch; it fails with "No search engine address is configured".All seven languages (ja, en, de, es, fr, ko, zh-cn) are updated. Only the development tree (15.9) and the top-level pages are touched.
Verification
Checked against the Fess source (
fess-setup.properties,fess-setup.bat,fess.in.sh/fess.in.bat,SearchEngineClient): the OpenSearch install location (opensearch/opensearch-3.9.0), the automatic dictionary path detection, and the startup error when no address is set. The RST parses with docutils with no new warnings, and no new heading-width mismatches were introduced.