Snap.Http.Server.Config

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

Documentation

data Config m a

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

Typeable1 m => Typeable1 (Config m)

Show (Config m a)

Monoid (Config m a)

data ConfigBackend

This datatype allows you to override which backend (either simple or libev) to use. Most users will not want to set this, preferring to rely on the compile-type default.

Note that if you specify the libev backend and have not compiled in support for it, your server will fail at runtime.

Constructors

ConfigSimpleBackend

ConfigLibEvBackend

Instances

Eq ConfigBackend

Show ConfigBackend

data ConfigLog

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

emptyConfig :: Config m a

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

defaultConfig :: MonadSnap m => Config m a

These are the default values for the options

commandLineConfig

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 the options specified on the command-line.

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

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

optDescrs

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.

getAccessLog :: Config m a -> Maybe ConfigLog

Path to the access log

getBackend :: Config m a -> Maybe ConfigBackend

getBind :: Config m a -> Maybe ByteString

Returns the address to bind to (for http)

getCompression :: Config m a -> Maybe Bool

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

getDefaultTimeout :: Config m a -> Maybe Int

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

A MonadSnap action to handle 500 errors

getErrorLog :: Config m a -> Maybe ConfigLog

Path to the error log

getHostname :: Config m a -> Maybe ByteString

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

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

getPort :: Config m a -> Maybe Int

Returns the port to listen on (for http)

getProxyType :: Config m a -> Maybe ProxyType

getSSLBind :: Config m a -> Maybe ByteString

Returns the address to bind to (for https)

getSSLCert :: Config m a -> Maybe FilePath

Path to the SSL certificate file

getSSLKey :: Config m a -> Maybe FilePath

Path to the SSL key file

getSSLPort :: Config m a -> Maybe Int

Returns the port to listen on (for https)

getVerbose :: Config m a -> Maybe Bool

Whether to write server status updates to stderr

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

setBackend :: ConfigBackend -> 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

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

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