1
===========================
2
Serving Bazaar with FastCGI
3
===========================
5
**This feature is EXPERIMENTAL and is NOT SECURE. It will allow access to
6
arbitrary files on your server.**
8
This document describes one way to setup a Bazaar HTTP smart server, using
9
Apache 2.0 and FastCGI.
14
You have a webserver already publishing `/srv/example.com/www/code` as
15
`http://example.com/code/...` with plain HTTP. It contains bzr branches and
16
directories like `/srv/example.com/www/code/branch-one` and
17
`/srv/example.com/www/code/my-repo/branch-two`. You want to provide read-only
18
smart server access to these directories in addition to the existing HTTP
21
Configuring Apache 2.0
22
----------------------
24
First, configure mod_fastcgi, e.g. by adding lines like these to your
27
LoadModule fastcgi_module /usr/lib/apache2/modules/mod_fastcgi.so
28
FastCgiIpcDir /var/lib/apache2/fastcgi
30
In our example, we're already serving `/srv/example.com/www/code` at
31
`http://example.com/code`, so our existing Apache configuration would look
34
Alias /code /srv/example.com/www/code
35
<Directory /srv/example.com/www/code>
40
We need to change it to handle all requests for URLs ending in `.bzr/smart`. It
43
Alias /code /srv/example.com/www/code
44
<Directory /srv/example.com/www/code>
45
Options Indexes, FollowSymLinks
48
RewriteRule ^(.*)/\.bzr/smart$ /srv/example.com/scripts/bzr-smart.fcgi
51
# bzr-smart.fcgi isn't under the DocumentRoot, so Alias it into the URL
52
# namespace so it can be executed.
53
Alias /srv/example.com/scripts/bzr-smart.fcgi /srv/example.com/scripts/bzr-smart.fcgi
54
<Directory /srv/example.com/scripts>
56
<Files bzr-smart.fcgi>
57
SetHandler fastcgi-script
61
This instructs Apache to hand requests for any URL ending with `/.bzr/smart`
62
inside `/code` to a Bazaar smart server via FastCGI.
64
Refer to the mod_rewrite_ and mod_fastcgi_ documentation for further
67
.. _mod_rewrite: http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html
68
.. _mod_fastcgi: http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html
73
We've configured Apache to run the smart server at
74
`/srv/example.com/scripts/bzr-smart.fcgi`. This is just a simple script we need
75
to write to configure a smart server, and glue it to the FastCGI gateway.
76
Here's what it looks like::
79
from bzrlib.transport.http import wsgi
81
smart_server_app = wsgi.make_app(
82
root='/srv/example.com/code',
84
path_var='REQUEST_URI')
86
fcgi.WSGIServer(smart_server_app).run()
88
The `fcgi` module can be found at http://svn.saddi.com/py-lib/trunk/fcgi.py. It
91
.. _flup: http://www.saddi.com/software/flup/
96
Now you can use `bzr+http://` URLs, e.g.::
98
bzr log bzr+http://example.com/code/my-branch
100
Plain HTTP access should continue to work::
102
bzr log http://example.com/code/my-branch
105
Advanced configuration
106
======================
108
Because the Bazaar HTTP smart server is a WSGI application, it can be used with
109
any 3rd-party WSGI middleware or server that conforms the WSGI standard. The
110
only requirements are:
112
* to construct a `SmartWSGIApp`, you need to specify a **root transport** that it
114
* each request's `environ` dict must have a **'bzrlib.relpath'** variable set.
116
The `make_app` helper used in the example constructs a `SmartWSGIApp` with a
117
transport based on the `root` path given to it, and calculates the
118
'bzrlib.relpath` for each request based on the `prefix` and `path_var`
119
arguments. In the example above, it will take the 'REQUEST_URI' (which is set
120
by Apache), strip the '/code/' prefix and the '/.bzr/smart' suffix, and set that
121
as the 'bzrlib.relpath', so that a request for '/code/foo/bar/.bzr/smart' will
122
result in a 'bzrlib.relpath' of 'foo/bzr'.
124
It's possible to configure a smart server for a non-local transport, or that
125
does arbitrary path translations, etc, by constructing a `SmartWSGIApp`
126
directly. Refer to the docstrings of `bzrlib.transport.http.wsgi` and the `WSGI
127
standard`_ for further information.
129
.. _WSGI standard: http://www.python.org/dev/peps/pep-0333/
added
removed
doc/http_smart_server.txt
