]> code.delx.au - gnu-emacs-elpa/blob - README
supports web sockets
[gnu-emacs-elpa] / README
1 Emacs Web Server
2
3 DESCRIPTION
4 A web server in Emacs running handlers written in Emacs Lisp.
5
6 REQUIREMENTS
7 Emacs 24.3 or later.
8
9 STATUS
10 Supports HTTP GET and POST requests including URL-encoded
11 parameters, multipart/form data and file uploads. Supports web
12 sockets. Reasonably performant, faster than Elnode [1]. This is
13 a new project without much extended use so there are likely bugs
14 and potentially security issues. That said it consists of little
15 more than HTTP header parsing logic perched atop Emacs' existing
16 network process primitives, so it should be fairly robust.
17
18 [1] http://eschulte.github.io/emacs-web-server/benchmark/
19
20 EXAMPLES
21 See the examples/ directory in this repository. The Emacs Web
22 Server is also used to run a paste server [2] and serve editable
23 Org-mode pages [3].
24
25 [2] https://github.com/eschulte/el-sprunge
26 [3] https://github.com/eschulte/org-ehtml
27
28 DOCUMENTATION
29 Run `make doc' to build the texinfo documentation, also available
30 online [4].
31
32 [4] http://eschulte.github.io/emacs-web-server