Repository navigation
docs(15.10): describe the client IP in logs, the app.cipher.key warning and other behavior changes - #610
Merged
Conversation
…ng and other behavior changes Update the Japanese 15.10 development tree. - upgrade: the client IP in the audit and search logs follows rate.limit.trusted.proxies, a startup warning for the default app.cipher.key, "delete all" of the search list and crawling info needs the edit role, the mapping dictionary output is required, and a quoted single word is no longer matched fuzzily. - rate-limiting: the trusted proxies also decide the client IP of the logs, and the login rate limit is shared by the API and the login form.
marevol
added a commit
that referenced
this pull request
Oct 25, 2026
…oxy; tika.xml location; proximity wording All seven language trees (de, en, es, fr, ja, ko, zh-cn) of the 15.10 tree. Stacked on the login form / X-Forwarded-For / (deny) notes of the previous branch; none of those items is repeated. The client address in the logs, the default app.cipher.key warning, the view-only administrators and the quoted single word are already described in #610. Observed on a running server (15.9.0 compared with 15.10.0-SNAPSHOT): - "大阪おいしい"~10 (no space) returns no documents on 15.9 and matches the same documents as "大阪 おいしい"~10 on 15.10. The cause was not examined, so search-proximity.rst states the behavior only. - The SOCKS5 contract: both keys are needed (a port alone connects directly), no authentication, the crawler resolves the host name and gives the proxy an IP address, 15.9 ignores the keys. Read from the code only (fess origin/main, fess-crawler origin/main, fess-15.9.0): - upgrade.rst, new section "Control Characters in audit.log": the LTSV audit log replaces control characters and NEL/LS/PS with a space and a tab with an underscore (fess#3696; 15.9 replaced CR and LF only). - upgrade.rst, tika.xml: the ZIP of 15.9 and earlier has the file in app/WEB-INF/classes. The text assumes the startup warning checks both app/WEB-INF/classes and app/WEB-INF/conf, which is what fess#3709 does; it is not true of a build without that change. - crawler-basic.rst: client.socksProxyHost and client.socksProxyPort (fess-crawler#229, Hc5HttpClient only).
1 of 2 tasks
marevol
added a commit
that referenced
this pull request
Oct 25, 2026
…oxy; tika.xml location; proximity wording (#613) All seven language trees (de, en, es, fr, ja, ko, zh-cn) of the 15.10 tree. Stacked on the login form / X-Forwarded-For / (deny) notes of the previous branch; none of those items is repeated. The client address in the logs, the default app.cipher.key warning, the view-only administrators and the quoted single word are already described in #610. Observed on a running server (15.9.0 compared with 15.10.0-SNAPSHOT): - "大阪おいしい"~10 (no space) returns no documents on 15.9 and matches the same documents as "大阪 おいしい"~10 on 15.10. The cause was not examined, so search-proximity.rst states the behavior only. - The SOCKS5 contract: both keys are needed (a port alone connects directly), no authentication, the crawler resolves the host name and gives the proxy an IP address, 15.9 ignores the keys. Read from the code only (fess origin/main, fess-crawler origin/main, fess-15.9.0): - upgrade.rst, new section "Control Characters in audit.log": the LTSV audit log replaces control characters and NEL/LS/PS with a space and a tab with an underscore (fess#3696; 15.9 replaced CR and LF only). - upgrade.rst, tika.xml: the ZIP of 15.9 and earlier has the file in app/WEB-INF/classes. The text assumes the startup warning checks both app/WEB-INF/classes and app/WEB-INF/conf, which is what fess#3709 does; it is not true of a build without that change. - crawler-basic.rst: client.socksProxyHost and client.socksProxyPort (fess-crawler#229, Hc5HttpClient only).
…e section into en, de, fr, es, ko and zh-cn Adds the same upgrade.rst sections (client IP in logs, app.cipher.key warning, other behavior changes) and the rate-limiting.rst changes (trusted proxies row, login rate limit section) to the six other 15.10 language trees. The de, es, fr, ko and zh-cn texts are translations of the ja text and have not been reviewed by a native speaker.
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
Documents behavior changes of Fess 15.10 that are missing from the 15.9 to 15.10 upgrade section. Each claim was checked against the Fess source on
main(andfess-15.9.0for the previous behavior).<lang>/15.10/install/upgrade.rst(ja section "15.9 から 15.10 へのアップグレード"):audit.log/ search log followsrate.limit.trusted.proxies(fix(log): take the client address of the audit and search logs from the trusted-proxy rule fess#3673, #3680).app.cipher.keyis blank or the shipped default, webapp process only (#3657, #3693).outputis required (#3662).<lang>/15.10/config/rate-limiting.rst: therate.limit.trusted.proxiesrow also covers the log client IP; new short section on the login rate limit shared by/api/v2/auth/loginand the login form (#3675).Scope
The same changes are applied to all seven language trees of 15.10 (ja, en, de, fr, es, ko, zh-cn). The en, de, fr, es, ko and zh-cn texts are translations of the ja text; the de, es, fr, ko and zh-cn ones have not been reviewed by a native speaker.
ja/15.10/api/api-auth.rstis not touched because #609 already corrects the login rate limit text.admin/searchlist-guide.rstandadmin/crawlinginfo-guide.rstmake no claim about delete-all permissions, so they are unchanged.Verification