mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-14 04:10:24 +00:00
Small, fast, modern HTTP server for Erlang/OTP.
cowboyerlangfunctionalhigh-performancehttphttp-serverhttp2http2-serverhttpsproduction-readyrestwebweb-frameworkwebsocketwebsocket-serverwebsockets
8cb9d242b0
This includes Websocket over HTTP/3. Since quicer, which provides the QUIC implementation, is a NIF, Cowboy cannot depend directly on it. In order to enable QUIC and HTTP/3, users have to set the COWBOY_QUICER environment variable: export COWBOY_QUICER=1 In order to run the test suites, the same must be done for Gun: export GUN_QUICER=1 HTTP/3 support is currently not available on Windows due to compilation issues of quicer which have yet to be looked at or resolved. HTTP/3 support is also unavailable on the upcoming OTP-27 due to compilation errors in quicer dependencies. Once resolved HTTP/3 should work on OTP-27. Because of how QUIC currently works, it's possible that streams that get reset after sending a response do not receive that response. The test suite was modified to accomodate for that. A future extension to QUIC will allow us to gracefully reset streams. This also updates Erlang.mk. |
||
|---|---|---|
| .github/workflows | ||
| doc/src | ||
| ebin | ||
| examples | ||
| src | ||
| test | ||
| .gitattributes | ||
| .gitignore | ||
| CONTRIBUTING.asciidoc | ||
| erlang.mk | ||
| LICENSE | ||
| Makefile | ||
| plugins.mk | ||
| README.asciidoc | ||
| rebar.config | ||
= 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.12/guide[User guide] * https://ninenines.eu/docs/en/cowboy/2.12/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!]