0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 04:30:25 +00:00
cowboy/guide/toc.md
Loïc Hoguin 6672ea0415 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

91 lines
1.9 KiB
Markdown

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)
Static files
------------
* [Static handler](static_handlers.md)
* Distributed CDN solutions
* Efficiently serving files
REST
----
* REST principles
* Media types explained
* HTTP caching
* [Handling REST requests](rest_handlers.md)
* HEAD/GET requests flowchart
* POST/PUT/PATCH requests flowchart
* DELETE requests flowchart
* OPTIONS requests flowchart
* Designing a REST API
Multipart
---------
* Understanding multipart
* Multipart requests
* Multipart responses
Server push technologies
------------------------
* Push technologies
* [Using loop handlers for server push](loop_handlers.md)
* CORS
Using Websocket
---------------
* The Websocket protocol
* [Handling Websocket connections](ws_handlers.md)
Advanced HTTP
-------------
* Authentication
* Sessions
Advanced Cowboy usage
---------------------
* Optimization guide
* [Hooks](hooks.md)
* [Middlewares](middlewares.md)
* Access and error logs
* Handling broken clients
* HTTP header names
* HTTP/1.1 streaming not chunked
Old guide misc
--------------
This section will be removed as content is moved into other chapters.
* [Handlers](handlers.md)
* [Internals](internals.md)
* [Resources](resources.md)