← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/admin-guide/introduction.txt

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/admin-guide/introduction.txt
 
1
Introduction
 
2
============
 
3
 
 
4
Welcome to the Bazaar Version Control System's guide for system
 
5
administrators.  Bazaar is a flexible system that provides many possible
 
6
options for serving projects in ways that will hopefully meet your needs.  If
 
7
you have requirements that are not met by the current state of the Bazaar
 
8
ecosystem, please let us know at bazaar@lists.canonical.com or on Launchpad at
 
9
https://launchpad.net/bzr.
 
10
 
 
11
Scope of this guide
 
12
-------------------
 
13
 
 
14
In this guide, we will discuss various techniques for making Bazaar projects
 
15
available, migrating from other Version Control Systems, browsing code over
 
16
the Web and combining Bazaar with other tools.  In many of these categories,
 
17
multiple options exist and we will try to explains the costs and benefits of
 
18
the various options.
 
19
 
 
20
The intended audience for this guide is the individuals who administer the
 
21
computers that will do the serving.  Much of the configuration that we will
 
22
discuss requires administrator privileges and we will not necessarily indicate
 
23
every point that those privileges are needed.  That said, reading this guide
 
24
can also be very helpful for those who are interested in communicating to the
 
25
system administrators about the requirements for making full use of Bazaar.
 
26
 
 
27
What you need to run a Bazaar server
 
28
------------------------------------
 
29
 
 
30
Where possible, we will discuss both Unix (including GNU/Linux) and Windows server
 
31
environments.  For the purposes of this document, we will consider Mac OS X as
 
32
a type of Unix.
 
33
 
 
34
In general, Bazaar requires only Python_ 2.4 or greater and the cElementTree_
 
35
package (included in Python 2.5 and later) to run.  If you would *optionally*
 
36
like to be able to access branches using SFTP, you need `paramiko and
 
37
pycrypto`_.
 
38
 
 
39
.. _Python: http://www.python.org/
 
40
.. _cElementTree: http://effbot.org/zone/element-index.htm
 
41
.. _paramiko and pycrypto: http://www.lag.net/paramiko/
 
42
 
 
43
For maximum performance, Bazaar can make use of compiled versions of some
 
44
critical components of the code.  Pure Python alternatives exist for all of
 
45
these components, but they may be considerably slower.  To compile these
 
46
extensions, you need a C compiler and the relevant header files from the
 
47
Python package.  On GNU/Linux, these may be in a separate package.  Other
 
48
operating systems should have the required headers installed by default.
 
49
 
 
50
If you are installing a development version of Bazaar, rather than a released
 
51
version, you will need Pyrex_ to create the C extensions.  The release
 
52
tarballs already have the Pyrex-created C files.
 
53
 
 
54
.. _Pyrex: http://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/
 
55