/usr/share/doc/libghc-yesod-default-doc/html/Yesod-Default-Config.html is in libghc-yesod-default-doc 0.6.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Yesod.Default.Config</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Yesod-Default-Config.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Yesod-Default-Config.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">yesod-default-0.6.1: Default config and main functions for your yesod application</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Yesod.Default.Config</p></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:DefaultEnv">DefaultEnv</a> <ul class="subs"><li>= <a href="#v:Development">Development</a> </li><li>| <a href="#v:Testing">Testing</a> </li><li>| <a href="#v:Staging">Staging</a> </li><li>| <a href="#v:Production">Production</a> </li></ul></li><li class="src short"><a href="#v:fromArgs">fromArgs</a> :: (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> env, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> env, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Enum">Enum</a> env, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Bounded">Bounded</a> env) => (env -> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Object">Object</a> -> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Parser">Parser</a> extra) -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="Yesod-Default-Config.html#t:AppConfig">AppConfig</a> env extra)</li><li class="src short"><a href="#v:loadDevelopmentConfig">loadDevelopmentConfig</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="Yesod-Default-Config.html#t:AppConfig">AppConfig</a> <a href="Yesod-Default-Config.html#t:DefaultEnv">DefaultEnv</a> <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a>)</li><li class="src short"><span class="keyword">data</span> <a href="#t:AppConfig">AppConfig</a> environment extra = <a href="#v:AppConfig">AppConfig</a> {<ul class="subs"><li><a href="#v:appEnv">appEnv</a> :: environment</li><li><a href="#v:appPort">appPort</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></li><li><a href="#v:appRoot">appRoot</a> :: <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a></li><li><a href="#v:appExtra">appExtra</a> :: extra</li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:ConfigSettings">ConfigSettings</a> environment extra = <a href="#v:ConfigSettings">ConfigSettings</a> {<ul class="subs"><li><a href="#v:csEnv">csEnv</a> :: environment</li><li><a href="#v:csParseExtra">csParseExtra</a> :: environment -> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Object">Object</a> -> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Parser">Parser</a> extra</li><li><a href="#v:csFile">csFile</a> :: environment -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a></li><li><a href="#v:csGetObject">csGetObject</a> :: environment -> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Value">Value</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Value">Value</a></li></ul>}</li><li class="src short"><a href="#v:configSettings">configSettings</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> env => env -> <a href="Yesod-Default-Config.html#t:ConfigSettings">ConfigSettings</a> env <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:loadConfig">loadConfig</a> :: <a href="Yesod-Default-Config.html#t:ConfigSettings">ConfigSettings</a> environment extra -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="Yesod-Default-Config.html#t:AppConfig">AppConfig</a> environment extra)</li><li class="src short"><a href="#v:withYamlEnvironment">withYamlEnvironment</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> e => <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> e -> (<a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Value">Value</a> -> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Parser">Parser</a> a) -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> a</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:DefaultEnv" class="def">DefaultEnv</a> <a href="src/Yesod-Default-Config.html#DefaultEnv" class="link">Source</a></p><div class="doc"><p>A yesod-provided <code><code>AppEnv</code></code>, allows for Development, Testing, and
Production environments
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Development" class="def">Development</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Testing" class="def">Testing</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Staging" class="def">Staging</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Production" class="def">Production</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:DefaultEnv" class="caption collapser" onclick="toggleSection('i:DefaultEnv')">Instances</p><div id="section.i:DefaultEnv" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Bounded">Bounded</a> <a href="Yesod-Default-Config.html#t:DefaultEnv">DefaultEnv</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Enum">Enum</a> <a href="Yesod-Default-Config.html#t:DefaultEnv">DefaultEnv</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> <a href="Yesod-Default-Config.html#t:DefaultEnv">DefaultEnv</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Yesod-Default-Config.html#t:DefaultEnv">DefaultEnv</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:fromArgs" class="def">fromArgs</a> :: (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Read.html#t:Read">Read</a> env, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> env, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Enum">Enum</a> env, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Prelude.html#t:Bounded">Bounded</a> env) => (env -> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Object">Object</a> -> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Parser">Parser</a> extra) -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="Yesod-Default-Config.html#t:AppConfig">AppConfig</a> env extra)<a href="src/Yesod-Default-Config.html#fromArgs" class="link">Source</a></p><div class="doc"><p>Load the app config from command line parameters
</p></div></div><div class="top"><p class="src"><a name="v:loadDevelopmentConfig" class="def">loadDevelopmentConfig</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="Yesod-Default-Config.html#t:AppConfig">AppConfig</a> <a href="Yesod-Default-Config.html#t:DefaultEnv">DefaultEnv</a> <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a>)<a href="src/Yesod-Default-Config.html#loadDevelopmentConfig" class="link">Source</a></p><div class="doc"><p>Load your development config (when using <code><code><a href="Yesod-Default-Config.html#t:DefaultEnv">DefaultEnv</a></code></code>)
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:AppConfig" class="def">AppConfig</a> environment extra <a href="src/Yesod-Default-Config.html#AppConfig" class="link">Source</a></p><div class="doc"><p>Dynamic per-environment configuration which can be loaded at
run-time negating the need to recompile between environments.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:AppConfig" class="def">AppConfig</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:appEnv" class="def">appEnv</a> :: environment</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:appPort" class="def">appPort</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:appRoot" class="def">appRoot</a> :: <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:appExtra" class="def">appExtra</a> :: extra</dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:AppConfig" class="caption collapser" onclick="toggleSection('i:AppConfig')">Instances</p><div id="section.i:AppConfig" class="show"><table><tr><td class="src">(<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> environment, <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> extra) => <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> (<a href="Yesod-Default-Config.html#t:AppConfig">AppConfig</a> environment extra)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ConfigSettings" class="def">ConfigSettings</a> environment extra <a href="src/Yesod-Default-Config.html#ConfigSettings" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ConfigSettings" class="def">ConfigSettings</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:csEnv" class="def">csEnv</a> :: environment</dt><dd class="doc"><p>An arbitrary value, used below, to indicate the current running
environment. Usually, you will use <code><a href="Yesod-Default-Config.html#t:DefaultEnv">DefaultEnv</a></code> for this type.
</p></dd><dt class="src"><a name="v:csParseExtra" class="def">csParseExtra</a> :: environment -> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Object">Object</a> -> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Parser">Parser</a> extra</dt><dd class="doc"><p>Load any extra data, to be used by the application.
</p></dd><dt class="src"><a name="v:csFile" class="def">csFile</a> :: environment -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a></dt><dd class="doc"><p>Return the path to the YAML config file.
</p></dd><dt class="src"><a name="v:csGetObject" class="def">csGetObject</a> :: environment -> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Value">Value</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Value">Value</a></dt><dd class="doc"><p>Get the sub-object (if relevant) from the given YAML source which
contains the specific settings for the current environment.
</p></dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><a name="v:configSettings" class="def">configSettings</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> env => env -> <a href="Yesod-Default-Config.html#t:ConfigSettings">ConfigSettings</a> env <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/Yesod-Default-Config.html#configSettings" class="link">Source</a></p><div class="doc"><p>Default config settings.
</p></div></div><div class="top"><p class="src"><a name="v:loadConfig" class="def">loadConfig</a> :: <a href="Yesod-Default-Config.html#t:ConfigSettings">ConfigSettings</a> environment extra -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="Yesod-Default-Config.html#t:AppConfig">AppConfig</a> environment extra)<a href="src/Yesod-Default-Config.html#loadConfig" class="link">Source</a></p><div class="doc"><p>Load an <code><code><a href="Yesod-Default-Config.html#t:AppConfig">AppConfig</a></code></code>.
</p><p>Some examples:
</p><pre> -- typical local development
Development:
host: localhost
port: 3000
-- ssl: will default false
-- approot: will default to "http://localhost:3000"
</pre><pre> -- typical outward-facing production box
Production:
host: www.example.com
-- ssl: will default false
-- port: will default 80
-- approot: will default "http://www.example.com"
</pre><pre> -- maybe you're reverse proxying connections to the running app
-- on some other port
Production:
port: 8080
approot: "http://example.com"
-- approot is specified so that the non-80 port is not appended
-- automatically.
</pre></div></div><div class="top"><p class="src"><a name="v:withYamlEnvironment" class="def">withYamlEnvironment</a><a href="src/Yesod-Default-Config.html#withYamlEnvironment" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> e</td><td class="doc empty"> </td></tr><tr><td class="src">=> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a></td><td class="doc"><p>the yaml file
</p></td></tr><tr><td class="src">-> e</td><td class="doc"><p>the environment you want to load
</p></td></tr><tr><td class="src">-> (<a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Value">Value</a> -> <a href="/usr/share/doc/libghc-yaml-doc/html/Data-Yaml.html#t:Parser">Parser</a> a)</td><td class="doc"><p>what to do with the mapping
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> a</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Loads the configuration block in the passed file named by the
passed environment, yeilds to the passed function as a mapping.
</p><p>Errors in the case of a bad load or if your function returns
<code>Nothing</code>.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
|