/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

Use bzrlib rather than a bzr subprocess in test_bzr_connect_to_bzr_ssh.

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 **always** provides **read/write** access.
 
32
It is not suitable for publishing of read-only mirrors.
 
33
 
 
34
It can be configured to run in three different ways:
 
35
 
 
36
SSH
 
37
---
 
38
 
 
39
Using Bazaar over SSH requires no special configuration on the server::
 
40
 
 
41
    BZR_REMOTE_PATH=~/bin/bzr bzr log bzr+ssh://host/path/to/branch
 
42
 
 
43
The `BZR_REMOTE_PATH` environment variable adjusts how `bzr` will be invoked on
 
44
the remote system.  By default, just `bzr` will be invoked, which requires the
 
45
`bzr` executable to be on the default search path.
 
46
 
 
47
The `bzr+ssh://` URL scheme only supports absolute paths from the root of the
 
48
filesystem.  Future versions are expected to support `~` in the same way as
 
49
`sftp://` URLs.
 
50
 
 
51
Currently, this only works when Bazaar uses the `ssh` executable from OpenSSH or
 
52
SSH Corp.  This is the default if either of those is installed, unless
 
53
overridden by the `BZR_SSH` environment variable.
 
54
 
 
55
inetd
 
56
-----
 
57
 
 
58
This example shows how to run `bzr` with a dedicated user `bzruser` for a shared
 
59
repository in `/srv/bzr/repo` which has a branch at `/srv/bzr/repo/branchname`
 
60
 
 
61
Running a Bazaar server from inetd requires an inetd.conf entry::
 
62
 
 
63
    1234  stream  tcp  nowait  bzruser  /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
 
64
 
 
65
When running client commands, the URL you supply is a `bzr://` URL relative to
 
66
the `--directory` option given in inetd.conf::
 
67
 
 
68
    bzr log bzr://host:1234/branchname
 
69
 
 
70
Dedicated
 
71
---------
 
72
 
 
73
This mode has the same path and URL behaviour as the inetd mode.  To run as a
 
74
specific, you should use `su` or login as that user.  This example runs bzr
 
75
serve on `localhost` port `1234`.
 
76
 
 
77
server::
 
78
 
 
79
    bzr serve --port=localhost:1234 --directory=/srv/bzr/repo
 
80
    
 
81
client::
 
82
 
 
83
    bzr log bzr://host:1234/branchname
 
84