Packages

bandit

0.3.6
1.12.0 1.11.1 1.11.0 1.10.4 1.10.3 1.10.2 1.10.1 1.10.0 retired 1.9.0 1.8.0 1.7.0 1.6.11 1.6.10 1.6.9 1.6.8 1.6.7 1.6.6 1.6.5 1.6.4 1.6.3 1.6.2 1.6.1 1.6.0 1.5.7 1.5.6 1.5.5 1.5.4 1.5.3 1.5.2 1.5.1 1.5.0 1.4.2 1.4.1 1.4.0 1.3.0 1.2.3 1.2.2 1.2.1 1.2.0 1.1.3 1.1.2 1.1.1 1.1.0 1.0.0 1.0.0-pre.18 1.0.0-pre.17 1.0.0-pre.16 1.0.0-pre.15 1.0.0-pre.14 1.0.0-pre.13 1.0.0-pre.12 1.0.0-pre.11 1.0.0-pre.10 1.0.0-pre.9 1.0.0-pre.8 1.0.0-pre.7 1.0.0-pre.6 1.0.0-pre.5 1.0.0-pre.4 1.0.0-pre.3 1.0.0-pre.2 1.0.0-pre.1 0.7.7 0.7.6 0.7.5 0.7.4 0.7.3 0.7.2 0.7.1 0.7.0 0.6.11 0.6.10 0.6.9 0.6.8 0.6.7 0.6.6 0.6.5 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0 0.5.11 0.5.10 0.5.9 0.5.8 0.5.7 0.5.6 0.5.5 0.5.4 0.5.3 0.5.2 0.5.1 0.5.0 0.4.10 0.4.9 0.4.8 0.4.7 0.4.6 0.4.5 0.4.4 0.4.3 0.4.2 0.4.1 0.4.0 0.3.9 0.3.8 0.3.7 0.3.6 0.3.5 0.3.4 0.3.3 0.3.2 0.2.3 0.2.2 0.2.1 0.2.0 0.1.1 0.1.0

A pure-Elixir HTTP server built for Plug & WebSock apps

Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
119 Versions
3 Dependencies
Dependants
7 Advisories
Files
Activity
bandit README.md
Raw

README.md 

# Bandit



[![Build Status](https://github.com/mtrudel/bandit/workflows/Elixir%20CI/badge.svg)](https://github.com/mtrudel/bandit/actions)

[![Hex.pm](https://img.shields.io/hexpm/v/bandit.svg?style=flat-square)](https://hex.pm/packages/bandit)



[Documentation](https://hexdocs.pm/bandit/)



Bandit is a pure Elixir HTTP server for Plug apps. It is currently very much a WiP but is maturing quickly (see below 

for more information on current and future development plans).



Bandit is written entirely in Elixir and is built atop [Thousand Island](https://github.com/mtrudel/thousand_island) and as a result can provide scalable

and performant HTTP services out of the box. By being the simplest thing that can get from HTTP requests to a Plug

interface it is also simple and easy to understand. 



## Project Goals



* Implement comprehensive support for HTTP/1.0 through HTTP/2 (and eventually beyond) backed by obsessive RFC

  literacy and automated conformance testing

* Aim for minimal internal policy and HTTP-level configuration. Delegate to Plug as much as possible, and only 

interpret requests to the extent necessary to safely manage a connection & fulfill the requirements of supporting Plug

* Define & provide a public API for WebSockets in the same vein as Plug to allow for Phoenix to support servers other than Cowboy

* Prioritize (in order): correctness, clarity, performance. Seek to remove the mystery of infrastructure code by being

approachable and easy to understand



## Development Plan



The roadmap to 1.0 looks more or less like the following:



* [x] `0.1.x` series: Proof of concept (along with [Thousand Island](https://github.com/mtrudel/thousand_island)) sufficient to support [HAP](https://github.com/mtrudel/hap)

* [x] `0.2.x` series: Revise process model to accommodate forthcoming HTTP/2 and WebSocket adapters

* [ ] `0.3.x` series: Implement HTTP/2 adapter

* [ ] `0.4.x` series: Re-implement HTTP/1.x adapter

* [ ] `0.5.x` series: Implement WebSocket extension

* [ ] `0.6.x` series: Enhance startup options, complete & revise documentation & tests

* [ ] `0.7.x` series: Integrate with Phoenix



## Installation



Bandit is [available in Hex](https://hex.pm/docs/publish). The package can be installed

by adding `bandit` to your list of dependencies in `mix.exs`:



```elixir

def deps do

  [

    {:bandit, "~> 0.3.0"}

  ]

end

```



Documentation can be found at [https://hexdocs.pm/bandit](https://hexdocs.pm/bandit).



# License



MIT