Safe Haskell	None
Language	Haskell2010

Snap.Http.Server.Config

Contents

Proxy protocol selection

Description

This module exports the Config datatype, which you can use to configure the Snap HTTP server.

Synopsis

data Config m a
data ConfigLog
- = ConfigNoLog
- | ConfigFileLog FilePath
- | ConfigIoLog (ByteString -> IO ())
data ProxyType
emptyConfig :: Config m a
defaultConfig :: MonadSnap m => Config m a
commandLineConfig :: MonadSnap m => Config m a -> IO (Config m a)
extendedCommandLineConfig :: MonadSnap m => [OptDescr (Maybe (Config m a))] -> (a -> a -> a) -> Config m a -> IO (Config m a)
completeConfig :: MonadSnap m => Config m a -> IO (Config m a)
optDescrs :: forall m a. MonadSnap m => Config m a -> [OptDescr (Maybe (Config m a))]
fmapOpt :: (a -> b) -> OptDescr a -> OptDescr b
getAccessLog :: Config m a -> Maybe ConfigLog
getBind :: Config m a -> Maybe ByteString
getCompression :: Config m a -> Maybe Bool
getDefaultTimeout :: Config m a -> Maybe Int
getErrorHandler :: Config m a -> Maybe (SomeException -> m ())
getErrorLog :: Config m a -> Maybe ConfigLog
getHostname :: Config m a -> Maybe ByteString
getLocale :: Config m a -> Maybe String
getOther :: Config m a -> Maybe a
getPort :: Config m a -> Maybe Int
getProxyType :: Config m a -> Maybe ProxyType
getSSLBind :: Config m a -> Maybe ByteString
getSSLCert :: Config m a -> Maybe FilePath
getSSLKey :: Config m a -> Maybe FilePath
getSSLChainCert :: Config m a -> Maybe Bool
getSSLPort :: Config m a -> Maybe Int
getVerbose :: Config m a -> Maybe Bool
getStartupHook :: Config m a -> Maybe (StartupInfo m a -> IO ())
getUnixSocket :: Config m a -> Maybe FilePath
getUnixSocketAccessMode :: Config m a -> Maybe Int
setAccessLog :: ConfigLog -> Config m a -> Config m a
setBind :: ByteString -> Config m a -> Config m a
setCompression :: Bool -> Config m a -> Config m a
setDefaultTimeout :: Int -> Config m a -> Config m a
setErrorHandler :: (SomeException -> m ()) -> Config m a -> Config m a
setErrorLog :: ConfigLog -> Config m a -> Config m a
setHostname :: ByteString -> Config m a -> Config m a
setLocale :: String -> Config m a -> Config m a
setOther :: a -> Config m a -> Config m a
setPort :: Int -> Config m a -> Config m a
setProxyType :: ProxyType -> Config m a -> Config m a
setSSLBind :: ByteString -> Config m a -> Config m a
setSSLCert :: FilePath -> Config m a -> Config m a
setSSLKey :: FilePath -> Config m a -> Config m a
setSSLChainCert :: Bool -> Config m a -> Config m a
setSSLPort :: Int -> Config m a -> Config m a
setVerbose :: Bool -> Config m a -> Config m a
setUnixSocket :: FilePath -> Config m a -> Config m a
setUnixSocketAccessMode :: Int -> Config m a -> Config m a
setStartupHook :: (StartupInfo m a -> IO ()) -> Config m a -> Config m a
data StartupInfo m a
getStartupSockets :: StartupInfo m a -> [Socket]
getStartupConfig :: StartupInfo m a -> Config m a
noProxy :: ProxyType
xForwardedFor :: ProxyType
haProxy :: ProxyType

Documentation

data Config m a Source #

A record type which represents partial configurations (for httpServe) by wrapping all of its fields in a Maybe. Values of this type are usually constructed via its Monoid instance by doing something like:

setPort 1234 mempty

Any fields which are unspecified in the Config passed to httpServe (and this is the norm) are filled in with default values from defaultConfig.

Instances

Show (Config m a) Source #
Instance details Defined in Snap.Internal.Http.Server.Config Methods showsPrec :: Int -> Config m a -> ShowS show :: Config m a -> String showList :: [Config m a] -> ShowS
Semigroup (Config m a) Source #
Instance details Defined in Snap.Internal.Http.Server.Config Methods (<>) :: Config m a -> Config m a -> Config m a sconcat :: NonEmpty (Config m a) -> Config m a stimes :: Integral b => b -> Config m a -> Config m a
Monoid (Config m a) Source #
Instance details Defined in Snap.Internal.Http.Server.Config Methods mempty :: Config m a mappend :: Config m a -> Config m a -> Config m a mconcat :: [Config m a] -> Config m a

data ConfigLog Source #

Data type representing the configuration of a logging target

Constructors

ConfigNoLog	no logging
ConfigFileLog FilePath	log to text file
ConfigIoLog (ByteString -> IO ())	log custom IO handler

Instances

Show ConfigLog Source #
Instance details Defined in Snap.Internal.Http.Server.Config Methods showsPrec :: Int -> ConfigLog -> ShowS show :: ConfigLog -> String showList :: [ConfigLog] -> ShowS

data ProxyType Source #

FIXME

Note: this type changed in snap-server 1.0.0.0.

Instances

Eq ProxyType Source #
Instance details Defined in Snap.Internal.Http.Server.Config Methods (==) :: ProxyType -> ProxyType -> Bool (/=) :: ProxyType -> ProxyType -> Bool
Show ProxyType Source #
Instance details Defined in Snap.Internal.Http.Server.Config Methods showsPrec :: Int -> ProxyType -> ShowS show :: ProxyType -> String showList :: [ProxyType] -> ShowS

emptyConfig :: Config m a Source #

Returns a completely empty Config. Equivalent to mempty from Config's Monoid instance.

defaultConfig :: MonadSnap m => Config m a Source #

These are the default values for the options

commandLineConfig Source #

Arguments

:: MonadSnap m
=> Config m a	default configuration. This is combined with `defaultConfig` to obtain default values to use if the given parameter is specified on the command line. Usually it is fine to use `emptyConfig` here.
-> IO (Config m a)

Returns a Config obtained from parsing command-line options, using the default Snap OptDescr set.

On Unix systems, the locale is read from the LANG environment variable.

extendedCommandLineConfig Source #

Arguments

:: MonadSnap m
=> [OptDescr (Maybe (Config m a))]	User options.
-> (a -> a -> a)	State for multiple invoked user command-line options will be combined using this function.
-> Config m a	default configuration. This is combined with Snap's `defaultConfig` to obtain default values to use if the given parameter is specified on the command line. Usually it is fine to use `emptyConfig` here.
-> IO (Config m a)

Returns a Config obtained from parsing command-line options, using the default Snap OptDescr set as well as a list of user OptDescrs. User OptDescrs use the "other" field (accessible using getOther and setOther) to store additional command-line option state. These are combined using a user-defined combining function.

On Unix systems, the locale is read from the LANG environment variable.

completeConfig :: MonadSnap m => Config m a -> IO (Config m a) Source #

optDescrs Source #

Arguments

:: MonadSnap m
=> Config m a	the configuration defaults.
-> [OptDescr (Maybe (Config m a))]

Returns a description of the snap command line options suitable for use with System.Console.GetOpt.

fmapOpt :: (a -> b) -> OptDescr a -> OptDescr b Source #

getAccessLog :: Config m a -> Maybe ConfigLog Source #

Path to the access log

getBind :: Config m a -> Maybe ByteString Source #

Returns the address to bind to (for http)

getCompression :: Config m a -> Maybe Bool Source #

If set and set to True, compression is turned on when applicable

getDefaultTimeout :: Config m a -> Maybe Int Source #

getErrorHandler :: Config m a -> Maybe (SomeException -> m ()) Source #

A MonadSnap action to handle 500 errors

getErrorLog :: Config m a -> Maybe ConfigLog Source #

Path to the error log

getHostname :: Config m a -> Maybe ByteString Source #

The hostname of the HTTP server. This field has the same format as an HTTP Host header; if a Host header came in with the request, we use that, otherwise we default to this value specified in the configuration.

getLocale :: Config m a -> Maybe String Source #

Gets the locale to use. Locales are used on Unix only, to set the LANG/LC_ALL/etc. environment variable. For instance if you set the locale to "en_US", we'll set the relevant environment variables to "en_US.UTF-8".

getOther :: Config m a -> Maybe a Source #

getPort :: Config m a -> Maybe Int Source #

Returns the port to listen on (for http)

getProxyType :: Config m a -> Maybe ProxyType Source #

getSSLBind :: Config m a -> Maybe ByteString Source #

Returns the address to bind to (for https)

getSSLCert :: Config m a -> Maybe FilePath Source #

Path to the SSL certificate file

getSSLKey :: Config m a -> Maybe FilePath Source #

Path to the SSL key file

getSSLChainCert :: Config m a -> Maybe Bool Source #

Path to the SSL certificate file

getSSLPort :: Config m a -> Maybe Int Source #

Returns the port to listen on (for https)

getVerbose :: Config m a -> Maybe Bool Source #

Whether to write server status updates to stderr

getStartupHook :: Config m a -> Maybe (StartupInfo m a -> IO ()) Source #

A startup hook is run after the server initializes but before user request processing begins. The server passes, through a StartupInfo object, the startup hook a list of the sockets it is listening on and the final Config object completed after command-line processing.

getUnixSocket :: Config m a -> Maybe FilePath Source #

File path to unix socket. Must be absolute path, but allows for symbolic links.

getUnixSocketAccessMode :: Config m a -> Maybe Int Source #

Access mode for unix socket, by default is system specific. This should only be used to grant additional permissions to created socket file, and not to remove permissions set by default. The only portable way to limit access to socket is creating it in a directory with proper permissions set.

Most BSD systems ignore access permissions on unix sockets.

Note: This uses umask. There is a race condition if process creates other files at the same time as opening a unix socket with this option set.

setAccessLog :: ConfigLog -> Config m a -> Config m a Source #

setBind :: ByteString -> Config m a -> Config m a Source #

setCompression :: Bool -> Config m a -> Config m a Source #

setDefaultTimeout :: Int -> Config m a -> Config m a Source #

setErrorHandler :: (SomeException -> m ()) -> Config m a -> Config m a Source #

setErrorLog :: ConfigLog -> Config m a -> Config m a Source #

setHostname :: ByteString -> Config m a -> Config m a Source #

setLocale :: String -> Config m a -> Config m a Source #

setOther :: a -> Config m a -> Config m a Source #

setPort :: Int -> Config m a -> Config m a Source #

setProxyType :: ProxyType -> Config m a -> Config m a Source #

setSSLBind :: ByteString -> Config m a -> Config m a Source #

setSSLCert :: FilePath -> Config m a -> Config m a Source #

setSSLKey :: FilePath -> Config m a -> Config m a Source #

setSSLChainCert :: Bool -> Config m a -> Config m a Source #

setSSLPort :: Int -> Config m a -> Config m a Source #

setVerbose :: Bool -> Config m a -> Config m a Source #

setUnixSocket :: FilePath -> Config m a -> Config m a Source #

setUnixSocketAccessMode :: Int -> Config m a -> Config m a Source #

setStartupHook :: (StartupInfo m a -> IO ()) -> Config m a -> Config m a Source #

data StartupInfo m a Source #

Arguments passed to setStartupHook.

getStartupSockets :: StartupInfo m a -> [Socket] Source #

The Sockets opened by the server. There will be two Sockets for SSL connections, and one otherwise.

getStartupConfig :: StartupInfo m a -> Config m a Source #

Proxy protocol selection

noProxy :: ProxyType Source #

Configure Snap in direct / non-proxying mode.

xForwardedFor :: ProxyType Source #

Assert that Snap is running behind an HTTP proxy, and that the proxied connection information will be stored in the "X-Forwarded-For" or "Forwarded-For" HTTP headers.

haProxy :: ProxyType Source #

Assert that Snap is running behind a proxy running the HaProxy protocol (see http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt). In this mode connections that don't obey the proxy protocol are rejected.