Safe Haskell	Safe-Inferred
Language	Haskell98

Keter.Config

Description

This does a merger of V04 and V10 Effectivelly this provides the latest config.

Synopsis

data PortSettings = PortSettings {
- portRange :: [Port]
}
data TLSConfig = TLSConfig !Settings !FilePath !FilePath (Maybe Config)
data BundleConfig = BundleConfig {
- bconfigStanzas :: !(Vector (Stanza ()))
- bconfigPlugins :: !Object
}
data WebAppConfig port = WebAppConfig {
- waconfigExec :: !FilePath
- waconfigArgs :: !(Vector Text)
- waconfigEnvironment :: !(Map Text Text)
- waconfigApprootHost :: !Host
- waconfigHosts :: !(Set Host)
- waconfigSsl :: !SSLConfig
- waconfigPort :: !port
- waconfigForwardEnv :: !(Set Text)
- waconfigTimeout :: !(Maybe Int)
- waconfigEnsureAliveTimeout :: !(Maybe Int)
}
data RedirectConfig = RedirectConfig {
- redirconfigHosts :: !(Set Host)
- redirconfigStatus :: !Int
- redirconfigActions :: !(Vector RedirectAction)
- redirconfigSsl :: !SSLConfig
}
data StaticFilesConfig = StaticFilesConfig {
- sfconfigRoot :: !FilePath
- sfconfigHosts :: !(Set Host)
- sfconfigListings :: !Bool
- sfconfigMiddleware :: ![MiddlewareConfig]
- sfconfigTimeout :: !(Maybe Int)
- sfconfigSsl :: !SSLConfig
}
data KeterConfig = KeterConfig {
- kconfigDir :: FilePath
- kconfigPortPool :: PortSettings
- kconfigListeners :: !(NonEmptyVector ListeningPort)
- kconfigSetuid :: Maybe Text
- kconfigBuiltinStanzas :: !(Vector (Stanza ()))
- kconfigIpFromHeader :: Bool
- kconfigExternalHttpPort :: !Int
- kconfigExternalHttpsPort :: !Int
- kconfigEnvironment :: !(Map Text Text)
- kconfigConnectionTimeBound :: !Int
- kconfigCliPort :: !(Maybe Port)
- kconfigUnknownHostResponse :: !(Maybe FilePath)
- kconfigMissingHostResponse :: !(Maybe FilePath)
- kconfigProxyException :: !(Maybe FilePath)
- kconfigRotateLogs :: !Bool
- kconfigHealthcheckPath :: !(Maybe Text)
}
data Stanza port = Stanza (StanzaRaw port) RequiresSecure
data StanzaRaw port
- = StanzaStaticFiles !StaticFilesConfig
- | StanzaRedirect !RedirectConfig
- | StanzaWebApp !(WebAppConfig port)
- | StanzaReverseProxy !ReverseProxyConfig ![MiddlewareConfig] !(Maybe Int)
- | StanzaBackground !BackgroundConfig
type ProxyAction = (ProxyActionRaw, RequiresSecure)
data ProxyActionRaw
- = PAPort Port !(Maybe Int)
- | PAStatic StaticFilesConfig
- | PARedirect RedirectConfig
- | PAReverseProxy ReverseProxyConfig ![MiddlewareConfig] !(Maybe Int)
data RedirectDest
- = RDUrl !Text
- | RDPrefix !IsSecure !Host !(Maybe Port)
data RedirectAction = RedirectAction !SourcePath !RedirectDest
data SourcePath
- = SPAny
- | SPSpecific !Text
data ListeningPort
- = LPSecure !HostPreference !Port !FilePath !(Vector FilePath) !FilePath !Bool
- | LPInsecure !HostPreference !Port
data AppInput
- = AIBundle !FilePath !EpochTime
- | AIData !BundleConfig
data BackgroundConfig = BackgroundConfig {
- bgconfigExec :: !FilePath
- bgconfigArgs :: !(Vector Text)
- bgconfigEnvironment :: !(Map Text Text)
- bgconfigRestartCount :: !RestartCount
- bgconfigRestartDelaySeconds :: !Word
- bgconfigForwardEnv :: !(Set Text)
}
data RestartCount
- = UnlimitedRestarts
- | LimitedRestarts !Word
type RequiresSecure = Bool

Documentation

data PortSettings Source #

Controls execution of the nginx thread. Follows the settings type pattern. See: http://www.yesodweb.com/book/settings-types.

Constructors

PortSettings
Fields portRange :: [Port] Which ports to assign to apps. Defaults to unassigned ranges from IANA

Instances

Instances details

FromJSON PortSettings Source #
Instance details Defined in Keter.Config.V04 Methods parseJSON :: Value -> Parser PortSettings # parseJSONList :: Value -> Parser [PortSettings] # omittedField :: Maybe PortSettings #

data TLSConfig Source #

Constructors

TLSConfig !Settings !FilePath !FilePath (Maybe Config)

Instances

Instances details

ParseYamlFile TLSConfig Source #
Instance details Defined in Keter.Config.V04 Methods parseYamlFile :: BaseDir -> Value -> Parser TLSConfig Source #

data BundleConfig Source #

Constructors

BundleConfig
Fields bconfigStanzas :: !(Vector (Stanza ())) bconfigPlugins :: !Object settings used for plugins

Instances

Instances details

ToJSON BundleConfig Source #
Instance details Defined in Keter.Config.V10 Methods toJSON :: BundleConfig -> Value # toEncoding :: BundleConfig -> Encoding # toJSONList :: [BundleConfig] -> Value # toEncodingList :: [BundleConfig] -> Encoding # omitField :: BundleConfig -> Bool #
Show BundleConfig Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> BundleConfig -> ShowS # show :: BundleConfig -> String # showList :: [BundleConfig] -> ShowS #
ToCurrent BundleConfig Source #
Instance details Defined in Keter.Config.V10 Associated Types type Previous BundleConfig Source # Methods toCurrent :: Previous BundleConfig -> BundleConfig Source #
ParseYamlFile BundleConfig Source #
Instance details Defined in Keter.Config.V10 Methods parseYamlFile :: BaseDir -> Value -> Parser BundleConfig Source #
type Previous BundleConfig Source #
Instance details Defined in Keter.Config.V10 type Previous BundleConfig = BundleConfig

data WebAppConfig port Source #

Constructors

WebAppConfig

Fields

waconfigExec :: !FilePath
waconfigArgs :: !(Vector Text)
waconfigEnvironment :: !(Map Text Text)
waconfigApprootHost :: !Host
primary host, used for approot
waconfigHosts :: !(Set Host)
all hosts, not including the approot host
waconfigSsl :: !SSLConfig
waconfigPort :: !port
waconfigForwardEnv :: !(Set Text)
waconfigTimeout :: !(Maybe Int)
how long are connections supposed to last
waconfigEnsureAliveTimeout :: !(Maybe Int)
how long in microseconds the app gets before we expect it to bind to a port (default 90 seconds)

Instances

Instances details

ToJSON (WebAppConfig ()) Source #
Instance details Defined in Keter.Config.V10 Methods toJSON :: WebAppConfig () -> Value # toEncoding :: WebAppConfig () -> Encoding # toJSONList :: [WebAppConfig ()] -> Value # toEncodingList :: [WebAppConfig ()] -> Encoding # omitField :: WebAppConfig () -> Bool #
Show port => Show (WebAppConfig port) Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> WebAppConfig port -> ShowS # show :: WebAppConfig port -> String # showList :: [WebAppConfig port] -> ShowS #
ToCurrent (WebAppConfig ()) Source #
Instance details Defined in Keter.Config.V10 Associated Types type Previous (WebAppConfig ()) Source # Methods toCurrent :: Previous (WebAppConfig ()) -> WebAppConfig () Source #
ParseYamlFile (WebAppConfig ()) Source #
Instance details Defined in Keter.Config.V10 Methods parseYamlFile :: BaseDir -> Value -> Parser (WebAppConfig ()) Source #
type Previous (WebAppConfig ()) Source #
Instance details Defined in Keter.Config.V10 type Previous (WebAppConfig ()) = AppConfig

data RedirectConfig Source #

Constructors

RedirectConfig
Fields redirconfigHosts :: !(Set Host) redirconfigStatus :: !Int redirconfigActions :: !(Vector RedirectAction) redirconfigSsl :: !SSLConfig

Instances

Instances details

ToJSON RedirectConfig Source #
Instance details Defined in Keter.Config.V10 Methods toJSON :: RedirectConfig -> Value # toEncoding :: RedirectConfig -> Encoding # toJSONList :: [RedirectConfig] -> Value # toEncodingList :: [RedirectConfig] -> Encoding # omitField :: RedirectConfig -> Bool #
Show RedirectConfig Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> RedirectConfig -> ShowS # show :: RedirectConfig -> String # showList :: [RedirectConfig] -> ShowS #
ToCurrent RedirectConfig Source #
Instance details Defined in Keter.Config.V10 Associated Types type Previous RedirectConfig Source # Methods toCurrent :: Previous RedirectConfig -> RedirectConfig Source #
ParseYamlFile RedirectConfig Source #
Instance details Defined in Keter.Config.V10 Methods parseYamlFile :: BaseDir -> Value -> Parser RedirectConfig Source #
type Previous RedirectConfig Source #
Instance details Defined in Keter.Config.V10 type Previous RedirectConfig = Redirect

data StaticFilesConfig Source #

Constructors

StaticFilesConfig
Fields sfconfigRoot :: !FilePath sfconfigHosts :: !(Set Host) sfconfigListings :: !Bool sfconfigMiddleware :: ![MiddlewareConfig] sfconfigTimeout :: !(Maybe Int) sfconfigSsl :: !SSLConfig

Instances

Instances details

ToJSON StaticFilesConfig Source #
Instance details Defined in Keter.Config.V10 Methods toJSON :: StaticFilesConfig -> Value # toEncoding :: StaticFilesConfig -> Encoding # toJSONList :: [StaticFilesConfig] -> Value # toEncodingList :: [StaticFilesConfig] -> Encoding # omitField :: StaticFilesConfig -> Bool #
Show StaticFilesConfig Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> StaticFilesConfig -> ShowS # show :: StaticFilesConfig -> String # showList :: [StaticFilesConfig] -> ShowS #
ToCurrent StaticFilesConfig Source #
Instance details Defined in Keter.Config.V10 Associated Types type Previous StaticFilesConfig Source # Methods toCurrent :: Previous StaticFilesConfig -> StaticFilesConfig Source #
ParseYamlFile StaticFilesConfig Source #
Instance details Defined in Keter.Config.V10 Methods parseYamlFile :: BaseDir -> Value -> Parser StaticFilesConfig Source #
type Previous StaticFilesConfig Source #
Instance details Defined in Keter.Config.V10 type Previous StaticFilesConfig = StaticHost

data KeterConfig Source #

Constructors

KeterConfig

Fields

kconfigDir :: FilePath
kconfigPortPool :: PortSettings
kconfigListeners :: !(NonEmptyVector ListeningPort)
kconfigSetuid :: Maybe Text
kconfigBuiltinStanzas :: !(Vector (Stanza ()))
kconfigIpFromHeader :: Bool
kconfigExternalHttpPort :: !Int
External HTTP port when generating APPROOTs.
kconfigExternalHttpsPort :: !Int
External HTTPS port when generating APPROOTs.
kconfigEnvironment :: !(Map Text Text)
Environment variables to be passed to all apps.
kconfigConnectionTimeBound :: !Int
Maximum request time in milliseconds per connection.
kconfigCliPort :: !(Maybe Port)
Port for the cli to listen on
kconfigUnknownHostResponse :: !(Maybe FilePath)
kconfigMissingHostResponse :: !(Maybe FilePath)
kconfigProxyException :: !(Maybe FilePath)
kconfigRotateLogs :: !Bool
kconfigHealthcheckPath :: !(Maybe Text)

Instances

Instances details

ToCurrent KeterConfig Source #
Instance details Defined in Keter.Config.V10 Associated Types type Previous KeterConfig Source # Methods toCurrent :: Previous KeterConfig -> KeterConfig Source #
ParseYamlFile KeterConfig Source #
Instance details Defined in Keter.Config.V10 Methods parseYamlFile :: BaseDir -> Value -> Parser KeterConfig Source #
type Previous KeterConfig Source #
Instance details Defined in Keter.Config.V10 type Previous KeterConfig = KeterConfig

data Stanza port Source #

Constructors

Stanza (StanzaRaw port) RequiresSecure

Instances

Instances details

ToJSON (Stanza ()) Source #
Instance details Defined in Keter.Config.V10 Methods toJSON :: Stanza () -> Value # toEncoding :: Stanza () -> Encoding # toJSONList :: [Stanza ()] -> Value # toEncodingList :: [Stanza ()] -> Encoding # omitField :: Stanza () -> Bool #
Show port => Show (Stanza port) Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> Stanza port -> ShowS # show :: Stanza port -> String # showList :: [Stanza port] -> ShowS #
ParseYamlFile (Stanza ()) Source #
Instance details Defined in Keter.Config.V10 Methods parseYamlFile :: BaseDir -> Value -> Parser (Stanza ()) Source #

data StanzaRaw port Source #

Constructors

StanzaStaticFiles !StaticFilesConfig
StanzaRedirect !RedirectConfig
StanzaWebApp !(WebAppConfig port)
StanzaReverseProxy !ReverseProxyConfig ![MiddlewareConfig] !(Maybe Int)
StanzaBackground !BackgroundConfig

Instances

Instances details

ToJSON (StanzaRaw ()) Source #
Instance details Defined in Keter.Config.V10 Methods toJSON :: StanzaRaw () -> Value # toEncoding :: StanzaRaw () -> Encoding # toJSONList :: [StanzaRaw ()] -> Value # toEncodingList :: [StanzaRaw ()] -> Encoding # omitField :: StanzaRaw () -> Bool #
Show port => Show (StanzaRaw port) Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> StanzaRaw port -> ShowS # show :: StanzaRaw port -> String # showList :: [StanzaRaw port] -> ShowS #

type ProxyAction = (ProxyActionRaw, RequiresSecure) Source #

data ProxyActionRaw Source #

An action to be performed for a requested hostname.

This datatype is very similar to Stanza, but is necessarily separate since:

Webapps will be assigned ports.
Not all stanzas have an associated proxy action.

Constructors

PAPort Port !(Maybe Int)
PAStatic StaticFilesConfig
PARedirect RedirectConfig
PAReverseProxy ReverseProxyConfig ![MiddlewareConfig] !(Maybe Int)

Instances

Instances details

Show ProxyActionRaw Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> ProxyActionRaw -> ShowS # show :: ProxyActionRaw -> String # showList :: [ProxyActionRaw] -> ShowS #

data RedirectDest Source #

Constructors

RDUrl !Text
RDPrefix !IsSecure !Host !(Maybe Port)

Instances

Instances details

FromJSON RedirectDest Source #
Instance details Defined in Keter.Config.V10 Methods parseJSON :: Value -> Parser RedirectDest # parseJSONList :: Value -> Parser [RedirectDest] # omittedField :: Maybe RedirectDest #
ToJSON RedirectDest Source #
Instance details Defined in Keter.Config.V10 Methods toJSON :: RedirectDest -> Value # toEncoding :: RedirectDest -> Encoding # toJSONList :: [RedirectDest] -> Value # toEncodingList :: [RedirectDest] -> Encoding # omitField :: RedirectDest -> Bool #
Show RedirectDest Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> RedirectDest -> ShowS # show :: RedirectDest -> String # showList :: [RedirectDest] -> ShowS #

data RedirectAction Source #

Constructors

RedirectAction !SourcePath !RedirectDest

Instances

Instances details

FromJSON RedirectAction Source #
Instance details Defined in Keter.Config.V10 Methods parseJSON :: Value -> Parser RedirectAction # parseJSONList :: Value -> Parser [RedirectAction] # omittedField :: Maybe RedirectAction #
ToJSON RedirectAction Source #
Instance details Defined in Keter.Config.V10 Methods toJSON :: RedirectAction -> Value # toEncoding :: RedirectAction -> Encoding # toJSONList :: [RedirectAction] -> Value # toEncodingList :: [RedirectAction] -> Encoding # omitField :: RedirectAction -> Bool #
Show RedirectAction Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> RedirectAction -> ShowS # show :: RedirectAction -> String # showList :: [RedirectAction] -> ShowS #

data SourcePath Source #

Constructors

SPAny
SPSpecific !Text

Instances

Instances details

Show SourcePath Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> SourcePath -> ShowS # show :: SourcePath -> String # showList :: [SourcePath] -> ShowS #

data ListeningPort Source #

Constructors

LPSecure !HostPreference !Port !FilePath !(Vector FilePath) !FilePath !Bool
LPInsecure !HostPreference !Port

Instances

Instances details

ParseYamlFile ListeningPort Source #
Instance details Defined in Keter.Config.V10 Methods parseYamlFile :: BaseDir -> Value -> Parser ListeningPort Source #

data AppInput Source #

Constructors

AIBundle !FilePath !EpochTime
AIData !BundleConfig

Instances

Instances details

Show AppInput Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> AppInput -> ShowS # show :: AppInput -> String # showList :: [AppInput] -> ShowS #

data BackgroundConfig Source #

Constructors

BackgroundConfig
Fields bgconfigExec :: !FilePath bgconfigArgs :: !(Vector Text) bgconfigEnvironment :: !(Map Text Text) bgconfigRestartCount :: !RestartCount bgconfigRestartDelaySeconds :: !Word bgconfigForwardEnv :: !(Set Text)

Instances

Instances details

ToJSON BackgroundConfig Source #
Instance details Defined in Keter.Config.V10 Methods toJSON :: BackgroundConfig -> Value # toEncoding :: BackgroundConfig -> Encoding # toJSONList :: [BackgroundConfig] -> Value # toEncodingList :: [BackgroundConfig] -> Encoding # omitField :: BackgroundConfig -> Bool #
Show BackgroundConfig Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> BackgroundConfig -> ShowS # show :: BackgroundConfig -> String # showList :: [BackgroundConfig] -> ShowS #
ParseYamlFile BackgroundConfig Source #
Instance details Defined in Keter.Config.V10 Methods parseYamlFile :: BaseDir -> Value -> Parser BackgroundConfig Source #

data RestartCount Source #

Constructors

UnlimitedRestarts
LimitedRestarts !Word

Instances

Instances details

FromJSON RestartCount Source #
Instance details Defined in Keter.Config.V10 Methods parseJSON :: Value -> Parser RestartCount # parseJSONList :: Value -> Parser [RestartCount] # omittedField :: Maybe RestartCount #
Show RestartCount Source #
Instance details Defined in Keter.Config.V10 Methods showsPrec :: Int -> RestartCount -> ShowS # show :: RestartCount -> String # showList :: [RestartCount] -> ShowS #

type RequiresSecure = Bool Source #

Whether we should force redirect to HTTPS routes.