← 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

  • Committer: Martin Pool
  • Date: 2010-01-29 10:36:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4992.
  • Revision ID: mbp@sourcefrog.net-20100129103623-hywka5hymo5z13jw
Change url to canonical.com or wiki, plus some doc improvements in passing

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/server.txt
1
 
=======================
2
 
Running a Bazaar Server
3
 
=======================
 
1
Running a smart server
 
2
======================
4
3
 
5
4
Bazaar does not require a specialised server because it operates over HTTP, FTP
6
5
or SFTP.  There is an optional smart server that can be invoked over SSH, from
7
6
inetd, or in a dedicated mode.
8
7
 
9
8
Dumb servers
10
 
============
 
9
------------
11
10
 
12
11
We describe HTTP, FTP, SFTP and HTTP-WebDAV as "dumb" servers because they do
13
12
not offer any assistance to Bazaar.  If you make a Bazaar repository available
16
15
 
17
16
    bzr log http://bazaar-vcs.org/bzr/bzr.dev
18
17
 
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.
 
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.
30
27
 
31
28
To maintain the highest security possible, the current
32
 
high-performance server provides read-only access by default.  To
 
29
smart server provides read-only access by default.  To
33
30
enable read-write access, run it with ``--allow-writes``. When using
34
 
the SSH access method, bzr automatically runs with with the
 
31
the SSH access method, bzr automatically runs with the
35
32
``--allow-writes`` option.
36
33
 
37
 
The server can be configured to run in three different ways:
 
34
The alternative ways of configuring a smart server are explained below.
38
35
 
39
36
SSH
40
 
---
41
 
 
42
 
Using Bazaar over SSH requires no special configuration on the server::
 
37
~~~
 
38
 
 
39
Using Bazaar over SSH requires no special configuration on the server; so long
 
40
as Bazaar is installed on the server you can use ``bzr+ssh`` URLs, e.g.::
 
41
 
 
42
    bzr log bzr+ssh://host/path/to/branch
 
43
 
 
44
If `bzr` is not installed system-wide on the server you may need to explicitly
 
45
tell the local `bzr` where to find the remote `bzr`::
43
46
 
44
47
    BZR_REMOTE_PATH=~/bin/bzr bzr log bzr+ssh://host/path/to/branch
45
48
 
46
49
The ``BZR_REMOTE_PATH`` environment variable adjusts how `bzr` will be
47
50
invoked on the remote system.  By default, just `bzr` will be invoked,
48
 
which requires the `bzr` executable to be on the default search path.
 
51
which requires the `bzr` executable to be on the default search path.  You can
 
52
also set this permanently per-location in ``locations.conf``.
49
53
 
50
 
The ``bzr+ssh://`` URL scheme only supports absolute paths from the
51
 
root of the filesystem.  Future versions are expected to support ``~``
52
 
in the same way as ``sftp://`` URLs.
 
54
Like SFTP, paths starting with ``~`` are relative to your home directory, e.g.
 
55
``bzr+ssh://example.com/~/code/proj``.  Additionally, paths starting with
 
56
``~user`` will be relative to that user's home directory.
53
57
 
54
58
inetd
55
 
-----
 
59
~~~~~
56
60
 
57
61
This example shows how to run `bzr` with a dedicated user `bzruser`
58
62
for a shared repository in ``/srv/bzr/repo`` which has a branch at
60
64
 
61
65
Running a Bazaar server from inetd requires an inetd.conf entry::
62
66
 
63
 
    1234  stream  tcp  nowait  bzruser  /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
 
67
    4155  stream  tcp  nowait  bzruser  /usr/bin/bzr /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
64
68
 
65
69
When running client commands, the URL you supply is a `bzr://` URL relative to
66
70
the ``--directory`` option given in inetd.conf::
67
71
 
68
 
    bzr log bzr://host:1234/branchname
 
72
    bzr log bzr://host/branchname
 
73
 
 
74
If possible, paths starting with ``~`` and ``~user`` will be expanded as for
 
75
``bzr+ssh``.  Home directories outside the ``--directory`` specified to ``bzr
 
76
serve`` will not be accessible.
69
77
 
70
78
Dedicated
71
 
---------
 
79
~~~~~~~~~
72
80
 
73
81
This mode has the same path and URL behaviour as the inetd mode.  To
74
82
run as a specific user, you should use ``su`` or login as that user.
 
83
 
 
84
This example runs bzr on its official port number of `4155` and listens on all
 
85
interfaces. This allows connections from anywhere in the world that can reach
 
86
your machine on port `4155`.
 
87
 
 
88
server::
 
89
 
 
90
    bzr serve --directory=/srv/bzr/repo
 
91
 
 
92
client::
 
93
 
 
94
    bzr log bzr://host/branchname
 
95
 
75
96
This example runs ``bzr serve`` on `localhost` port `1234`.
76
97
 
77
98
server::
78
99
 
79
100
    bzr serve --port=localhost:1234 --directory=/srv/bzr/repo
80
 
    
 
101
 
81
102
client::
82
103
 
83
 
    bzr log bzr://host:1234/branchname
 
104
    bzr log bzr://localhost:1234/branchname
84
105