diff --git a/src/Vervis/Settings.hs b/src/Vervis/Settings.hs index b6fd022..5b0b19f 100644 --- a/src/Vervis/Settings.hs +++ b/src/Vervis/Settings.hs @@ -43,40 +43,40 @@ import Yesod.Default.Util (WidgetFileSettings, widgetFileNoReload, -- loaded from various sources: defaults, environment variables, config files, -- theoretically even a database. data AppSettings = AppSettings - { appStaticDir :: String - -- ^ Directory from which to serve static files. + { -- | Directory from which to serve static files. + appStaticDir :: String + -- | Configuration settings for accessing the database. , appDatabaseConf :: PostgresConf - -- ^ Configuration settings for accessing the database. + -- | Base for all generated URLs. If @Nothing@, determined from the + -- request headers. , appRoot :: Maybe Text - -- ^ Base for all generated URLs. If @Nothing@, determined - -- from the request headers. + -- | Host/interface the server should bind to. , appHost :: HostPreference - -- ^ Host/interface the server should bind to. + -- | Port to listen on , appPort :: Int - -- ^ Port to listen on + -- | Get the IP address from the header when logging. Useful when sitting + -- behind a reverse proxy. , appIpFromHeader :: Bool - -- ^ Get the IP address from the header when logging. Useful when sitting - -- behind a reverse proxy. + -- | Use detailed request logging system , appDetailedRequestLogging :: Bool - -- ^ Use detailed request logging system + -- | Should all log messages be displayed? , appShouldLogAll :: Bool - -- ^ Should all log messages be displayed? + -- | Use the reload version of templates , appReloadTemplates :: Bool - -- ^ Use the reload version of templates + -- | Assume that files in the static dir may change after compilation , appMutableStatic :: Bool - -- ^ Assume that files in the static dir may change after compilation + -- | Perform no stylesheet/script combining , appSkipCombining :: Bool - -- ^ Perform no stylesheet/script combining + -- | Path to the directory under which git repos are placed , appRepoDir :: FilePath - -- ^ Path to the directory under which git repos are placed + -- | Port for the SSH server component to listen on , appSshPort :: Int - -- ^ Port for the SSH server component to listen on + -- | Path to the server's SSH private key file , appSshKeyFile :: FilePath - -- ^ Path to the server's SSH private key file + -- | Copyright text to appear in the footer of the page , appCopyright :: Text - -- ^ Copyright text to appear in the footer of the page } instance FromJSON AppSettings where