/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/en/user-guide/server.txt

[merge] robertc's integration, updated tests to check for retcode=3

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/server.txt
1
 
Running a smart server
2
 
======================
3
 
 
4
 
Breezy does not require a specialised server because it operates over HTTP, FTP
5
 
or SFTP.  There is an optional smart server that can be invoked over SSH, from
6
 
inetd, or in a dedicated mode.
7
 
 
8
 
Dumb servers
9
 
------------
10
 
 
11
 
We describe HTTP, FTP, SFTP and HTTP-WebDAV as "dumb" servers because they do
12
 
not offer any assistance to Breezy.  If you make a Breezy repository available
13
 
over any of these protocols, Breezy will allow you to read it remotely.  Just
14
 
enter the URL to the branch in the Breezy command you are running.::
15
 
 
16
 
    brz log http://bazaar.launchpad.net/~brz-pqm/brz/brz.dev
17
 
 
18
 
Breezy supports writing over FTP, SFTP and (via a plugin) over HTTP-WebDAV.
19
 
 
20
 
High-performance smart server
21
 
-----------------------------
22
 
 
23
 
The high-performance smart server (hpss) performs certain operations much faster
24
 
than dumb servers are capable of.  In future releases, the range of operations
25
 
that are improved by using the smart server will increase as we continue to
26
 
tune performance.
27
 
 
28
 
To maintain the highest security possible, the current
29
 
smart server provides read-only access by default.  To
30
 
enable read-write access, run it with ``--allow-writes``. When using
31
 
the SSH access method, brz automatically runs with the
32
 
``--allow-writes`` option.
33
 
 
34
 
The alternative ways of configuring a smart server are explained below.
35
 
 
36
 
SSH
37
 
~~~
38
 
 
39
 
Using Breezy over SSH requires no special configuration on the server; so long
40
 
as Breezy is installed on the server you can use ``bzr+ssh`` URLs, e.g.::
41
 
 
42
 
    brz log bzr+ssh://host/path/to/branch
43
 
 
44
 
If `brz` is not installed system-wide on the server you may need to explicitly
45
 
tell the local `brz` where to find the remote `brz`::
46
 
 
47
 
    BZR_REMOTE_PATH=~/bin/brz brz log bzr+ssh://host/path/to/branch
48
 
 
49
 
The ``BZR_REMOTE_PATH`` environment variable adjusts how `brz` will be
50
 
invoked on the remote system.  By default, just `brz` will be invoked,
51
 
which requires the `brz` executable to be on the default search path.  You can
52
 
also set this permanently per-location in ``locations.conf``.
53
 
 
54
 
Like SFTP, paths starting with ``~`` are relative to your home directory, e.g.
55
 
``bzr+ssh://example.com/~/code/proj``.  Additionally, paths starting with
56
 
``~user`` will be relative to that user's home directory.
57
 
 
58
 
inetd
59
 
~~~~~
60
 
 
61
 
This example shows how to run `brz` with a dedicated user `brzuser`
62
 
for a shared repository in ``/srv/brz/repo`` which has a branch at
63
 
``/srv/brz/repo/branchname``.
64
 
 
65
 
Running a Breezy server from inetd requires an inetd.conf entry::
66
 
 
67
 
    4155  stream  TCP  nowait  brzuser  /usr/bin/brz /usr/bin/brz serve --inet --directory=/srv/brz/repo
68
 
 
69
 
When running client commands, the URL you supply is a `bzr://` URL relative to
70
 
the ``--directory`` option given in inetd.conf::
71
 
 
72
 
    brz log bzr://host/branchname
73
 
 
74
 
If possible, paths starting with ``~`` and ``~user`` will be expanded as for
75
 
``bzr+ssh``.  Home directories outside the ``--directory`` specified to ``brz
76
 
serve`` will not be accessible.
77
 
 
78
 
Dedicated
79
 
~~~~~~~~~
80
 
 
81
 
This mode has the same path and URL behaviour as the inetd mode.  To
82
 
run as a specific user, you should use ``su`` or login as that user.
83
 
 
84
 
This example runs brz on its official port number of `4155` and listens on all
85
 
interfaces. This allows connections from anywhere in the world that can reach
86
 
your machine on port `4155`.
87
 
 
88
 
server::
89
 
 
90
 
    brz serve --directory=/srv/brz/repo
91
 
 
92
 
client::
93
 
 
94
 
    brz log bzr://host/branchname
95
 
 
96
 
This example runs ``brz serve`` on `localhost` port `1234`.
97
 
 
98
 
server::
99
 
 
100
 
    brz serve --listen=localhost --port=1234 --directory=/srv/brz/repo
101
 
 
102
 
client::
103
 
 
104
 
    brz log bzr://localhost:1234/branchname
105