aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_app.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-01-14 13:35:25 +0100
committerLoïc Hoguin <[email protected]>2016-01-14 13:37:20 +0100
commit4023e7f4e429179fd9c2cce4487c33646c6bd327 (patch)
tree3c4e26d1b5592958e35297c82ad3069bdb642594 /doc/src/manual/cowboy_app.asciidoc
parentb7d666cfc746f55b0a72ef8d37f703885099daf7 (diff)
downloadcowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.tar.gz
cowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.tar.bz2
cowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.zip
Convert the documentation to Asciidoc
A few small revisions were made, and Erlang.mk has been updated.
Diffstat (limited to 'doc/src/manual/cowboy_app.asciidoc')
-rw-r--r--doc/src/manual/cowboy_app.asciidoc25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_app.asciidoc b/doc/src/manual/cowboy_app.asciidoc
new file mode 100644
index 0000000..2213bd1
--- /dev/null
+++ b/doc/src/manual/cowboy_app.asciidoc
@@ -0,0 +1,25 @@
+= cowboy(7)
+
+== Name
+
+cowboy - Small, fast, modular HTTP server.
+
+== Dependencies
+
+The `cowboy` application uses the Erlang applications `ranch`
+for listening and accepting TCP connections, `crypto` for
+establishing Websocket connections, and `cowlib` for parsing and
+building messages for Web protocols. 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
+`asn1`, `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.