← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

move reference material out of User Guide into User Reference

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/server.txt
 
1
Running a Bazaar server
 
2
=======================
 
3
 
 
4
Bazaar does not require a specialised server because it operates over HTTP, FTP
 
5
or SFTP.  There is an optional smart server that can be invoked over SSH, from
 
6
inetd, or in a dedicated mode.
 
7
 
 
8
Dumb servers
 
9
------------
 
10
 
 
11
We describe HTTP, FTP, SFTP and HTTP-WebDAV as "dumb" servers because they do
 
12
not offer any assistance to Bazaar.  If you make a Bazaar repository available
 
13
over any of these protocols, Bazaar will allow you to read it remotely.  Just
 
14
enter the URL to the branch in the Bazaar command you are running.::
 
15
 
 
16
    bzr log http://bazaar-vcs.org/bzr/bzr.dev
 
17
 
 
18
Bazaar supports writing over FTP, SFTP and (via a plugin) over HTTP-WebDAV.
 
19
 
 
20
High-performance server
 
21
-----------------------
 
22
 
 
23
The high-performance server is currently in development.  It provides a dumb
 
24
server facility as well as additional capabilities which allow the version of
 
25
bzr that accompanies this documentation to perform some operations much faster
 
26
than via dumb servers.  In future releases of bzr the range of operations that
 
27
are improved by using the high-performance server will increase.
 
28
 
 
29
To maintain the highest security possible, the current
 
30
high-performance server provides read-only access by default.  To
 
31
enable read-write access, run it with ``--allow-writes``. When using
 
32
the SSH access method, bzr automatically runs with with the
 
33
``--allow-writes`` option.
 
34
 
 
35
The server can be configured to run in three different ways:
 
36
 
 
37
SSH
 
38
~~~
 
39
 
 
40
Using Bazaar over SSH requires no special configuration on the server::
 
41
 
 
42
    BZR_REMOTE_PATH=~/bin/bzr bzr log bzr+ssh://host/path/to/branch
 
43
 
 
44
The ``BZR_REMOTE_PATH`` environment variable adjusts how `bzr` will be
 
45
invoked on the remote system.  By default, just `bzr` will be invoked,
 
46
which requires the `bzr` executable to be on the default search path.
 
47
 
 
48
The ``bzr+ssh://`` URL scheme only supports absolute paths from the
 
49
root of the filesystem.  Future versions are expected to support ``~``
 
50
in the same way as ``sftp://`` URLs
 
51
(https://bugs.launchpad.net/bzr/+bug/109143).
 
52
 
 
53
inetd
 
54
~~~~~
 
55
 
 
56
This example shows how to run `bzr` with a dedicated user `bzruser`
 
57
for a shared repository in ``/srv/bzr/repo`` which has a branch at
 
58
``/srv/bzr/repo/branchname``.
 
59
 
 
60
Running a Bazaar server from inetd requires an inetd.conf entry::
 
61
 
 
62
    4155  stream  tcp  nowait  bzruser  /usr/bin/bzr /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
 
63
 
 
64
When running client commands, the URL you supply is a `bzr://` URL relative to
 
65
the ``--directory`` option given in inetd.conf::
 
66
 
 
67
    bzr log bzr://host/branchname
 
68
 
 
69
Dedicated
 
70
~~~~~~~~~
 
71
 
 
72
This mode has the same path and URL behaviour as the inetd mode.  To
 
73
run as a specific user, you should use ``su`` or login as that user.
 
74
 
 
75
This example runs bzr on its official port number of `4155` and listens on all
 
76
interfaces. This allows connections from anywhere in the world that can reach
 
77
your machine on port `4155`.
 
78
 
 
79
server::
 
80
 
 
81
    bzr serve --directory=/srv/bzr/repo
 
82
 
 
83
client::
 
84
 
 
85
    bzr log bzr://host/branchname
 
86
 
 
87
This example runs ``bzr serve`` on `localhost` port `1234`.
 
88
 
 
89
server::
 
90
 
 
91
    bzr serve --port=localhost:1234 --directory=/srv/bzr/repo
 
92
    
 
93
client::
 
94
 
 
95
    bzr log bzr://localhost:1234/branchname
 
96