Repository navigation
docs(15.10): correct the index export path, file crawl path, suggest word, memory and reverse proxy statements - #615
Merged
Merged
Conversation
…suggest word and memory statements
Fix statements in the 15.10 documentation (ja, en, de, es, fr, ko, zh-cn)
that did not match the behavior of the product.
- config/admin-index-export.rst: the default index.export.path is not
writable for a ZIP install run as a regular user; the job now fails with
"Cannot write to the index export directory" instead of logging a warning
for each document. Add a note to set a writable directory.
- config/setup-memory.rst: add the content chunk process (jvm.chunk.options,
-Xmx1g by default) next to the suggest and thumbnail processes.
- admin/fileconfig-guide.rst: explain that "Included Paths for Crawling" is
matched against every visited path including the start path and
subdirectories, so an extension-only pattern crawls nothing; use the
indexing (search target) path for an extension filter.
- admin/badword-guide.rst, admin/elevateword-guide.rst: words registered,
edited, deleted or uploaded are applied to Suggest only when the
"Suggest Indexer" job runs; describe how to run it now.
- admin/elevateword-guide.rst: describe the {user}/{role}/{group} prefixes
of the permissions and use "{role}role1" in the CSV example, because a
value without a prefix is stored as is and is not treated as a role. Use
the actual CSV header (Permissions, Labels).
…e of absolute URLs In config/setup-port-network.rst, the TLS termination example sets X-Forwarded-Proto, but Fess builds absolute URLs (OpenSearch description document, SAML destination) from the connector scheme, not from that header. Add a note that tomcat.secure, tomcat.scheme and tomcat.proxyPort must be set in tomcat_config.properties and that the original Host header must be passed through, and point to it from the reverse proxy troubleshooting item. Applied to all languages of the 15.10 tree.
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
Corrections to 15.10 pages whose statements did not match the product behavior, found while checking the use cases of the documentation against a running 15.10 build. All languages of the 15.10 tree are updated (ja, en, de, es, fr, ko, zh-cn); older versions are untouched.
config/admin-index-export.rst: the defaultindex.export.path(/var/lib/fess/export) is not writable for a ZIP install run as a regular user. The job fails withCannot write to the index export directory(it no longer logs a warning per document). Add a note to set a writable directory.config/setup-memory.rst: add the content chunk process (jvm.chunk.options,-Xmx1gby default) next to the suggest and thumbnail processes.admin/fileconfig-guide.rst: "Included Paths for Crawling" is matched against the whole path of every visited path, including the start path and subdirectories, so an extension-only pattern crawls nothing. Point to the indexing (search target) path for extension filters.admin/badword-guide.rst,admin/elevateword-guide.rst: registered, edited, deleted or uploaded words reach Suggest only when the "Suggest Indexer" job runs (daily 12:00 by default); describe how to run it now.admin/elevateword-guide.rst: describe the{user}/{role}/{group}prefixes, use{role}role1in the CSV example (a value without a prefix is stored as is and is not treated as a role), and use the actual CSV header (Permissions,Labels).config/setup-port-network.rst:X-Forwarded-Protodoes not change the scheme Fess uses for absolute URLs (OpenSearch description document, SAML destination);tomcat.secure,tomcat.schemeandtomcat.proxyPortmust be set, and the originalHostheader passed through.Verification
Each statement was checked against the Fess source (
IndexExportJob,UrlFilterImpl/CrawlerThread,AdminBadwordAction/AdminElevatewordAction,PermissionHelper#encode,OsddHelper) and, for the behavior, on a running instance. The changed RST files parse with docutils; a full Sphinx build was not run.