oauth2-proxy/docs
Isabelle COWAN-BERGMAN 64ae31b5a0
Implements --trusted-ip option (#552)
* Implements --ip-whitelist option

* Included IPWhitelist option to allow one-or-more selected CIDR ranges
  to bypass OAuth2 authentication.
* Adds IPWhitelist, a fast lookup table for multiple CIDR ranges.

* Renamed IPWhitelist ipCIDRSet

* Fixed unessesary pointer usage in ipCIDRSet

* Update CHANGELOG.md

* Update CHANGELOG.md

* Updated to not use err.Error() in printf statements

* Imrpoved language for --ip-whitelist descriptions.

* Improve IP whitelist options error messages

* Clarify options single-host normalization

* Wrote a book about ipCIDRSet

* Added comment to IsWhitelistedIP in oauthproxy.go

* Rewrite oauthproxy test case as table driven

* oops

* Support whitelisting by low-level remote address

* Added more test-cases, improved descriptions

* Move ip_cidr_set.go to pkg/ip/net_set.go

* Add more whitelist test use cases.

* Oops

* Use subtests for TestIPWhitelist

* Add minimal tests for ip.NetSet

* Use switch statment

* Renamed ip-whitelist to whitelist-ip

* Update documentation with a warning.

* Update pkg/apis/options/options.go

* Update CHANGELOG.md

Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>

* Update pkg/ip/net_set_test.go

Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>

* Update pkg/ip/net_set_test.go

Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>

* Update pkg/ip/net_set_test.go

Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>

* Apply suggestions from code review

Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>

* fix fmt

* Move ParseIPNet into abstraction

* Add warning in case of --reverse-proxy

* Update pkg/validation/options_test.go

* Rename --whitelist-ip to --trusted-ip

* Update oauthproxy.go

Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>

* fix

Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>
2020-07-11 11:10:58 +01:00
..
assets/js Initialise Jekyll site 2019-05-09 10:48:35 +01:00
configuration Implements --trusted-ip option (#552) 2020-07-11 11:10:58 +01:00
logos Add logos to docs folder 2019-10-30 09:57:24 +00:00
.gitignore Initialise Jekyll site 2019-05-09 10:48:35 +01:00
0_index.md Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
1_installation.md Update changelog ready for release v6.0.0 2020-06-27 12:10:27 +01:00
2_auth.md Make example args a codeblock 2020-07-06 12:04:16 +02:00
4_tls.md Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
5_endpoints.md Use double dashes in docs (#530) 2020-05-09 15:39:47 +01:00
6_request_signatures.md Fix links in docs 2019-08-11 16:07:03 +01:00
404.html Initialise Jekyll site 2019-05-09 10:48:35 +01:00
Gemfile Initialise Jekyll site 2019-05-09 10:48:35 +01:00
Gemfile.lock Bump activesupport from 6.0.2.1 to 6.0.3.1 in /docs 2020-05-27 08:55:47 +00:00
Makefile Add make targets for serving docs locally 2019-05-10 12:07:16 +01:00
README.md Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
_config.yml Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00

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).