examples: setsid is now built into htparser.
[ashd.git] / python / doc / ashd-wsgi.doc
CommitLineData
338bee9d
FT
1ashd-wsgi(1)
2============
3
4NAME
5----
6ashd-wsgi - WSGI adapter for ashd(7)
7
8SYNOPSIS
9--------
d5ee5cde 10*ashd-wsgi* [*-hA*] [*-m* 'PDM-SPEC'] [*-p* 'MODPATH'] [*-l* 'LIMIT'] 'HANDLER-MODULE' ['ARGS'...]
338bee9d
FT
11
12DESCRIPTION
13-----------
14
15The *ashd-wsgi* handler translates *ashd*(7) requests to WSGI
16requests, and passes them to a specified Python handler module. The
17precise Python convention for doing so is described in the PROTOCOL
18section, below.
19
20*ashd-wsgi* is a persistent handler, as defined in *ashd*(7). It uses
21multithreaded dispatching in a single Python interpreter, which means
22that WSGI applications that use it need to be thread-safe, but that
23they can also share all Python data structures and global variables
24between requests.
25
26The Python module that *ashd-wsgi* comes with also contains a standard
27handler module, `ashd.wsgidir`, which serves individual WSGI
28applications directly from the files in which they reside and as such
29makes this program useful as a *dirplex*(1) handler. Please see its
30Python documentation for further details.
31
32*ashd-wsgi* requires the `ashd.proto` and `ashd.util` modules, which
33are only available for CPython. If you want to use some other Python
34implementation instead, you may want to use the *scgi-wsgi*(1) program
35instead, along with *callscgi*(1).
36
37OPTIONS
38-------
39
40*-h*::
41
42 Print a brief help message to standard output and exit.
43
44*-A*::
45
46 Use the convention used by Apache's mod_wsgi module to find
47 the WSGI application object. See the PROTOCOL section, below,
48 for details.
49
50*-p* 'MODPATH'::
51
52 Prepend 'MODPATH' to Python's `sys.path`; can be given multiple
53 times. Note that the working directory of *ashd-wsgi* is not
54 on Python's module path by default, so if you want to use a
55 module in that directory, you will need to specify "`-p .`".
56
3e11d7ed
FT
57*-l* 'LIMIT'::
58
59 Allow at most 'LIMIT' requests to run concurrently. If a new
60 request is made when 'LIMIT' requests are executing, the new
61 request will wait up to ten seconds for one of them to
3da05ba7 62 complete; if none does, *ashd-wsgi* will assume that the
3e11d7ed
FT
63 process is foobar and *abort*(3).
64
d5ee5cde
FT
65*-m* 'PDM-SPEC'::
66
67 If the PDM library is installed on the system, create a
68 listening socket for connection PDM clients according to
69 'PDM-SPEC'.
70
338bee9d
FT
71PROTOCOL
72--------
73
74When starting, *ashd-wsgi* will attempt to import the module named by
75'HANDLER-MODULE', look for an object named `wmain` in that module,
76call that object passing the 'ARGS' (as Python strings) as positional
77parameters, and use the returned object as the WSGI application
78object. If the *-A* option was specified, it will look for an object
79named `application` instead of `wmain`, and use that object directly
80as the WSGI application object.
81
82When calling the WSGI application, a new thread is started for each
83request, in which the WSGI application object is called. All requests
84run in the same interpreter, so it is guaranteed that data structures
85and global variables can be shared between requests.
86
87The WSGI environment is the standard CGI environment, including the
88`SCRIPT_FILENAME` variable whenever the `X-Ash-File` header was
89included in the request.
90
91EXAMPLES
92--------
93
94The following *dirplex*(1) configuration can be used for serving WSGI
95modules directly from the filesystem.
96
97--------
98child wsgidir
99 exec ashd-wsgi ashd.wsgidir
100match
101 filename *.wsgi
102 handler wsgidir
103--------
104
105Since *ashd-wsgi* is a persistent handler, it can be used directly as
106a root handler for *htparser*(1). For instance, if the directory
107`/srv/www/foo` contains a `wsgi.py` file, which declares a standard
108WSGI `application` object, it can be served with the following
109command:
110
111--------
112htparser plain:port=8080 -- ashd-wsgi -Ap /srv/www/foo wsgi
113--------
114
115AUTHOR
116------
117Fredrik Tolf <fredrik@dolda2000.com>
118
119SEE ALSO
120--------
121*scgi-wsgi*(1), *ashd*(7), <http://wsgi.org/>