← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/server.txt

  • Committer: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

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.
 
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.
27
30
 
28
31
To maintain the highest security possible, the current
29
 
smart server provides read-only access by default.  To
 
32
high-performance server provides read-only access by default.  To
30
33
enable read-write access, run it with ``--allow-writes``. When using
31
 
the SSH access method, bzr automatically runs with the
 
34
the SSH access method, bzr automatically runs with with the
32
35
``--allow-writes`` option.
33
36
 
34
 
The alternative ways of configuring a smart server are explained below.
 
37
The server can be configured to run in three different ways:
35
38
 
36
39
SSH
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`::
 
40
---
 
41
 
 
42
Using Bazaar over SSH requires no special configuration on the server::
46
43
 
47
44
    BZR_REMOTE_PATH=~/bin/bzr bzr log bzr+ssh://host/path/to/branch
48
45
 
49
46
The ``BZR_REMOTE_PATH`` environment variable adjusts how `bzr` will be
50
47
invoked on the remote system.  By default, just `bzr` will be invoked,
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``.
 
48
which requires the `bzr` executable to be on the default search path.
53
49
 
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.
 
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.
57
53
 
58
54
inetd
59
 
~~~~~
 
55
-----
60
56
 
61
57
This example shows how to run `bzr` with a dedicated user `bzruser`
62
58
for a shared repository in ``/srv/bzr/repo`` which has a branch at
64
60
 
65
61
Running a Bazaar server from inetd requires an inetd.conf entry::
66
62
 
67
 
    4155  stream  tcp  nowait  bzruser  /usr/bin/bzr /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
 
63
    1234  stream  tcp  nowait  bzruser  /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
68
64
 
69
65
When running client commands, the URL you supply is a `bzr://` URL relative to
70
66
the ``--directory`` option given in inetd.conf::
71
67
 
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.
 
68
    bzr log bzr://host:1234/branchname
77
69
 
78
70
Dedicated
79
 
~~~~~~~~~
 
71
---------
80
72
 
81
73
This mode has the same path and URL behaviour as the inetd mode.  To
82
74
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
 
 
96
75
This example runs ``bzr serve`` on `localhost` port `1234`.
97
76
 
98
77
server::
99
78
 
100
79
    bzr serve --port=localhost:1234 --directory=/srv/bzr/repo
101
 
 
 
80
    
102
81
client::
103
82
 
104
 
    bzr log bzr://localhost:1234/branchname
 
83
    bzr log bzr://host:1234/branchname
105
84