From 83f1ad46e84c1a9016c9dee2c1ec749880dfd260 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sat, 1 Oct 2016 00:08:31 +0200 Subject: HTTPS fixes and link:man support in docs + doc update --- docs/en/cowboy/2.0/manual/cowboy_app/index.html | 162 ++++++++++++++++++++++-- 1 file changed, 149 insertions(+), 13 deletions(-) (limited to 'docs/en/cowboy/2.0/manual/cowboy_app/index.html') diff --git a/docs/en/cowboy/2.0/manual/cowboy_app/index.html b/docs/en/cowboy/2.0/manual/cowboy_app/index.html index f8d0c139..a251adc8 100644 --- a/docs/en/cowboy/2.0/manual/cowboy_app/index.html +++ b/docs/en/cowboy/2.0/manual/cowboy_app/index.html @@ -11,7 +11,7 @@ Nine Nines: cowboy(7) - + @@ -72,23 +72,152 @@

Name

-

cowboy - Small, fast, modular HTTP server.

+

cowboy - Small, fast, modern HTTP server for Erlang/OTP

+
+
+
+

Description

+
+

Cowboy is an HTTP server for Erlang/OTP with support for the +HTTP/1.1, HTTP/2 and Websocket protocols.

+

Cowboy aims to provide a complete HTTP stack. This includes +the implementation of the HTTP RFCs but also any directly +related standards, like Websocket or Server-Sent Events.

+
+
+
+

Modules

+
+

Functions:

+
+

Protocols:

+
+

Handlers:

+
+

Behaviors:

+
+

Middlewares:

+

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.

+
    +
  • +

    +ranch(7) - Socket acceptor pool for TCP protocols +

    +
    • +
  • +

    +cowlib(7) - Support library for manipulating Web protocols +

    +
    • +
  • +

    +ssl - Secure communication over sockets +

    +
    • +
  • +

    +crypto - Crypto functions +

    +
    • +
+

All these applications must be started before the cowboy +application. To start Cowboy and all dependencies at once:

+
+
+
{ok, _} = application:ensure_all_started(cowboy).
@@ -98,6 +227,13 @@ These are started automatically if they weren’t before.

environment configuration parameters.

+
+

See also

+
+

ranch(7), +cowlib(7)

+
+
-- cgit v1.2.3