/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/en/user-guide/http_smart_server.txt

  • Committer: Martin von Gagern
  • Date: 2010-04-20 08:47:38 UTC
  • mfrom: (5167 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5195.
  • Revision ID: martin.vgagern@gmx.net-20100420084738-ygymnqmdllzrhpfn
merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/http_smart_server.txt
1
 
Serving Bazaar with FastCGI
2
 
===========================
 
1
Serving Bazaar with Apache
 
2
==========================
3
3
 
4
4
This document describes one way to set up a Bazaar HTTP smart server,
5
 
using Apache 2.0 and FastCGI or mod_python.
 
5
using Apache 2.0 and FastCGI or mod_python or mod_wsgi.
6
6
 
7
7
For more information on the smart server, and other ways to configure it
8
8
see the main `smart server documentation`_.
30
30
 
31
31
    LoadModule fastcgi_module /usr/lib/apache2/modules/mod_fastcgi.so
32
32
    FastCgiIpcDir /var/lib/apache2/fastcgi
33
 
    
 
33
 
34
34
In our example, we're already serving `/srv/example.com/www/code` at
35
35
`http://example.com/code`, so our existing Apache configuration would look
36
36
like::
51
51
        RewriteBase /code
52
52
        RewriteRule ^(.*/|)\.bzr/smart$ /srv/example.com/scripts/bzr-smart.fcgi
53
53
    </Directory>
54
 
    
 
54
 
55
55
    # bzr-smart.fcgi isn't under the DocumentRoot, so Alias it into the URL
56
56
    # namespace so it can be executed.
57
57
    Alias /srv/example.com/scripts/bzr-smart.fcgi /srv/example.com/scripts/bzr-smart.fcgi
61
61
            SetHandler fastcgi-script
62
62
        </Files>
63
63
    </Directory>
64
 
    
 
64
 
65
65
This instructs Apache to hand requests for any URL ending with `/.bzr/smart`
66
66
inside `/code` to a Bazaar smart server via FastCGI.
67
67
 
117
117
.. _mod_python: http://www.modpython.org/
118
118
 
119
119
 
 
120
mod_wsgi
 
121
~~~~~~~~
 
122
 
 
123
First, configure mod_wsgi, e.g. enabling the mod with a2enmod wsgi.
 
124
We need to change it to handle all requests for URLs ending in `.bzr/smart`.  It
 
125
will look like::
 
126
 
 
127
    WSGIScriptAliasMatch ^/code/.*/\.bzr/smart$ /srv/example.com/scripts/bzr.wsgi
 
128
 
 
129
    #The three next lines allow regular GETs to work too
 
130
    RewriteEngine On
 
131
    RewriteCond %{REQUEST_URI} !^/code/.*/\.bzr/smart$
 
132
    RewriteRule ^/code/(.*/\.bzr/.*)$ /srv/example.com/www/code/$1 [L]
 
133
 
 
134
    <Directory /srv/example.com/www/code>
 
135
        WSGIApplicationGroup %{GLOBAL}
 
136
    </Directory>
 
137
 
 
138
This instructs Apache to hand requests for any URL ending with `/.bzr/smart`
 
139
inside `/code` to a Bazaar smart server via WSGI, and any other URL inside
 
140
`/code` to be served directly by Apache.
 
141
 
 
142
Refer to the mod_wsgi_ documentation for further information.
 
143
 
 
144
.. _mod_wsgi: http://code.google.com/p/modwsgi/
 
145
 
120
146
Configuring Bazaar
121
147
------------------
122
148
 
136
162
        prefix='/code/',
137
163
        path_var='REQUEST_URI',
138
164
        readonly=True,
139
 
        load_plugins=True, 
 
165
        load_plugins=True,
140
166
        enable_logging=True)
141
167
 
142
168
    fcgi.WSGIServer(smart_server_app).run()
143
 
        
 
169
 
144
170
The `fcgi` module can be found at http://svn.saddi.com/py-lib/trunk/fcgi.py.  It
145
171
is part of flup_.
146
172
 
162
188
        prefix='/code/',
163
189
        path_var='REQUEST_URI',
164
190
        readonly=True,
165
 
        load_plugins=True, 
 
191
        load_plugins=True,
166
192
        enable_logging=True)
167
193
 
168
194
    def handler(request):
169
195
        """Handle a single request."""
170
196
        wsgi_server = modpywsgi.WSGIServer(smart_server_app)
171
197
        return wsgi_server.run(request)
172
 
        
 
198
 
173
199
The `modpywsgi` module can be found at
174
 
http://dev.pocoo.org/projects/pocoo/browser/pocoo/wrappers/modpy.py. It is
 
200
http://ice.usq.edu.au/svn/ice/trunk/apps/ice-server/modpywsgi.py. It was
175
201
part of pocoo_. You sould make sure you place modpywsgi.py in the same
176
202
directory as bzr-smart.py (ie. /srv/example.com/scripts/).
177
203
 
178
204
.. _pocoo: http://dev.pocoo.org/projects/pocoo/
179
205
 
 
206
 
 
207
mod_wsgi
 
208
~~~~~~~~
 
209
 
 
210
We've configured Apache to run the smart server at
 
211
`/srv/example.com/scripts/bzr.wsgi`.  This is just a simple script we need
 
212
to write to configure a smart server, and glue it to the WSGI gateway.
 
213
Here's what it looks like::
 
214
 
 
215
    from bzrlib.transport.http import wsgi
 
216
 
 
217
    def application(environ, start_response):
 
218
        app = wsgi.make_app(
 
219
            root="/srv/example.com/www/code/",
 
220
            prefix="/code",
 
221
            readonly=True,
 
222
            enable_logging=False)
 
223
        return app(environ, start_response)
 
224
 
180
225
Clients
181
226
-------
182
227
 
183
 
Now you can use `bzr+http://` URLs, e.g.::
 
228
Now you can use `bzr+http://` URLs or just `http://` URLs, e.g.::
184
229
 
185
230
    bzr log bzr+http://example.com/code/my-branch
186
231
 
188
233
 
189
234
    bzr log http://example.com/code/my-branch
190
235
 
191
 
 
192
236
Advanced configuration
193
237
----------------------
194
238
 
216
260
.. _WSGI standard: http://www.python.org/dev/peps/pep-0333/
217
261
 
218
262
 
219
 
Pushing over ``bzr+http://``
220
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
263
Pushing over the http smart server
 
264
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221
265
 
222
266
It is possible to allow pushing data over the http smart server. The
223
267
easiest way to do this, is to just supply ``readonly=False`` to the
224
268
``wsgi.make_app()`` call. But be careful, because the smart protocol does
225
269
not contain any Authentication. So if you enable write support, you will
226
270
want to restrict access to ``.bzr/smart`` URLs to restrict who can
227
 
actually write data on your system.  At this time, it is not possible to
228
 
allow some people to have read-only access and others to have read-write
229
 
access to the same urls. Because at the HTTP layer (which is doing the
230
 
Authenticating), everything is just a POST request.  However, it would
231
 
certainly be possible to have HTTPS require authentication and use a
232
 
writable server, and plain HTTP allow read-only access.
233
 
 
234
 
 
235
 
.. 
 
271
actually write data on your system, e.g. in apache it looks like::
 
272
 
 
273
    <Location /code>
 
274
        AuthType Basic
 
275
        AuthName "example"
 
276
        AuthUserFile /srv/example.com/conf/auth.passwd
 
277
        <LimitExcept GET>
 
278
            Require valid-user
 
279
        </LimitExcept>
 
280
    </Location>
 
281
 
 
282
At this time, it is not possible to allow some people to have read-only
 
283
access and others to have read-write access to the same urls. Because at
 
284
the HTTP layer (which is doing the Authenticating), everything is just a
 
285
POST request.  However, it would certainly be possible to have HTTPS
 
286
require authentication and use a writable server, and plain HTTP allow
 
287
read-only access.
 
288
 
 
289
If bzr gives an error like this when accessing your HTTPS site::
 
290
 
 
291
  bzr: ERROR: Connection error: curl connection error (server certificate verification failed.
 
292
  CAfile:/etc/ssl/certs/ca-certificates.crt CRLfile: none)
 
293
 
 
294
You can workaround it by using ``https+urllib`` rather than ``http`` in your
 
295
URL, or by uninstalling pycurl.  See `bug 82086`_ for more details.
 
296
 
 
297
.. _bug 82086: https://bugs.launchpad.net/bzr/+bug/82086
 
298
 
 
299
..
236
300
   vim: ft=rst tw=74 et