~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-11-27 21:17:06 UTC
  • mto: (3054.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3055.
  • Revision ID: ian.clatworthy@internode.on.net-20071127211706-871zcqst0yi5tcvl
make fixes suggested by proof-readers

Show diffs side-by-side

added added

removed removed

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