umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 12:20:24 +00:00
Code Issues Wiki Activity
Small, fast, modern HTTP server for Erlang/OTP.
1898 commits 6 branches 54 tags 12 MiB
Find a file
Loïc Hoguin 7b5da29019
Don't run long test suites by default 
The examples test suite is only useful once in a while
in order to know whether examples were broken, for example
before issuing a release.

The new ws_autobahn test suite isolates the autobahn test
suite so that it can be ignored by default. It's only
useful to run it when working on the Websocket code or
before issuing a release.
2018-11-20 13:23:59 +01:00
doc/src Document cowboy_stream_h/cowboy_compress_h 2018-11-18 23:03:30 +01:00
ebin Prepare the Cowboy 2.6 release 2018-11-17 13:36:14 +01:00
examples Accept a broader media type as input in rest_pastebin example 2018-11-01 14:44:55 +01:00
src Add an additional test to the static test suite 2018-11-19 12:24:28 +01:00
test Don't run long test suites by default 2018-11-20 13:23:59 +01:00
.gitattributes Convert the documentation to Asciidoc 2016-01-14 13:37:20 +01:00
.gitignore gitignore: add examples/ dependency files 2016-05-25 12:54:12 +02:00
CONTRIBUTING.asciidoc Update CONTRIBUTING 2015-11-16 18:55:53 +01:00
erlang.mk Update erlang.mk 2018-09-12 15:00:48 +02:00
LICENSE Welcome to 2017 2017-01-02 19:36:36 +01:00
Makefile Don't run long test suites by default 2018-11-20 13:23:59 +01:00
plugins.mk Allow passing options to sub protocols 2017-02-18 18:26:20 +01:00
README.asciidoc Prepare the Cowboy 2.6 release 2018-11-17 13:36:14 +01:00
rebar.config Prepare the Cowboy 2.6 release 2018-11-17 13:36:14 +01:00

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

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