~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/server.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-03-02 21:00:06 UTC
  • mfrom: (2293.1.7 Aaron's integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070302210006-317f7fb7479da4c5
Documentation cleanup (Brad Crittenden)

Show diffs side-by-side

added added

removed removed

Lines of Context:
18
18
 
19
19
Bazaar supports writing over FTP, SFTP and via a plugin over HTTP-WebDAV.
20
20
 
21
 
High performance server
 
21
High-performance server
22
22
=======================
23
23
 
24
24
**In development**
25
25
 
26
 
The high performance server is currently in development.  The version of Bazaar
 
26
The high-performance server is currently in development.  The version of Bazaar
27
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
 
28
protocol as a dumb server.  This is the first stage high-performance server
29
29
functionality to be delivered.
30
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.
 
31
To maintain the highest security possible, the current
 
32
high-performance server provides read-only access by default.  To
 
33
enable read-write access, run it with ``--allow-writes``. When using
 
34
the SSH access method, bzr automatically runs with with the
 
35
``--allow-writes`` option.
35
36
 
36
 
It can be configured to run in three different ways:
 
37
The server can be configured to run in three different ways:
37
38
 
38
39
SSH
39
40
---
42
43
 
43
44
    BZR_REMOTE_PATH=~/bin/bzr bzr log bzr+ssh://host/path/to/branch
44
45
 
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.
 
46
The ``BZR_REMOTE_PATH`` environment variable adjusts how `bzr` will be
 
47
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.
48
49
 
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.
 
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.
52
53
 
53
54
inetd
54
55
-----
55
56
 
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`
 
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``.
58
60
 
59
61
Running a Bazaar server from inetd requires an inetd.conf entry::
60
62
 
61
63
    1234  stream  tcp  nowait  bzruser  /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
62
64
 
63
65
When running client commands, the URL you supply is a `bzr://` URL relative to
64
 
the `--directory` option given in inetd.conf::
 
66
the ``--directory`` option given in inetd.conf::
65
67
 
66
68
    bzr log bzr://host:1234/branchname
67
69
 
68
70
Dedicated
69
71
---------
70
72
 
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`.
 
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`.
74
76
 
75
77
server::
76
78