oauth2-proxy/docs
T S 513af9b714 Escape original request URI in sample kubernetes ingress configuration
The current sample configuration for kubernetes ingress demonstrates
using the `auth-signin` annotation to redirect a user to oauth2_proxy's
signin page. It constructs the link to do so by directly concatenating
`$request_uri` as the `rd` parameter, so the sign-in page knows where to
send the user after signin is complete.

However, this does not work correctly if the original request URI
contains multiple query parameters separated by an ampersand, as that
ampersand is interpereted as separating query parameters of the
`/oauth2/start` URI. For example:

If the user requests a URL:
  https://example.com/foo?q1=v1&q2=v2
they may be redirected to the signin url
  https://example.com/oauth2/start?rd=https://example.com/foo?q1=v1&q2=v2
and after completing signin, oauth2_proxy will redirect them to
  https://example.com/foo?q1=v1

nginx-ingress added an $escaped_request_uri variable about a year ago,
to help resolve this kind of issue
(https://github.com/kubernetes/ingress-nginx/pull/2811)
2019-10-01 12:28:00 -07:00
..
assets/js Initialise Jekyll site 2019-05-09 10:48:35 +01:00
configuration Escape original request URI in sample kubernetes ingress configuration 2019-10-01 12:28:00 -07:00
.gitignore Initialise Jekyll site 2019-05-09 10:48:35 +01:00
0_index.md Fix links in docs 2019-08-11 16:07:03 +01:00
1_installation.md Shorten README.md (#154) 2019-05-10 12:25:05 +01:00
2_auth.md Merge branch 'master' into keycloak-provider 2019-08-17 08:10:37 +01:00
4_tls.md indent content in ordered list, fixes 165 2019-08-10 21:46:13 -07:00
5_endpoints.md split README.MD into pages 2019-05-09 11:06:32 +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 nokogiri from 1.10.1 to 1.10.4 in /docs 2019-08-21 10:05:52 +00:00
Makefile Add make targets for serving docs locally 2019-05-10 12:07:16 +01:00
README.md Add make targets for serving docs locally 2019-05-10 12:07:16 +01:00
_config.yml Fix links in docs 2019-08-11 16:07:03 +01:00

README.md

Docs

This folder contains our Jekyll based docs site which is hosted at https://pusher.github.io/oauth2_proxy.

When making changes to this docs site, please test your changes locally:

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