path: root/README.md
diff options
authorLoïc Hoguin <[email protected]>2011-03-07 22:59:22 +0100
committerLoïc Hoguin <[email protected]>2011-03-17 00:29:35 +0100
commitda7225594010d0df20779a0915474ccedd25d7cf (patch)
treeeb2c0485076124dec9967c650daca24440786a96 /README.md
Initial commit.
Diffstat (limited to 'README.md')
1 files changed, 69 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fc8b127
--- /dev/null
+++ b/README.md
@@ -0,0 +1,69 @@
+Cowboy is a small, fast and modular HTTP server written in Erlang.
+Cowboy aims to provide the following advantages:
+* **Small** codebase.
+* Damn **fast**.
+* **Modular**: transport, protocol and handlers are replaceable. (see below)
+* Easy to **embed** inside another application.
+* Selectively **dispatch** requests to handlers, allowing you to send some
+ requests to your embedded code and others to a FastCGI application in
+ PHP or Ruby.
+* No parameterized module. No process dictionary. **Clean** Erlang code.
+The server is currently in early development stage. Comments, suggestions are
+more than welcome. To contribute, either open bug reports, or fork the project
+and send us pull requests with new or improved functionality. Of course you
+might want to discuss your plans with us before you do any serious work so
+we can share ideas and save everyone time.
+Embedding Cowboy
+* Add Cowboy as a rebar dependency to your application.
+* Start Cowboy and add one or more listeners.
+* Write handlers.
+Starting and stopping
+Cowboy can be started and stopped like any other application. However the
+Cowboy application do not start any listener, those must be started manually.
+A listener is a special kind of supervisor that handles a pool of acceptor
+processes. An acceptor simply accept connections and forward them to a
+protocol module, for example HTTP. You must thus define the transport and
+protocol module to use for the listener, their options and the number of
+acceptors in the pool before you can start a listener supervisor.
+For HTTP applications the transport can be either TCP or SSL for HTTP and
+HTTPS respectively. On the other hand, the protocol is of course HTTP.
+Code speaks more than words:
+ application:start(cowboy),
+ Dispatch = [
+ %% Host, Path, Handler, Opts
+ {'_', '_', my_handler, []}
+ ],
+ %% NbAcceptors, Transport, TransOpts, Protocol, ProtoOpts
+ cowboy_listener_sup:start_link(100,
+ cowboy_tcp_transport, [{port, 8080}],
+ cowboy_http_protocol, [{dispatch, Dispatch}]
+ ).
+You must also write the `my_handler` module to process requests. You can
+use one of the predefined handlers or write your own. An hello world HTTP
+handler could be written like this:
+ -module(my_handler).
+ -export([handle/2]).
+ handle(Opts, Req) ->
+ {reply, 200, [], "Hello World!"}.