| Safe Haskell | None |
|---|
Yesod.Static
Description
Serve static files from a Yesod app.
This is great for developing your application, but also for a dead-simple deployment. Caching headers are automatically taken care of.
If you are running a proxy server (like Apache or Nginx), you may want to have that server do the static serving instead.
In fact, in an ideal setup you'll serve your static files from
a separate domain name to save time on transmitting
cookies. In that case, you may wish to use urlRenderOverride
to redirect requests to this subsite to a separate domain
name.
Note that this module's static subsite ignores all files and
directories that are hidden by Unix conventions (i.e. start
with a dot, such as ".ssh") and the directory tmp on the
root of the directory with static files.
- newtype Static = Static StaticSettings
- data family Route a
- type StaticRoute = Route Static
- static :: FilePath -> IO Static
- staticDevel :: FilePath -> IO Static
- embed :: FilePath -> Q Exp
- staticFiles :: FilePath -> Q [Dec]
- staticFilesList :: FilePath -> [FilePath] -> Q [Dec]
- publicFiles :: FilePath -> Q [Dec]
- base64md5 :: ByteString -> String
Subsite
data family Route a
The type-safe URLs associated with a site argument.
type StaticRoute = Route Static
Smart constructor
static :: FilePath -> IO Static
Produce a default value of Static for a given file
folder.
Does not have index files or directory listings. The static files' contents must not change, however new files can be added.
staticDevel :: FilePath -> IO Static
Same as static, but does not assumes that the files do not
change and checks their modification time whenever a request
is made.
Produce a Static based on embedding all of the static
files' contents in the executable at compile time.
Nota Bene: if you replace the scaffolded static call in Settings/StaticFiles.hs
you will need to change the scaffolded addStaticContent. Otherwise, some of your
assets will be 404'ed. This is because by default yesod will generate compile those
assets to static/tmp which for static is fine since they are served out of the
directory itself. With embedded static, that will not work.
You can easily change addStaticContent to _ _ _ -> return Nothing as a workaround.
This will cause yesod to embed those assets into the generated HTML file itself.
Template Haskell helpers
staticFiles :: FilePath -> Q [Dec]
Template Haskell function that automatically creates routes for all of your static files.
For example, if you used
staticFiles "static/"
and you had files "static/style.css" and
"static/js/script.js", then the following top-level
definitions would be created:
style_css = StaticRoute ["style.css"] [] js_script_js = StaticRoute ["js/script.js"] []
Note that dots (.), dashes (-) and slashes (/) are
replaced by underscores (_) to create valid Haskell
identifiers.
staticFilesList :: FilePath -> [FilePath] -> Q [Dec]
Same as staticFiles, but takes an explicit list of files
to create identifiers for. The files path given are relative
to the static folder. For example, to create routes for the
files "static/js/jquery.js" and
"static/css/normalize.css", you would use:
staticFilesList \"static\" [\"js\/jquery.js\", \"css\/normalize.css\"]
This can be useful when you have a very large number of static files, but only need to refer to a few of them from Haskell.
publicFiles :: FilePath -> Q [Dec]
Same as staticFiles, but doesn't append an ETag to the
query string.
Using publicFiles will speed up the compilation, since there
won't be any need for hashing files during compile-time.
However, since the ETag ceases to be part of the URL, the
Static subsite won't be able to set the expire date too far
on the future. Browsers still will be able to cache the
contents, however they'll need send a request to the server to
see if their copy is up-to-date.
Hashing
base64md5 :: ByteString -> String