/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/server.txt

  • Committer: Robert Collins
  • Date: 2007-07-04 08:08:13 UTC
  • mfrom: (2572 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2587.
  • Revision ID: robertc@robertcollins.net-20070704080813-wzebx0r88fvwj5rq
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
 
**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:
 
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
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 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.
 
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
48
 
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.
 
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).
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
 
    1234  stream  tcp  nowait  bzruser  /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
 
63
    4155  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
 
    bzr log bzr://host:1234/branchname
 
68
    bzr log bzr://host/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
 
80
82
 
81
83
    bzr log bzr://host:1234/branchname
82
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