mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-16 05:00:24 +00:00
078d686a0a
make docs: generate Markdown and man pages in doc/ make install-docs: install man pages to be usable directly Docs are generated from the ezdoc files in doc/src/.
32 lines
1.1 KiB
Text
32 lines
1.1 KiB
Text
::: cowboy_static
|
|
|
|
The `cowboy_static` module implements file serving capabilities
|
|
by using the REST semantics provided by `cowboy_rest`.
|
|
|
|
:: Types
|
|
|
|
: opts() = {priv_file, atom(), string() | binary()}
|
|
| {priv_file, atom(), string() | binary(), extra()}
|
|
| {file, string() | binary()}
|
|
| {file, string() | binary(), extra()}
|
|
| {priv_dir, atom(), string() | binary()}
|
|
| {priv_dir, atom(), string() | binary(), extra()}
|
|
| {dir, atom(), string() | binary()}
|
|
| {dir, atom(), string() | binary(), extra()}
|
|
|
|
Configuration for the static handler.
|
|
|
|
The handler can be configured for sending either one file or
|
|
a directory (including its subdirectories).
|
|
|
|
Extra options allow you to define how the etag should be calculated
|
|
and how the mimetype of files should be detected. They are defined
|
|
as follow, but do note that these types are not exported, only the
|
|
`opts/0` type is public.
|
|
|
|
: extra() = [extra_etag() | extra_mimetypes()]
|
|
|
|
: extra_etag() = {etag, module(), function()} | {etag, false}
|
|
|
|
: extra_mimetypes() = {mimetypes, module(), function()}
|
|
| {mimetypes, binary() | {binary(), binary(), [{binary(), binary()}]}}
|