← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/server.txt

[merge] bzr.dev 2255, resolve conflicts, update copyrights

Show diffs side-by-side

added added

removed removed

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