code.delx.au - gnu-emacs-elpa/blob - packages/web-server/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 USAGE
  21     See the examples/ directory in this repository for examples
  22     demonstrating usage.  The Emacs web-server is also used to run a
  23     paste server [2], serve editable Org-mode pages [3] and serve
  24     files for Cask [4].
  25
  26     [2]  https://github.com/eschulte/el-sprunge
  27     [3]  https://github.com/eschulte/org-ehtml
  28     [4]  https://github.com/cask/cask
  29
  30     Available from the GNU ELPA [5].  The tutorials page [6] walks
  31     through usage scenarios including installing the Emacs web-server
  32     and running it behind a proxy.
  33
  34     [5]  http://elpa.gnu.org/
  35     [6]  http://eschulte.github.io/emacs-web-server/tutorials/
  36
  37     Run `make check' to run the included test suite.
  38
  39 DOCUMENTATION
  40     Run `make doc' to build the texinfo documentation, also available
  41     online [6].
  42
  43     [6]  http://eschulte.github.io/emacs-web-server