A Common Lisp HTTP Server.
Common Lisp
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc
rsrc
src
README.md
s-http-server.asd

README.md

S-HTTP-SERVER

A Minimal Standalone Common Lisp HTTP Server

S-HTTP-SERVER is a minimal standalone HTTP Server. This simple package is used as a building block in a number of other open source projects.

Contents

Features

S-HTTP-SERVER can:

  • handle HTTP requests and generate HTTP responses
  • be configured with plugins or handlers
  • has a builtin status handler
  • comes with a static resource handler, favicon handler and redirect handler
  • allows you to write and install your own handlers
  • support HTTPS on LispWorks

Status

S-HTTP-SERVER is considered stable code.

News

Platforms

S-HTTP-SERVER is written in ANSI standard Common Lisp and should be portable across any CL implementation.

Installation

The S-HTTP-SERVER package is loaded using ASDF. There is an excellent tutorial on ASDF to get you started.

CL-USER 1 > (asdf:oos 'asdf:load-op :`S-HTTP-SERVER`)

Usage

Basically, you create an S-HTTP-SERVER object and start it. Out of the box only the status/debug page http://localhost:1701/s-http-server is served. By registering new context handlers you can configure the server further. The static-resource-handler hosts static documents from a root directory in the file system. It is possible to write your own handlers, look at the code of static-resource-handler and S-HTTP-SERVER-handler for guidance.

CL-USER 1 > (in-package :`S-HTTP-SERVER`)
#<The `S-HTTP-SERVER` package, 90/128 internal, 31/64 external>

`S-HTTP-SERVER` 2 > (defvar *server* (make-`S-HTTP-SERVER`))
*SERVER*

`S-HTTP-SERVER` 3 > (start-server *server*)
;; `S-HTTP-SERVER`: Started a new server on port 1701
#<`S-HTTP-SERVER` "`S-HTTP-SERVER`" port 1701 running 10C5F6EB>

`S-HTTP-SERVER` 4 > (register-context-handler *server* "/my-site" 'static-resource-handler :arguments '("/var/www/"))
((STATIC-RESOURCE-HANDLER "/my-site" "/var/www/") (`S-HTTP-SERVER`-HANDLER "/`S-HTTP-SERVER`" :BUILTIN))

`S-HTTP-SERVER` 5 > (stop-server *server*)
;; `S-HTTP-SERVER`: Stopped server
#<`S-HTTP-SERVER` "`S-HTTP-SERVER`" port 1701 not running 10C5F6EB>

Jean-François Brouillet has written an excellent tutorial on using S-HTTP-SERVER, complete with screenshots and code examples.

API Reference

There is automatically generated API Reference documentation available for the S-HTTP-SERVER package.

Mailinglist

The KPAX mailing list is used for this project.

Changelog

Release Notes:

  • release 1: moved S-HTTP-SERVER into a seperate project under a new structure

TODO

There is currently no TODO list.

FAQ

Nothing appropriate.

Bugs

There are no known bugs.

Authors

S-HTTP-SERVER was written by Sven Van Caekenberghe.

Maintainers

S-HTTP-SERVER is being maintained by Sven Van Caekenberghe.

License

You are granted the rights to distribute and use this software as governed by the terms of the Lisp Lesser General Public License (http://opensource.franz.com/preamble.html), also known as the LLGPL.

History

This is a new project.

References

The reference for the HTTP protocol is RFC 2616. Also worth reading is the Wikipedia article about HTTP.

Copyright © 2005, 2006 Sven Van Caekenberghe, Beta Nine BVBA. All Right Reserved.