← 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: Robert Collins
  • Date: 2005-10-03 01:15:02 UTC
  • mfrom: (1092.2.28)
  • Revision ID: robertc@robertcollins.net-20051003011502-f579a509a136b774
merge from baz2bzr

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/server.txt
1
 
Running a smart 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 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 with the
32
 
``--allow-writes`` option.
33
 
 
34
 
The alternative ways of configuring a smart server are explained below.
35
 
 
36
 
SSH
37
 
~~~
38
 
 
39
 
Using Bazaar over SSH requires no special configuration on the server::
40
 
 
41
 
    BZR_REMOTE_PATH=~/bin/bzr bzr log bzr+ssh://host/path/to/branch
42
 
 
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.
46
 
 
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).
51
 
 
52
 
inetd
53
 
~~~~~
54
 
 
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``.
58
 
 
59
 
Running a Bazaar server from inetd requires an inetd.conf entry::
60
 
 
61
 
    4155  stream  tcp  nowait  bzruser  /usr/bin/bzr /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
62
 
 
63
 
When running client commands, the URL you supply is a `bzr://` URL relative to
64
 
the ``--directory`` option given in inetd.conf::
65
 
 
66
 
    bzr log bzr://host/branchname
67
 
 
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`.
87
 
 
88
 
server::
89
 
 
90
 
    bzr serve --port=localhost:1234 --directory=/srv/bzr/repo
91
 
    
92
 
client::
93
 
 
94
 
    bzr log bzr://localhost:1234/branchname
95