Add note on changed flush-interval behaviour
This commit is contained in:
		
							parent
							
								
									5b95ed3552
								
							
						
					
					
						commit
						09c6bd77ed
					
				
							
								
								
									
										18
									
								
								CHANGELOG.md
								
								
								
								
							
							
						
						
									
										18
									
								
								CHANGELOG.md
								
								
								
								
							|  | @ -13,11 +13,15 @@ | ||||||
| 
 | 
 | ||||||
| ## Important notes | ## Important notes | ||||||
| 
 | 
 | ||||||
| If you have been using [#bitly/621](https://github.com/bitly/oauth2_proxy/pull/621) | - If you have been using [#bitly/621](https://github.com/bitly/oauth2_proxy/pull/621) | ||||||
| and have cookies larger than the 4kb limit, |   and have cookies larger than the 4kb limit, | ||||||
| the cookie splitting pattern has changed and now uses `_` in place of `-` when |   the cookie splitting pattern has changed and now uses `_` in place of `-` when | ||||||
| indexing cookies. |   indexing cookies. | ||||||
| This will force users to reauthenticate the first time they use `v3.1.0`. |   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 | ## 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 |   - Implement token refreshing in OIDC provider | ||||||
|   - Split cookies larger than 4k limit into multiple cookies |   - Split cookies larger than 4k limit into multiple cookies | ||||||
|   - Implement token validation in OIDC provider |   - 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 |   - 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) | - [#21](https://github.com/pusher/oauth2_proxy/pull/21) Docker Improvement (@yaegashi) | ||||||
|   - Move Docker base image from debian to alpine |   - Move Docker base image from debian to alpine | ||||||
|   - Install ca-certificates in docker image |   - 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 <timeperiod> (1 second by default) |   - Long-running upstream responses will get flushed every <timeperiod> (1 second by default) | ||||||
| - [#24](https://github.com/pusher/oauth2_proxy/pull/24) Redirect fix (@agentgonzo) | - [#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 / |   - After a successful login, you will be redirected to your original URL rather than / | ||||||
|  |  | ||||||
|  | @ -201,6 +201,7 @@ Usage of oauth2_proxy: | ||||||
|   -custom-templates-dir string: path to custom html templates |   -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) |   -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 |   -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. |   -footer string: custom footer string. Use "-" to disable default footer. | ||||||
|   -github-org string: restrict logins to members of this organisation |   -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 |   -github-team string: restrict logins to members of any of these teams (slug), separated by a comma | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue