From 09c6bd77ed50cf2958d5fd695084b2a3d183c402 Mon Sep 17 00:00:00 2001 From: Joel Speed Date: Fri, 8 Feb 2019 14:16:41 +0000 Subject: [PATCH] Add note on changed flush-interval behaviour --- CHANGELOG.md | 18 +++++++++++------- README.md | 1 + 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e128df..b72f7c1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,11 +13,15 @@ ## Important notes -If you have been using [#bitly/621](https://github.com/bitly/oauth2_proxy/pull/621) -and have cookies larger than the 4kb limit, -the cookie splitting pattern has changed and now uses `_` in place of `-` when -indexing cookies. -This will force users to reauthenticate the first time they use `v3.1.0`. +- If you have been using [#bitly/621](https://github.com/bitly/oauth2_proxy/pull/621) + and have cookies larger than the 4kb limit, + the cookie splitting pattern has changed and now uses `_` in place of `-` when + indexing cookies. + This will force users to reauthenticate the first time they use `v3.1.0`. +- Streamed responses will now be flushed every 1 second by default. + Previously streamed responses were flushed only when the buffer was full. + To retain the old behaviour set `--flush-interval=0`. + See [#23](https://github.com/pusher/oauth2_proxy/pull/23) for further details. ## Changes since v3.0.0 @@ -26,12 +30,12 @@ This will force users to reauthenticate the first time they use `v3.1.0`. - Implement token refreshing in OIDC provider - Split cookies larger than 4k limit into multiple cookies - Implement token validation in OIDC provider -- [#15](https://github.com/pusher/oauth2_proxy/pull/21) WhitelistDomains (@joelspeed) +- [#15](https://github.com/pusher/oauth2_proxy/pull/15) WhitelistDomains (@joelspeed) - Add `--whitelist-domain` flag to allow redirection to approved domains after OAuth flow - [#21](https://github.com/pusher/oauth2_proxy/pull/21) Docker Improvement (@yaegashi) - Move Docker base image from debian to alpine - Install ca-certificates in docker image -- [#23](https://github.com/pusher/oauth2_proxy/pull/21) Flushed streaming responses +- [#23](https://github.com/pusher/oauth2_proxy/pull/23) Flushed streaming responses - Long-running upstream responses will get flushed every (1 second by default) - [#24](https://github.com/pusher/oauth2_proxy/pull/24) Redirect fix (@agentgonzo) - After a successful login, you will be redirected to your original URL rather than / diff --git a/README.md b/README.md index a0ea9d9..deaa039 100644 --- a/README.md +++ b/README.md @@ -201,6 +201,7 @@ Usage of oauth2_proxy: -custom-templates-dir string: path to custom html templates -display-htpasswd-form: display username / password login form if an htpasswd file is provided (default true) -email-domain value: authenticate emails with the specified domain (may be given multiple times). Use * to authenticate any email + -flush-interval: period between flushing response buffers when streaming responses (default "1s") -footer string: custom footer string. Use "-" to disable default footer. -github-org string: restrict logins to members of this organisation -github-team string: restrict logins to members of any of these teams (slug), separated by a comma