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 set up a Bazaar HTTP smart server,
9
using Apache 2.0 and FastCGI or mod_python.
11
For more information on the smart server, and other ways to configure it
12
see the main `smart server documentation`_.
14
.. _smart server documentation: server.htm
19
You have a webserver already publishing `/srv/example.com/www/code` as
20
`http://example.com/code/...` with plain HTTP. It contains bzr branches and
21
directories like `/srv/example.com/www/code/branch-one` and
22
`/srv/example.com/www/code/my-repo/branch-two`. You want to provide read-only
23
smart server access to these directories in addition to the existing HTTP
26
Configuring Apache 2.0
27
----------------------
32
First, configure mod_fastcgi, e.g. by adding lines like these to your
35
LoadModule fastcgi_module /usr/lib/apache2/modules/mod_fastcgi.so
36
FastCgiIpcDir /var/lib/apache2/fastcgi
38
In our example, we're already serving `/srv/example.com/www/code` at
39
`http://example.com/code`, so our existing Apache configuration would look
42
Alias /code /srv/example.com/www/code
43
<Directory /srv/example.com/www/code>
48
We need to change it to handle all requests for URLs ending in `.bzr/smart`. It
51
Alias /code /srv/example.com/www/code
52
<Directory /srv/example.com/www/code>
53
Options Indexes, FollowSymLinks
56
RewriteRule ^(.*/|)\.bzr/smart$ /srv/example.com/scripts/bzr-smart.fcgi
59
# bzr-smart.fcgi isn't under the DocumentRoot, so Alias it into the URL
60
# namespace so it can be executed.
61
Alias /srv/example.com/scripts/bzr-smart.fcgi /srv/example.com/scripts/bzr-smart.fcgi
62
<Directory /srv/example.com/scripts>
64
<Files bzr-smart.fcgi>
65
SetHandler fastcgi-script
69
This instructs Apache to hand requests for any URL ending with `/.bzr/smart`
70
inside `/code` to a Bazaar smart server via FastCGI.
72
Refer to the mod_rewrite_ and mod_fastcgi_ documentation for further
75
.. _mod_rewrite: http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html
76
.. _mod_fastcgi: http://www.fastcgi.com/mod_fastcgi/docs/mod_fastcgi.html
81
First, configure mod_python, e.g. by adding lines like these to your
84
LoadModule python_module /usr/lib/apache2/modules/mod_python.so
86
Define the rewrite rules with mod_rewrite the same way as for FastCGI, except
89
RewriteRule ^(.*/|)\.bzr/smart$ /srv/example.com/scripts/bzr-smart.fcgi
93
RewriteRule ^(.*/|)\.bzr/smart$ /srv/example.com/scripts/bzr-smart.py
95
Like with mod_fastcgi, we also define how our script is to be handled::
97
Alias /srv/example.com/scripts/bzr-smart.py /srv/example.com/scripts/bzr-smart.py
98
<Directory /srv/example.com/scripts>
100
PythonPath "sys.path+['/srv/example.com/scripts']"
101
AddHandler python-program .py
102
PythonHandler bzr-smart::handler
106
This instructs Apache to hand requests for any URL ending with `/.bzr/smart`
107
inside `/code` to a Bazaar smart server via mod_python.
109
Refer to the mod_python_ documentation for further information.
111
.. _mod_python: http://www.modpython.org/
120
We've configured Apache to run the smart server at
121
`/srv/example.com/scripts/bzr-smart.fcgi`. This is just a simple script we need
122
to write to configure a smart server, and glue it to the FastCGI gateway.
123
Here's what it looks like::
126
from bzrlib.transport.http import wsgi
128
smart_server_app = wsgi.make_app(
129
root='/srv/example.com/code',
131
path_var='REQUEST_URI',
134
fcgi.WSGIServer(smart_server_app).run()
136
The `fcgi` module can be found at http://svn.saddi.com/py-lib/trunk/fcgi.py. It
139
.. _flup: http://www.saddi.com/software/flup/
144
We've configured Apache to run the smart server at
145
`/srv/example.com/scripts/bzr-smart.py`. This is just a simple script we need
146
to write to configure a smart server, and glue it to the mod_python gateway.
147
Here's what it looks like::
150
from bzrlib.transport.http import wsgi
152
smart_server_app = wsgi.make_app(
153
root='/srv/example.com/code',
155
path_var='REQUEST_URI',
158
def handler(request):
159
"""Handle a single request."""
160
wsgi_server = modpywsgi.WSGIServer(smart_server_app)
161
return wsgi_server.run(request)
163
The `modpywsgi` module can be found at http://trac.pocoo.org/wiki/ModPyWsgi. It
166
.. _pocoo: http://trac.pocoo.org/wiki/
171
Now you can use `bzr+http://` URLs, e.g.::
173
bzr log bzr+http://example.com/code/my-branch
175
Plain HTTP access should continue to work::
177
bzr log http://example.com/code/my-branch
180
Advanced configuration
181
======================
183
Because the Bazaar HTTP smart server is a WSGI application, it can be used with
184
any 3rd-party WSGI middleware or server that conforms the WSGI standard. The
185
only requirements are:
187
* to construct a `SmartWSGIApp`, you need to specify a **root transport** that it
189
* each request's `environ` dict must have a **'bzrlib.relpath'** variable set.
191
The `make_app` helper used in the example constructs a `SmartWSGIApp` with a
192
transport based on the `root` path given to it, and calculates the
193
'bzrlib.relpath` for each request based on the `prefix` and `path_var`
194
arguments. In the example above, it will take the 'REQUEST_URI' (which is set
195
by Apache), strip the '/code/' prefix and the '/.bzr/smart' suffix, and set that
196
as the 'bzrlib.relpath', so that a request for '/code/foo/bar/.bzr/smart' will
197
result in a 'bzrlib.relpath' of 'foo/bzr'.
199
It's possible to configure a smart server for a non-local transport, or that
200
does arbitrary path translations, etc, by constructing a `SmartWSGIApp`
201
directly. Refer to the docstrings of `bzrlib.transport.http.wsgi` and the `WSGI
202
standard`_ for further information.
204
.. _WSGI standard: http://www.python.org/dev/peps/pep-0333/
207
Pushing over ``bzr+http://``
208
----------------------------
210
It is possible to allow pushing data over the http smart server. The
211
easiest way to do this, is to just supply ``readonly=False`` to the
212
``wsgi.make_app()`` call. But be careful, because the smart protocol does
213
not contain any Authentication. So if you enable write support, you will
214
want to restrict access to ``.bzr/smart`` URLs to restrict who can
215
actually write data on your system. At this time, it is not possible to
216
allow some people to have read-only access and others to have read-write
217
access to the same urls. Because at the HTTP layer (which is doing the
218
Authenticating), everything is just a POST request. However, it would
219
certainly be possible to have HTTPS require authentication and use a
220
writable server, and plain HTTP allow read-only access.
added
removed
doc/http_smart_server.txt
