diff options
Diffstat (limited to 'docs/en/cowboy/2.0/guide/introduction.asciidoc')
| -rw-r--r-- | docs/en/cowboy/2.0/guide/introduction.asciidoc | 47 |
1 files changed, 33 insertions, 14 deletions
diff --git a/docs/en/cowboy/2.0/guide/introduction.asciidoc b/docs/en/cowboy/2.0/guide/introduction.asciidoc index 9cdcbc99..d262b5ce 100644 --- a/docs/en/cowboy/2.0/guide/introduction.asciidoc +++ b/docs/en/cowboy/2.0/guide/introduction.asciidoc @@ -3,9 +3,13 @@ Cowboy is a small, fast and modular HTTP server written in Erlang. -Cowboy aims to provide a complete HTTP stack, including its derivatives -Websocket and REST. Cowboy currently supports HTTP/1.0, HTTP/1.1, HTTP/2, -Websocket (all implemented drafts + standard) and Webmachine-based REST. +Cowboy aims to provide a complete xref:modern_web[modern Web stack]. +This includes HTTP/1.1, HTTP/2, Websocket, Server-Sent Events and +Webmachine-based REST. + +Cowboy comes with functions for introspection and tracing, enabling +developers to know precisely what is happening at any time. Its modular +design also easily enable developers to add instrumentation. Cowboy is a high quality project. It has a small code base, is very efficient (both in latency and memory use) and can easily be embedded @@ -13,7 +17,7 @@ in another application. Cowboy is clean Erlang code. It includes hundreds of tests and its code is fully compliant with the Dialyzer. It is also well documented and -features both a Function Reference and a User Guide. +features a Function Reference, a User Guide and numerous Tutorials. === Prerequisites @@ -24,21 +28,34 @@ will be detailed throughout the guide. === Supported platforms -Cowboy is tested and supported on Linux. +Cowboy is tested and supported on Linux, FreeBSD, Windows and OSX. Cowboy has been reported to work on other platforms, but we make no guarantee that the experience will be safe and smooth. You are advised to perform the necessary testing and security audits prior to deploying on other platforms. -Cowboy is developed for Erlang/OTP 17.0, 17.1.2 and 17.3. By the time -this branch gets released the target version will probably be 18.0 and -above. +Cowboy is developed for Erlang/OTP 19.0 and newer. + +=== License + +Cowboy uses the ISC License. + +---- +Copyright (c) 2011-2016, Loïc Hoguin <[email protected]> -Cowboy may be compiled on other Erlang versions with small source code -modifications but there is no guarantee that it will work as expected. +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. -Cowboy uses the maps data type which was introduced in Erlang 17.0. +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +---- === Versioning @@ -49,8 +66,10 @@ Cowboy uses http://semver.org/[Semantic Versioning 2.0.0]. In the HTTP protocol, the method name is case sensitive. All standard method names are uppercase. -Header names are case insensitive. Cowboy converts all the request -header names to lowercase, and expects your application to provide -lowercase header names in the response. +Header names are case insensitive. When using HTTP/1.1, Cowboy converts +all the request header names to lowercase. HTTP/2 requires clients to +send them as lowercase. Any other header name is expected to be provided +lowercased, including when querying information about the request or +when sending responses. The same applies to any other case insensitive value. |