1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>S-HTTP-SERVER</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta name="description" content="S-HTTP-SERVER is minimal standalone Common Lisp HTTP Server" />
<meta name="keywords" content="http, server, httpd, common lisp, lisp" />
<meta name="author" content="Sven Van Caekenberghe" />
<meta name="Copyright" content="Copyright (c) 2005,2006 Sven Van Caekenberghe, Beta Nine BVBA" />
<style type="text/css">
body {
background: white;
width: 900px;
font-family: Verdana, Arial, Helvetica, sans-serif;
font-size: 13px;
}
p {
width: 600px;
padding: 0 20px 10px 50px;
}
ul {
width: 600px;
padding: 0 5px 5px 70px;
}
.author {
padding: 0 20px 5px 50px;
font-style: italic;
}
.figure {
margin-top: 0;
margin-bottom: 0;
background: black;
color: white;
text-align: center;
padding: 20px 0 10px 0;
}
.listing {
background: #eee;
font-size: 12px;
padding-left: 10px;
}
.caption {
margin-top: 5px;
text-align: center;
font-size: 10px;
font-style: bold;
}
.footer {
font-size: 10px;
font-style: italic;
}
</style>
</head>
<body>
<h3>Open Source Common Lisp Software</h3>
<h1>S-HTTP-SERVER</h1>
<h2>A Minimal Standalone Common Lisp HTTP Server</h2>
<p>
<a href="http://homepage.mac.com/svc/temaplte/index.html">S-HTTP-SERVER</a>
is a minimal standalone HTTP Server.
This simple package is used as a building block in a number of other open source projects,
as can be seen from this description of some
<a href="http://homepage.mac.com/svc/oscl.html">other Open Source Common Lisp packages</a>.
</p>
<h3>Contents</h3>
<ul>
<li><a href="#features">Features</a></li>
<li><a href="#status">Status</a></li>
<li><a href="#news">News</a></li>
<li><a href="#platforms">Platforms</a></li>
<li><a href="#downloading">Downloading</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#api">API Reference</a></li>
<li><a href="#mailinglist">Mailinglist</a></li>
<li><a href="#changelog">Changelog</a></li>
<li><a href="#tod">TODO</a></li>
<li><a href="#faq">FAQ</a></li>
<li><a href="#bugs">Bugs</a></li>
<li><a href="#authors">Authors</a></li>
<li><a href="#maintainers">Maintainers</a></li>
<li><a href="#license">License</a></li>
<li><a href="#history">History</a></li>
<li><a href="#references">References</a></li>
</ul>
<h3 id="features">Features</h3>
<p>
S-HTTP-SERVER can:
</p>
<ul>
<li>handle HTTP requests and generate HTTP responses</li>
<li>be configured with plugins or handlers</li>
<li>has a builtin status handler</li>
<li>comes with a static resource handler, favicon handler and redirect handler</li>
<li>allows you to write and install your own handlers</li>
<li>support HTTPS on LispWorks</li>
</ul>
<h3 id="status">Status</h3>
<p>
S-HTTP-SERVER is considered stable code.
</p>
<h3 id="news">News</h3>
<ul>
<li><em>April 2006</em> - added HTTPS support, serveral handlers and optimalizations.</li>
<li><em>December 2005</em> - S-HTTP-SERVER was featured in my first
<a href="http://homepage.mac.com/svc/LispMovies/index.html">Lisp Movie: Episode 1: HTTP Client and Server</a>.
Jean-Franois Brouillet has written an excellent
<a href="http://lisp.jfb-city.co.uk/tutorials/svc/s-http-server.html">tutorial on using S-HTTP-SERVER</a>,
complete with screenshots and code examples.</li>
<li><em>November 2005</em> - Created as a new project.</li>
</ul>
<h3 id="platforms">Platforms</h3>
<p>
S-HTTP-SERVER is written in ANSI standard Common Lisp and should be portable across any CL implementation.
</p>
<h3 id="downloading">Downloading</h3>
<p>
You can download the latested released tarball of the S-HTTP-SERVER package from
<a href="http://homepage.mac.com/svc/s-http-server/s-http-server.tar.gz">http://homepage.mac.com/svc/s-http-server/s-http-server.tar.gz</a>.
This archive is signed on release by <a href="http://homepage.mac.com/svc">Sven Van Caekenberghe</a>,
whose public key is published at
<a href="http://homepage.mac.com/svc/sven-public-ascii.gpg">http://homepage.mac.com/svc/sven-public-ascii.gpg</a>,
the signature is in
<a href="http://homepage.mac.com/svc/s-http-server/s-http-server.tar.gz.asc">http://homepage.mac.com/svc/s-http-server/s-http-server.tar.gz.asc</a>.
</p>
<p>
Alternatively you can access the <a href="http://abridgegame.org/darcs/">DARCS</a> repository at
<a href="http://www.beta9.be/darcs/s-http-server">http://www.beta9.be/darcs/s-https-server</a>.
For a good description on how to use DARCS see
<a href="http://dirkgerrits.com/programming/erlisp/download/">http://dirkgerrits.com/programming/erlisp/download/</a>.
</p>
<div class="listing">
<pre>$ darcs get http://www.beta9.be/darcs/s-http-server</pre>
</div>
<div class="caption">Example of basic darcs usage, get everything once and keep up to date by pulling in changes</div>
<h3 id="installation">Installation</h3>
<p>
The S-HTTP-SERVER package is loaded using <a href="http://www.cliki.net/asdf">ASDF</a>.
There is an excellent <a href="http://constantly.at/lisp/asdf/">tutorial on ASDF</a> to get you started.
Alternatively you can use <a href="http://www.cliki.net/asdf-install">ASDF-INSTALL</a>.
There is an great <a href="http://weitz.de/asdf-install/">tutorial on ASDF-INSTALL</a> to get you on the way.
</p>
<div class="listing">
<pre>CL-USER 1 > (asdf:oos 'asdf:load-op :s-http-server)</pre>
</div>
<div class="caption">Example of setting up and using ASDF to compile and load the package</div>
<h3 id="usage">Usage</h3>
<p>
Basically, you create an S-HTTP-SERVER object and start it.
Out of the box only the status/debug page
<a href="http://localhost:1701/s-http-server">http://localhost:1701/s-http-server</a> 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.
</p>
<div class="listing">
<pre>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></pre>
</div>
<div class="caption">Example S-HTTP-SERVER Usage</div>
<p>
Jean-Franois Brouillet has written an excellent
<a href="http://lisp.jfb-city.co.uk/tutorials/svc/s-http-server.html">tutorial on using S-HTTP-SERVER</a>,
complete with screenshots and code examples.
</p>
<h3 id="api">API Reference</h3>
<p>
There is automatically generated <a href="API.html">API Reference</a> documentation available for the S-HTTP-SERVER package.
</p>
<h3 id="mailinglist">Mailinglist</h3>
<p>
The <a href="http://common-lisp.net/cgi-bin/mailman/listinfo/kpax-devel">KPAX mailing list</a> is used for this project.
</p>
<h3 id="changelog">Changelog</h3>
<p>
Release Notes:
</p>
<ul>
<li>release 1: moved S-HTTP-SERVER into a seperate project under a new structure</li>
</ul>
<h3 id="todo">TODO</h3>
<p>
There is currently no TODO list.
</p>
<h3 id="faq">FAQ</h3>
<p>
Nothing appropriate.
</p>
<h3 id="bugs">Bugs</h3>
<p>
There are no known bugs.
</p>
<h3 id="authors">Authors</h3>
<p>
S-HTTP-SERVER was written by <a href="http://homepage.mac.com/svc">Sven Van Caekenberghe</a>.
</p>
<h3 id="maintainers">Maintainers</h3>
<p>
S-HTTP-SERVER is being maintained by <a href="http://homepage.mac.com/svc">Sven Van Caekenberghe</a>.
</p>
<h3 id="license">License</h3>
<p>
You are granted the rights to distribute and use this software
as governed by the terms of the Lisp Lesser General Public License
(<a href="http://opensource.franz.com/preamble.html">http://opensource.franz.com/preamble.html</a>),
also known as the LLGPL.
</p>
<h3 id="history">History</h3>
<p>
This is a new project.
</p>
<h3 id="references">References</h3>
<p>
The reference for the HTTP protocol is <a href="http://www.w3.org/Protocols/rfc2616/rfc2616.html">RFC 2616</a>.
Worth reading is <a href="http://en.wikipedia.org/wiki/Http">the Wikipedia article about HTTP</a>.
</p>
<div class="footer">
Copyright © 2005, 2006 Sven Van Caekenberghe, Beta Nine BVBA. All Right Reserved. -
<a href="http://validator.w3.org/check/referer">This page is W3C Valid XHTML 1.0 Strict</a> -
<a href="http://www.anybrowser.org/campaign/">Viewable With Any Browser</a>
</div>
</body>
</html>
|
