:: a typeCtrl KGHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05
Modulewai-middleware-static-0.9.2Haskell2010
Serve static files, subject to a policy that can filter or modify incoming URIs. The flow is:
incoming request URI ==> policies ==> exists? ==> respond
If any of the polices fail, or the file doesn't exist, then the middleware gives up and calls the inner application. If the file is found, the middleware chooses a content type based on the file extension and returns the file contents as the response.
Serve static files out of the application root (current directory). If file is found, it is streamed to the client and no further middleware is run. Disables caching.
Note: for security reasons, this uses the noDots and isNotAbsolute policy by default.
Serve static files subject to a Policy. Disables caching.
Note: for security reasons, this uses the noDots and isNotAbsolute policy by default.
Serve static files subject to a Policy. Unlike static and staticPolicy, this has no policies enabled by default and is hence insecure. Disables caching.
Deprecated. Use staticWithOptions instead. This function will be removed in the next major release.
Serve static files out of the application root (current directory). If file is found, it is streamed to the client and no further middleware is run. Allows a CachingStrategy.
Note: for security reasons, this uses the noDots and isNotAbsolute policy by default.
Deprecated. Use staticPolicyWithOptions instead. This function will be removed in the next major release.
Serve static files subject to a Policy using a specified CachingStrategy
Note: for security reasons, this uses the noDots and isNotAbsolute policy by default.
Deprecated. Use unsafeStaticPolicyWithOptions instead. This function will be removed in the next major release.
Serve static files subject to a Policy. Unlike static and staticPolicy, this has no policies enabled by default, and is hence insecure. Also allows to set a CachingStrategy.
Serve static files out of the application root (current directory). If file is found, it is streamed to the client and no further middleware is run. Takes Options.
Note: for security reasons, this uses the noDots and isNotAbsolute policy by default.
Serve static files subject to a Policy using specified Options
Note: for security reasons, this uses the noDots and isNotAbsolute policy by default.
Serve static files subject to a Policy. Unlike staticWithOptions and staticPolicyWithOptions, this has no policies enabled by default and is hence insecure. Takes Options.
Options for staticWithOptions Middleware.
Options can be set using record syntax on defaultOptions with the fields below.
Cache container to use
Compute MimeType from file name
Default options.
Options
{ cacheContainer = CacheContainerEmpty -- no caching
, mimeTypes = getMimeType -- use defaultMimeLookup from Network.Mime
}
A cache strategy which should be used to serve content matching a policy. Meta information is cached for a maxium of 100 seconds before being recomputed.
NoCachingDo not send any caching headers
PublicStaticCachingSend common caching headers for public (non dynamic) static files
CustomCaching (FileMeta -> RequestHeaders)Compute caching headers using the user specified function. See http://www.mobify.com/blog/beginners-guide-to-http-cache-headers/ for a detailed guide
Meta information about a file to calculate cache headers
Initialize caching. This should only be done once per application launch.
Container caching file meta information. Create using initCaching
Take an incoming URI and optionally modify or filter it. The result will be treated as a filepath.
Choose between two policies. If the first fails, run the second.
Sequence two policies. They are run from left to right. (Note: this is mappend)
Lift a function into a Policy
Lift a predicate into a Policy
Add a base path to the URI
staticPolicy (addBase "/home/user/files")GET "foo/bar" looks for "/home/user/files/foo/bar"
Add an initial slash to to the URI, if not already present.
staticPolicy addSlashGET "foo/bar" looks for "/foo/bar"
Accept only URIs containing given string
Accept only URIs with given prefix
Accept only URIs with given suffix
Reject URIs containing ".."
Reject URIs that are absolute paths
Use URI as the key to an association list, rejecting those not found. The policy result is the matching value.
staticPolicy (only [("foo/bar", "/home/user/files/bar")])GET "foo/bar" looks for "/home/user/files/bar" GET "baz/bar" doesn't match anything
Run a policy
Guess MIME type from file extension