diff options
author | Loïc Hoguin <[email protected]> | 2013-05-17 13:13:27 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2013-05-17 13:13:27 +0200 |
commit | 666c59bc422172562673916ed3a8a796c4f9fbf4 (patch) | |
tree | f561151846de077513fa767edc10165a469d09ef /manual/cowboy_app.md | |
parent | 0e0ec7b1203a8490ee9a876f9274fe0c64e708f8 (diff) | |
download | cowboy-666c59bc422172562673916ed3a8a796c4f9fbf4.tar.gz cowboy-666c59bc422172562673916ed3a8a796c4f9fbf4.tar.bz2 cowboy-666c59bc422172562673916ed3a8a796c4f9fbf4.zip |
Add the Cowboy Function Reference
The manual details every stable public functions of Cowboy.
Diffstat (limited to 'manual/cowboy_app.md')
-rw-r--r-- | manual/cowboy_app.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/manual/cowboy_app.md b/manual/cowboy_app.md new file mode 100644 index 0000000..5311109 --- /dev/null +++ b/manual/cowboy_app.md @@ -0,0 +1,25 @@ +The Cowboy Application +====================== + +Small, fast, modular HTTP server. + +Dependencies +------------ + +The `cowboy` application uses the Erlang applications `ranch` +for listening and accepting TCP connections, and `crypto` +for establishing Websocket connections. These dependencies must +be loaded for the `cowboy` application to work. In an embedded +environment this means that they need to be started with the +`application:start/{1,2}` function before the `cowboy` +application is started. + +The `cowboy` application also uses the Erlang applications +`public_key` and `ssl` when listening for HTTPS connections. +These are started automatically if they weren't before. + +Environment +----------- + +The `cowboy` application does not define any application +environment configuration parameters. |