mirror https://github.com/ninenines/cowboy

Steve Domin 09bf1199aa Add compress_threshold protocol option 7 years ago
doc d4129e6305 Exit gracefully on parent exit/sys:terminate/2,3 6 years ago
ebin 26bc4afad4 Prepare the 2.5.0 release 6 years ago
examples 86cb105679 Rename handler modules to _h 6 years ago
src 09bf1199aa Add compress_threshold protocol option 6 years ago
test 09bf1199aa Add compress_threshold protocol option 6 years ago
.gitattributes 4023e7f4e4 Convert the documentation to Asciidoc 9 years ago
.gitignore 306c2710e9 gitignore: add examples/ dependency files 9 years ago
CONTRIBUTING.asciidoc c37852fa2b Update CONTRIBUTING 9 years ago
LICENSE 43adacc760 Welcome to 2017 8 years ago
Makefile a8335c63df Always dialyze tests and fix some cowboy_req specs 6 years ago
README.asciidoc 26bc4afad4 Prepare the 2.5.0 release 6 years ago
erlang.mk 3b173fd42c Update erlang.mk 6 years ago
plugins.mk a45813c60f Allow passing options to sub protocols 8 years ago
rebar.config 122faedc25 Initial support for the PROXY protocol header 6 years ago

README.asciidoc

= Cowboy

Cowboy is a small, fast and modern HTTP server for Erlang/OTP.

== Goals

Cowboy aims to provide a *complete* HTTP stack in a *small* code base.
It is optimized for *low latency* and *low memory usage*, in part
because it uses *binary strings*.

Cowboy provides *routing* capabilities, selectively dispatching requests
to handlers written in Erlang.

Because it uses Ranch for managing connections, Cowboy can easily be
*embedded* in any other application.

Cowboy is *clean* and *well tested* Erlang code.

== Online documentation

* https://ninenines.eu/docs/en/cowboy/2.5/guide[User guide]
* https://ninenines.eu/docs/en/cowboy/2.5/manual[Function reference]

== Offline documentation

* While still online, run `make docs`
* User guide available in `doc/` in PDF and HTML formats
* Function reference man pages available in `doc/man3/` and `doc/man7/`
* Run `make install-docs` to install man pages on your system
* Full documentation in Asciidoc available in `doc/src/`
* Examples available in `examples/`

== Getting help

* Official IRC Channel: #ninenines on irc.freenode.net
* https://github.com/ninenines/cowboy/issues[Issues tracker]
* https://ninenines.eu/services[Commercial Support]