~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/server.txt

  • Committer: Alexander Belchenko
  • Date: 2007-01-04 23:36:44 UTC
  • mfrom: (2224 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2225.
  • Revision ID: bialix@ukr.net-20070104233644-7znkxoj9b0y7ev28
merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
 
17
17
    bzr log http://bazaar-vcs.org/bzr/bzr.dev
18
18
 
19
 
Bazaar supports writing over FTP, SFTP and (via a plugin) over HTTP-WebDAV.
 
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
 
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:
 
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:
37
37
 
38
38
SSH
39
39
---
42
42
 
43
43
    BZR_REMOTE_PATH=~/bin/bzr bzr log bzr+ssh://host/path/to/branch
44
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.
 
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.
48
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).
 
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.
53
52
 
54
53
inetd
55
54
-----
56
55
 
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``.
 
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`
60
58
 
61
59
Running a Bazaar server from inetd requires an inetd.conf entry::
62
60
 
63
 
    4155  stream  tcp  nowait  bzruser  /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
 
61
    1234  stream  tcp  nowait  bzruser  /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
64
62
 
65
63
When running client commands, the URL you supply is a `bzr://` URL relative to
66
 
the ``--directory`` option given in inetd.conf::
 
64
the `--directory` option given in inetd.conf::
67
65
 
68
 
    bzr log bzr://host/branchname
 
66
    bzr log bzr://host:1234/branchname
69
67
 
70
68
Dedicated
71
69
---------
72
70
 
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`.
 
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`.
76
74
 
77
75
server::
78
76
 
82
80
 
83
81
    bzr log bzr://host:1234/branchname
84
82
 
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