111d17efde
* Implements -real-client-ip-header option. * The -real-client-ip-header determines what HTTP header is used for determining the "real client IP" of the remote client. * The -real-client-ip-header option supports the following headers: X-Forwarded-For X-ProxyUser-IP and X-Real-IP (default). * Introduces new realClientIPParser interface to allow for multiple polymorphic classes to decide how to determine the real client IP. * TODO: implement the more standard, but more complex `Forwarded` HTTP header. * Corrected order of expected/actual in test cases * Improved error message in getRemoteIP * Add tests for getRemoteIP and getClientString * Add comment explaining splitting of header * Update documentation on -real-client-ip-header w/o -reverse-proxy * Add PR number in changelog. * Fix typo repeated word: "it" Co-Authored-By: Joel Speed <Joel.speed@hotmail.co.uk> * Update extended configuration language * Simplify the language around dependance on -reverse-proxy Co-Authored-By: Joel Speed <Joel.speed@hotmail.co.uk> * Added completions * Reorder real client IP header options * Update CHANGELOG.md * Apply suggestions from code review Co-authored-by: Isabelle COWAN-BERGMAN <Izzette@users.noreply.github.com> Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk> Co-authored-by: Henry Jenkins <henry@henryjenkins.name> |
||
|---|---|---|
| .. | ||
| assets/js | ||
| configuration | ||
| logos | ||
| .gitignore | ||
| 0_index.md | ||
| 1_installation.md | ||
| 2_auth.md | ||
| 4_tls.md | ||
| 5_endpoints.md | ||
| 6_request_signatures.md | ||
| 404.html | ||
| Gemfile | ||
| Gemfile.lock | ||
| Makefile | ||
| README.md | ||
| _config.yml | ||
README.md
Docs
This folder contains our Jekyll based docs site which is hosted at https://oauth2-proxy.github.io/oauth2-proxy.
When making changes to this docs site, please test your changes locally:
docs$ make serve
To run the docs site locally you will need Ruby at version 2.1.0 or
higher and bundle (gem install bundler if you already have Ruby).