cowboy/guide/toc.md

Cowboy User Guide
=================

The Cowboy User Guide explores the modern Web and how to make
best use of Cowboy for writing powerful web applications.

Introducing Cowboy
------------------

 *  [Introduction](introduction.md)
 *  [The modern Web](modern_web.md)
 *  [Erlang and the Web](erlang_web.md)
 *  [Erlang for beginners](erlang_beginners.md)
 *  [Getting started](getting_started.md)

HTTP
----

 *  [The life of a request](http_req_life.md)
 *  [Routing](routing.md)
 *  [Handling plain HTTP requests](http_handlers.md)
 *  [The Req object](req.md)
 *  [Reading the request body](req_body.md)
 *  [Sending a response](resp.md)
 *  [Using cookies](cookies.md)

Multipart
---------

 *  [Introduction to multipart](multipart_intro.md)
 *  [Multipart requests](multipart_req.md)

Static files
------------

 *  [Static handler](static_handlers.md)

REST
----

 *  [REST principles](rest_principles.md)
 *  [Handling REST requests](rest_handlers.md)
 *  [REST flowcharts](rest_flowcharts.md)
 *  [Designing a resource handler](resource_design.md)

Websocket
---------

 *  [The Websocket protocol](ws_protocol.md)
 *  [Handling Websocket connections](ws_handlers.md)

Server push
-----------

 *  [Loop handlers](loop_handlers.md)

Pluggable interface
-------------------

 *  [Middlewares](middlewares.md)
 *  [Protocol upgrades](upgrade_protocol.md)
 *  [Hooks](hooks.md)

Internals
---------

 *  [Architecture](architecture.md)
 *  [Dealing with broken clients](broken_clients.md)
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`Cowboy User Guide`
			`=================`

Greatly improve the guide introduction 2013-06-27 00:02:12 +02:00			`The Cowboy User Guide explores the modern Web and how to make`
			`best use of Cowboy for writing powerful web applications.`

			`Introducing Cowboy`
			`------------------`

Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* [Introduction](introduction.md)`
Greatly improve the guide introduction 2013-06-27 00:02:12 +02:00			`* [The modern Web](modern_web.md)`
			`* [Erlang and the Web](erlang_web.md)`
			`* [Erlang for beginners](erlang_beginners.md)`
			`* [Getting started](getting_started.md)`

Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00			`HTTP`
			`----`
Greatly improve the guide introduction 2013-06-27 00:02:12 +02:00
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00			`* [The life of a request](http_req_life.md)`
Add a skeleton of the guide to ease user contributions Has some stuff that aren't in master yet, and lacks a lot more that is already in master. 2013-01-01 18:27:41 +01:00			`* [Routing](routing.md)`
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00			`* [Handling plain HTTP requests](http_handlers.md)`
			`* [The Req object](req.md)`
Greatly expand on the Req object Cut in four different chapters: request, request body, response and cookies. 2013-09-23 15:44:10 +02:00			`* [Reading the request body](req_body.md)`
			`* [Sending a response](resp.md)`
			`* [Using cookies](cookies.md)`
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00
Wrap-up the user guide 2014-06-25 11:23:58 +02:00			`Multipart`
			`---------`

			`* [Introduction to multipart](multipart_intro.md)`
			`* [Multipart requests](multipart_req.md)`

Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00			`Static files`
			`------------`

Review, improve and document the static files handler Changes include: * Much simplified route configuration. * Etag generation is now enabled by default. * Web mimetypes are now detected by default. A bigger list of mimetypes can be detected without any additional library. * Mimetypes can no longer be specified as a list. Copying this list for new connections is too costy. You can easily convert it into a function and pass that function to the handler instead. * You can however specify a single hardcoded mimetype. Mostly useful when serving a single file, like an index.html file, to avoid extra operations. * Specifying a path as a list of tokens is not possible anymore. Use either a binary or a string. * Using a private directory will not work if the application was not started properly. Cowboy will not attempt to find the location of this directory if the VM doesn't know it, as this caused issues in some setups. * Overall the code has been much simplified and clarified, and of course has now been documented. 2013-11-02 14:41:46 +01:00			`* [Static handler](static_handlers.md)`
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00
			`REST`
			`----`

Add a REST principles chapter to the guide This is a complex subject so hopefully I did not introduce errors while trying to explain it. 2014-06-04 15:28:27 +02:00			`* [REST principles](rest_principles.md)`
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00			`* [Handling REST requests](rest_handlers.md)`
Add a stub chapter with all the REST flowcharts The detailed explanations will be written at a later time. 2014-06-21 18:50:50 +02:00			`* [REST flowcharts](rest_flowcharts.md)`
Add a new guide chapter: designing a resource handler 2014-07-01 14:06:20 +02:00			`* [Designing a resource handler](resource_design.md)`
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00
Wrap-up the user guide 2014-06-25 11:23:58 +02:00			`Websocket`
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00			`---------`

Update and improve Websocket chapters in the guide 2014-03-03 16:59:02 +01:00			`* [The Websocket protocol](ws_protocol.md)`
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00			`* [Handling Websocket connections](ws_handlers.md)`

Wrap-up the user guide 2014-06-25 11:23:58 +02:00			`Server push`
			`-----------`
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00
Wrap-up the user guide 2014-06-25 11:23:58 +02:00			`* [Loop handlers](loop_handlers.md)`
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00
Wrap-up the user guide 2014-06-25 11:23:58 +02:00			`Pluggable interface`
			`-------------------`
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00
Add middleware support Middlewares allow customizing the request processing. All existing Cowboy project are incompatible with this commit. You need to change `{dispatch, Dispatch}` in the protocol options to `{env, [{dispatch, Dispatch}]}` to fix your code. 2013-01-03 22:47:51 +01:00			`* [Middlewares](middlewares.md)`
Wrap-up the user guide 2014-06-25 11:23:58 +02:00			`* [Protocol upgrades](upgrade_protocol.md)`
			`* [Hooks](hooks.md)`
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00
Wrap-up the user guide 2014-06-25 11:23:58 +02:00			`Internals`
			`---------`
Added a chapter about life of HTTP requests Reworked the table of contents also. 2013-09-16 23:51:09 +02:00
Wrap-up the user guide 2014-06-25 11:23:58 +02:00			`* [Architecture](architecture.md)`
			`* [Dealing with broken clients](broken_clients.md)`