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

Loïc Hoguin 32594a5199 Fix Websocket subprotocol example 1 year ago
.github d64ac25e92 Use GitHub actions for testing Cowboy 1 year ago
doc 32594a5199 Fix Websocket subprotocol example 1 year ago
ebin 521266326d Don't dialyze the tests by default 1 year ago
examples 4907734a83 Fix echo_post example 1 year ago
src 42d87dd776 Add 'max_cancel_stream_rate' config for the rapid reset attack 1 year ago
test b12b4300ba Fix typos in documentation 1 year ago
.gitattributes 4023e7f4e4 Convert the documentation to Asciidoc 9 years ago
.gitignore 306c2710e9 gitignore: add examples/ dependency files 9 years ago
CONTRIBUTING.asciidoc 0704b2fa7c Document how to run all test suites 6 years ago
LICENSE 137e86de7b Update LICENSE copyright year 2 years ago
Makefile 879a6b8bc5 Remove unneeded Makefile variables 1 year ago
README.asciidoc a93ac120f4 Remove official IRC channel 1 year ago
erlang.mk d64ac25e92 Use GitHub actions for testing Cowboy 1 year ago
plugins.mk 3977f2b96f Document the commands based Websocket interface 5 years ago
rebar.config 4958af5745 Update Cowlib to 2.12.1 2 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.6/guide[User guide]
* https://ninenines.eu/docs/en/cowboy/2.6/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

* https://github.com/ninenines/cowboy/issues[Issues tracker]
* https://ninenines.eu/services[Commercial Support]
* https://github.com/sponsors/essen[Sponsor me!]