← 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: Ian Clatworthy
  • Date: 2007-08-10 05:17:09 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070810051709-0rnxlur94samh192
move most existing topics into the User Guide dir for English

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