on master help sign in
Minor doc improvements
1977a1aMichael Snoyman
warp/ChangeLog.md+7
@@ -1,3 +1,10 @@
1+## 3.0.5
2+
3+Support for PROXY protocol, such as used by Amazon ELB TCP. This is useful
4+since, for example, Amazon ELB HTTP does *not* have support for Websockets.
5+More information on the protocol [is available from
6+Amazon](http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#proxy-protocol).
7+
1## 3.0.4
8## 3.0.4
2
9
3Added `setFork`.
10Added `setFork`.
warp/Network/Wai/Handler/Warp.hs+6
@@ -246,6 +246,8 @@ setFork :: (((forall a. IO a -> IO a) -> IO ()) -> IO ()) -> Settings -> Setting
246setFork fork' s = s { settingsFork = fork' }
246setFork fork' s = s { settingsFork = fork' }
247
247
248-- | Do not use the PROXY protocol.
248-- | Do not use the PROXY protocol.
249+--
250+-- Since 3.0.5
249setProxyProtocolNone :: Settings -> Settings
251setProxyProtocolNone :: Settings -> Settings
250setProxyProtocolNone y = y { settingsProxyProtocol = ProxyProtocolNone }
252setProxyProtocolNone y = y { settingsProxyProtocol = ProxyProtocolNone }
251
253
@@ -260,6 +262,8 @@ setProxyProtocolNone y = y { settingsProxyProtocol = ProxyProtocolNone }
260--
262--
261-- Only the human-readable header format (version 1) is supported. The binary
263-- Only the human-readable header format (version 1) is supported. The binary
262-- header format (version 2) is /not/ supported.
264-- header format (version 2) is /not/ supported.
265+--
266+-- Since 3.0.5
263setProxyProtocolRequired :: Settings -> Settings
267setProxyProtocolRequired :: Settings -> Settings
264setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }
268setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }
265
269
@@ -274,5 +278,7 @@ setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }
274-- such as if a load balancer health check uses regular
278-- such as if a load balancer health check uses regular
275-- HTTP without the PROXY header, but proxied
279-- HTTP without the PROXY header, but proxied
276-- connections /do/ include the PROXY header.
280-- connections /do/ include the PROXY header.
281+--
282+-- Since 3.0.5
277setProxyProtocolOptional :: Settings -> Settings
283setProxyProtocolOptional :: Settings -> Settings
278setProxyProtocolOptional y = y { settingsProxyProtocol = ProxyProtocolOptional }
284setProxyProtocolOptional y = y { settingsProxyProtocol = ProxyProtocolOptional }