From 666c59bc422172562673916ed3a8a796c4f9fbf4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 17 May 2013 13:13:27 +0200 Subject: Add the Cowboy Function Reference The manual details every stable public functions of Cowboy. --- manual/cowboy_app.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 manual/cowboy_app.md (limited to 'manual/cowboy_app.md') 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. -- cgit v1.2.3