/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: Brad Crittenden
  • Date: 2007-02-27 22:14:14 UTC
  • mfrom: (2293.2.2 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 2311.
  • Revision ID: bac@canonical.com-20070227221414-du51ihnpkdu59geo
Merge from my LP branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/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
**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
 
32
default for security. To enable read-write access, run it with
 
33
``--allow-writes``. When using the SSH access method, bzr
 
34
automatically runs with with the ``--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 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
 
 
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.
 
52
 
 
53
inetd
 
54
-----
 
55
 
 
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``.
 
59
 
 
60
Running a Bazaar server from inetd requires an inetd.conf entry::
 
61
 
 
62
    1234  stream  tcp  nowait  bzruser  /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
 
63
 
 
64
When running client commands, the URL you supply is a `bzr://` URL relative to
 
65
the ``--directory`` option given in inetd.conf::
 
66
 
 
67
    bzr log bzr://host:1234/branchname
 
68
 
 
69
Dedicated
 
70
---------
 
71
 
 
72
This mode has the same path and URL behaviour as the inetd mode.  To run as a
 
73
specific user, you should use ``su`` or login as that user.  This example runs ``bzr
 
74
serve`` on `localhost` port `1234`.
 
75
 
 
76
server::
 
77
 
 
78
    bzr serve --port=localhost:1234 --directory=/srv/bzr/repo
 
79
    
 
80
client::
 
81
 
 
82
    bzr log bzr://host:1234/branchname
 
83