mirror of
https://github.com/FreshRSS/FreshRSS.git
synced 2026-10-28 14:08:45 -04:00
Yuchen Shi
818b57a9a9
* Update documentation of TRUSTED_PROXY syntax and document limitations. Single IPs are now supported as of #9301. Document the existing limitation of domain names, see #9210. For IPs without `/`, I manually tested the behavior and found requests got rejected on my server before #9301. After #9301 is merged, I've tested again and found that requests are now authorized as expected. So I've updated the corresponding documentation to say "_IPs or_ ranges" where applicable. Domain names are still silently ignored as of writing. I looked at the code, as described in #9210 investigation steps, and concluded that they are WAI (working as _implemented_ , not sure if _intended_ ). I don't particularly like the existing behavior (failures with no debuggable warnings or logs) but I try to document it as-is without judgement. * Update TRUSTED_PROXY comments accordingly for Docker usage. Single IPs are now supported as of #9301. Document the existing limitation of domain names, see #9210.
This is the documentation deployed by GitHub Pages.
To build and serve locally, first install the necessary packages:
bundle install
Then serve:
bundle exec jekyll serve -H 127.0.0.1 --watch --incremental
The documentation should be reachable at http://127.0.0.1:4000/FreshRSS/.